NetworkManager / Paginator / GetConnectPeerAssociations

GetConnectPeerAssociations

class NetworkManager.Paginator.GetConnectPeerAssociations

paginator = client.get_paginator('get_connect_peer_associations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.get_connect_peer_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GlobalNetworkId='string',
    ConnectPeerIds=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• GlobalNetworkId (string) –

  [REQUIRED]

  The ID of the global network.

• ConnectPeerIds (list) –

  The IDs of the Connect peers.

  • (string) –

• 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

{
    'ConnectPeerAssociations': [
        {
            'ConnectPeerId': 'string',
            'GlobalNetworkId': 'string',
            'DeviceId': 'string',
            'LinkId': 'string',
            'State': 'PENDING'|'AVAILABLE'|'DELETING'|'DELETED'
        },
    ],

}

Response Structure

• (dict) –

  • ConnectPeerAssociations (list) –

    Displays a list of Connect peer associations.

    • (dict) –

      Describes a core network Connect peer association.

      • ConnectPeerId (string) –

        The ID of the Connect peer.

      • GlobalNetworkId (string) –

        The ID of the global network.

      • DeviceId (string) –

        The ID of the device to connect to.

      • LinkId (string) –

        The ID of the link.

      • State (string) –

        The state of the Connect peer association.