AWS API Changes

2025/10/10 - odb - 1 new3 updated api methods

Changes This release adds APIs that allow you to specify CIDR ranges in your ODB peering connection.

UpdateOdbPeeringConnection (new)

Link ¶

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

Request Syntax

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.

CreateOdbPeeringConnection (updated)

Link ¶
Changes (request)

{'peerNetworkCidrsToBeAdded': ['string']}

Creates a peering connection between an ODB network and a VPC.

A peering connection enables private connectivity between the networks for application-tier communication.

See also: AWS API Documentation

Request Syntax

client.create_odb_peering_connection(
    odbNetworkId='string',
    peerNetworkId='string',
    displayName='string',
    peerNetworkCidrsToBeAdded=[
        'string',
    ],
    clientToken='string',
    tags={
        'string': 'string'
    }
)

type odbNetworkId:

string

param odbNetworkId:

[REQUIRED]

The unique identifier of the ODB network that initiates the peering connection.

type peerNetworkId:

string

param peerNetworkId:

[REQUIRED]

The unique identifier of the peer network. This can be either a VPC ID or another ODB network ID.

type displayName:

string

param displayName:

The display name for the ODB 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.

(string) --

type clientToken:

string

param clientToken:

The client token for the ODB peering connection request.

Constraints:

Must be unique for each request.

This field is autopopulated if not provided.

type tags:

dict

param tags:

The tags to assign to the ODB peering connection.

(string) --
- (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 ODB peering connection.
- status (string) --
  
  The status of the ODB peering connection.
  
  Valid Values: provisioning | active | terminating | terminated | failed
- statusReason (string) --
  
  The reason for the current status of the ODB peering connection.
- odbPeeringConnectionId (string) --
  
  The unique identifier of the ODB peering connection.

GetOdbPeeringConnection (updated)

Link ¶
Changes (response)

{'odbPeeringConnection': {'peerNetworkCidrs': ['string']}}

Retrieves information about an ODB peering connection.

See also: AWS API Documentation

Request Syntax

client.get_odb_peering_connection(
    odbPeeringConnectionId='string'
)

type odbPeeringConnectionId:

string

param odbPeeringConnectionId:

[REQUIRED]

The unique identifier of the ODB peering connection to retrieve information about.

rtype:

dict

returns:

Response Syntax

{
    'odbPeeringConnection': {
        'odbPeeringConnectionId': 'string',
        'displayName': 'string',
        'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
        'statusReason': 'string',
        'odbPeeringConnectionArn': 'string',
        'odbNetworkArn': 'string',
        'peerNetworkArn': 'string',
        'odbPeeringConnectionType': 'string',
        'peerNetworkCidrs': [
            'string',
        ],
        'createdAt': datetime(2015, 1, 1),
        'percentProgress': ...
    }
}

Response Structure

(dict) --
- odbPeeringConnection (dict) --
  
  A peering connection between an ODB network and either another ODB network or a customer-owned VPC.
  - odbPeeringConnectionId (string) --
    
    The unique identifier of the ODB peering connection. A sample ID is odbpcx-abcdefgh12345678.
  - displayName (string) --
    
    The display name of the ODB peering connection.
  - status (string) --
    
    The status of the ODB peering connection.
    
    Valid Values: provisioning | active | terminating | terminated | failed
  - statusReason (string) --
    
    The reason for the current status of the ODB peering connection.
  - odbPeeringConnectionArn (string) --
    
    The Amazon Resource Name (ARN) of the ODB peering connection.
    
    Example: arn:aws:odb:us-east-1:123456789012:odb-peering-connection/odbpcx-abcdefgh12345678
  - odbNetworkArn (string) --
    
    The Amazon Resource Name (ARN) of the ODB network that initiated the peering connection.
  - peerNetworkArn (string) --
    
    The Amazon Resource Name (ARN) of the peer network.
  - odbPeeringConnectionType (string) --
    
    The type of the ODB peering connection.
    
    Valid Values: ODB-VPC | ODB-ODB
  - peerNetworkCidrs (list) --
    
    The CIDR blocks associated with the peering connection. These CIDR blocks define the IP address ranges that can communicate through the peering connection.
    - (string) --
  - createdAt (datetime) --
    
    The timestamp when the ODB peering connection was created.
  - percentProgress (float) --
    
    The percentage progress of the ODB peering connection creation or deletion.

ListOdbPeeringConnections (updated)

Link ¶
Changes (response)

{'odbPeeringConnections': {'peerNetworkCidrs': ['string']}}

Lists all ODB peering connections or those associated with a specific ODB network.

See also: AWS API Documentation

Request Syntax

client.list_odb_peering_connections(
    maxResults=123,
    nextToken='string',
    odbNetworkId='string'
)

type maxResults:

integer

param maxResults:

The maximum number of ODB peering connections to return in the response.

Default: 20

Constraints:

Must be between 1 and 100.

type nextToken:

string

param nextToken:

The pagination token for the next page of ODB peering connections.

type odbNetworkId:

string

param odbNetworkId:

The identifier of the ODB network to list peering connections for.

If not specified, lists all ODB peering connections in the account.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'odbPeeringConnections': [
        {
            'odbPeeringConnectionId': 'string',
            'displayName': 'string',
            'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
            'statusReason': 'string',
            'odbPeeringConnectionArn': 'string',
            'odbNetworkArn': 'string',
            'peerNetworkArn': 'string',
            'odbPeeringConnectionType': 'string',
            'peerNetworkCidrs': [
                'string',
            ],
            'createdAt': datetime(2015, 1, 1),
            'percentProgress': ...
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  The pagination token for the next page of ODB peering connections.
- odbPeeringConnections (list) --
  
  The list of ODB peering connections.
  - (dict) --
    
    A summary of an ODB peering connection.
    - odbPeeringConnectionId (string) --
      
      The unique identifier of the ODB peering connection. A sample ID is odbpcx-abcdefgh12345678.
    - displayName (string) --
      
      The display name of the ODB peering connection.
    - status (string) --
      
      The status of the ODB peering connection.
      
      Valid Values: provisioning | active | terminating | terminated | failed
    - statusReason (string) --
      
      The reason for the current status of the ODB peering connection.
    - odbPeeringConnectionArn (string) --
      
      The Amazon Resource Name (ARN) of the ODB peering connection.
    - odbNetworkArn (string) --
      
      The Amazon Resource Name (ARN) of the ODB network that initiated the peering connection.
    - peerNetworkArn (string) --
      
      The Amazon Resource Name (ARN) of the peer network.
    - odbPeeringConnectionType (string) --
      
      The type of the ODB peering connection.
      
      Valid Values: ODB-VPC | ODB-ODB
    - peerNetworkCidrs (list) --
      
      The CIDR blocks associated with the peering connection. These CIDR blocks define the IP address ranges that can communicate through the peering connection.
      - (string) --
    - createdAt (datetime) --
      
      The timestamp when the ODB peering connection was created.
    - percentProgress (float) --
      
      The percentage progress of the ODB peering connection creation or deletion.