odb / Client / list_odb_peering_connections

list_odb_peering_connections

odb.Client.list_odb_peering_connections(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

  • maxResults (integer) –

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

    Default: 20

    Constraints:

    • Must be between 1 and 100.

  • nextToken (string) – The pagination token for the next page of ODB peering connections.

  • odbNetworkId (string) –

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

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

Return type:

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',
            '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

        • createdAt (datetime) –

          The timestamp when the ODB peering connection was created.

        • percentProgress (float) –

          The percentage progress of the ODB peering connection creation or deletion.

Exceptions