NetworkManager / Client / get_connect_peer_associations

get_connect_peer_associations#

NetworkManager.Client.get_connect_peer_associations(**kwargs)#

Returns information about a core network Connect peer associations.

See also: AWS API Documentation

Request Syntax

response = client.get_connect_peer_associations(
    GlobalNetworkId='string',
    ConnectPeerIds=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • GlobalNetworkId (string) –

    [REQUIRED]

    The ID of the global network.

  • ConnectPeerIds (list) –

    The IDs of the Connect peers.

    • (string) –

  • MaxResults (integer) – The maximum number of results to return.

  • NextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

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

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.

    • NextToken (string) –

      The token for the next page of results.

Exceptions