:doc:`odb <../../odb>` / Client / update_odb_peering_connection

*****************************
update_odb_peering_connection
*****************************



.. py:method:: odb.Client.update_odb_peering_connection(**kwargs)

  

  Modifies the settings of an Oracle Database@Amazon Web Services peering connection. You can update the display name and add or remove CIDR blocks from the peering connection.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/odb-2024-08-20/UpdateOdbPeeringConnection>`_  


  **Request Syntax**
  ::

    response = client.update_odb_peering_connection(
        odbPeeringConnectionId='string',
        displayName='string',
        peerNetworkCidrsToBeAdded=[
            'string',
        ],
        peerNetworkCidrsToBeRemoved=[
            'string',
        ]
    )
    
  :type odbPeeringConnectionId: string
  :param odbPeeringConnectionId: **[REQUIRED]** 

    The identifier of the Oracle Database@Amazon Web Services peering connection to update.

    

  
  :type displayName: string
  :param displayName: 

    A new display name for the peering connection.

    

  
  :type peerNetworkCidrsToBeAdded: list
  :param peerNetworkCidrsToBeAdded: 

    A list of CIDR blocks to add to the peering connection. These CIDR blocks define the IP address ranges that can communicate through the peering connection. The CIDR blocks must not overlap with existing CIDR blocks in the Oracle Database@Amazon Web Services network.

    

  
    - *(string) --* 

    

  :type peerNetworkCidrsToBeRemoved: list
  :param peerNetworkCidrsToBeRemoved: 

    A list of CIDR blocks to remove from the peering connection. The CIDR blocks must currently exist in the peering connection.

    

  
    - *(string) --* 

    

  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'displayName': 'string',
          'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
          'statusReason': 'string',
          'odbPeeringConnectionId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **displayName** *(string) --* 

        The display name of the peering connection.

        
      

      - **status** *(string) --* 

        The status of the peering connection update operation.

        
      

      - **statusReason** *(string) --* 

        Additional information about the status of the peering connection update operation.

        
      

      - **odbPeeringConnectionId** *(string) --* 

        The identifier of the Oracle Database@Amazon Web Services peering connection that was updated.

        
  
  **Exceptions**
  
  *   :py:class:`odb.Client.exceptions.ThrottlingException`

  
  *   :py:class:`odb.Client.exceptions.ValidationException`

  
  *   :py:class:`odb.Client.exceptions.ConflictException`

  
  *   :py:class:`odb.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`odb.Client.exceptions.InternalServerException`

  
  *   :py:class:`odb.Client.exceptions.ResourceNotFoundException`

  