NetworkManager / Paginator / GetCustomerGatewayAssociations

GetCustomerGatewayAssociations

class NetworkManager.Paginator.GetCustomerGatewayAssociations

paginator = client.get_paginator('get_customer_gateway_associations')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• GlobalNetworkId (string) –

  [REQUIRED]

  The ID of the global network.

• CustomerGatewayArns (list) –

  One or more customer gateway Amazon Resource Names (ARNs). The maximum is 10.

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

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

}

Response Structure

• (dict) –

  • CustomerGatewayAssociations (list) –

    The customer gateway associations.

    • (dict) –

      Describes the association between a customer gateway, a device, and a link.

      • CustomerGatewayArn (string) –

        The Amazon Resource Name (ARN) of the customer gateway.

      • 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 association state.