odb / Client / get_odb_peering_connection

get_odb_peering_connection

odb.Client.get_odb_peering_connection(**kwargs)

Retrieves information about an ODB peering connection.

See also: AWS API Documentation

Request Syntax

response = client.get_odb_peering_connection(
    odbPeeringConnectionId='string'
)
Parameters:

odbPeeringConnectionId (string) –

[REQUIRED]

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

Return type:

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

      • 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