NetworkManager / Paginator / GetTransitGatewayConnectPeerAssociations

GetTransitGatewayConnectPeerAssociations#

class NetworkManager.Paginator.GetTransitGatewayConnectPeerAssociations#
paginator = client.get_paginator('get_transit_gateway_connect_peer_associations')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The ID of the global network.

  • TransitGatewayConnectPeerArns (list) –

    One or more transit gateway Connect peer Amazon Resource Names (ARNs).

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

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

}

Response Structure

  • (dict) –

    • TransitGatewayConnectPeerAssociations (list) –

      Information about the transit gateway Connect peer associations.

      • (dict) –

        Describes a transit gateway Connect peer association.

        • TransitGatewayConnectPeerArn (string) –

          The Amazon Resource Name (ARN) of the transit gateway Connect peer.

        • GlobalNetworkId (string) –

          The ID of the global network.

        • DeviceId (string) –

          The ID of the device.

        • LinkId (string) –

          The ID of the link.

        • State (string) –

          The state of the association.