NetworkManager / Paginator / ListConnectPeers


class NetworkManager.Paginator.ListConnectPeers#
paginator = client.get_paginator('list_connect_peers')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • CoreNetworkId (string) – The ID of a core network.

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

  • 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:



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'


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.