NetworkManager / Client / get_customer_gateway_associations

get_customer_gateway_associations#

NetworkManager.Client.get_customer_gateway_associations(**kwargs)#

Gets the association information for customer gateways that are associated with devices and links in your global network.

See also: AWS API Documentation

Request Syntax

response = client.get_customer_gateway_associations(
    GlobalNetworkId='string',
    CustomerGatewayArns=[
        'string',
    ],
    MaxResults=123,
    NextToken='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) –

  • 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

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

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.

    • NextToken (string) –

      The token for the next page of results.

Exceptions

  • NetworkManager.Client.exceptions.ValidationException

  • NetworkManager.Client.exceptions.AccessDeniedException

  • NetworkManager.Client.exceptions.ResourceNotFoundException

  • NetworkManager.Client.exceptions.ConflictException

  • NetworkManager.Client.exceptions.ThrottlingException

  • NetworkManager.Client.exceptions.InternalServerException