NetworkManager / Client / list_connect_peers

list_connect_peers#

NetworkManager.Client.list_connect_peers(**kwargs)#

Returns a list of core network Connect peers.

See also: AWS API Documentation

Request Syntax

response = client.list_connect_peers(
    CoreNetworkId='string',
    ConnectAttachmentId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • CoreNetworkId (string) – The ID of a core network.

  • ConnectAttachmentId (string) – The ID of the attachment.

  • 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

{
    'ConnectPeers': [
        {
            'CoreNetworkId': 'string',
            'ConnectAttachmentId': 'string',
            'ConnectPeerId': 'string',
            'EdgeLocation': 'string',
            'ConnectPeerState': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
            'CreatedAt': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'SubnetArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ConnectPeers (list) –

      Describes the Connect peers.

      • (dict) –

        Summary description of a Connect peer.

        • CoreNetworkId (string) –

          The ID of a core network.

        • ConnectAttachmentId (string) –

          The ID of a Connect peer attachment.

        • ConnectPeerId (string) –

          The ID of a Connect peer.

        • EdgeLocation (string) –

          The Region where the edge is located.

        • ConnectPeerState (string) –

          The state of a Connect peer.

        • CreatedAt (datetime) –

          The timestamp when a Connect peer was created.

        • Tags (list) –

          The list of key-value tags associated with the Connect peer summary.

          • (dict) –

            Describes a tag.

            • Key (string) –

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value (string) –

              The tag value.

              Constraints: Maximum length of 256 characters.

        • SubnetArn (string) –

          The subnet ARN for the Connect peer summary.

    • NextToken (string) –

      The token for the next page of results.

Exceptions