odb / Paginator / ListOdbPeeringConnections

ListOdbPeeringConnections¶

class odb.Paginator.ListOdbPeeringConnections¶

paginator = client.get_paginator('list_odb_peering_connections')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from odb.Client.list_odb_peering_connections().

Request Syntax

response_iterator = paginator.paginate(
    odbNetworkId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

odbNetworkId (string) –
The identifier of the ODB network to list peering connections for.

If not specified, lists all ODB peering connections in the account.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    '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': ...
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- 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.
- NextToken (string) –
  
  A token to resume pagination.