NetworkManager / Client / associate_customer_gateway

associate_customer_gateway#

NetworkManager.Client.associate_customer_gateway(**kwargs)#

Associates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device.

You can only associate customer gateways that are connected to a VPN attachment on a transit gateway or core network registered in your global network. When you register a transit gateway or core network, customer gateways that are connected to the transit gateway are automatically included in the global network. To list customer gateways that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and filter by transit-gateway-id.

You cannot associate a customer gateway with more than one device and link.

See also: AWS API Documentation

Request Syntax

response = client.associate_customer_gateway(
    CustomerGatewayArn='string',
    GlobalNetworkId='string',
    DeviceId='string',
    LinkId='string'
)
Parameters:

  • CustomerGatewayArn (string) –

    [REQUIRED]

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

  • GlobalNetworkId (string) –

    [REQUIRED]

    The ID of the global network.

  • DeviceId (string) –

    [REQUIRED]

    The ID of the device.

  • LinkId (string) – The ID of the link.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • CustomerGatewayAssociation (dict) –

      The customer gateway association.

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

Exceptions

  • NetworkManager.Client.exceptions.ValidationException

  • NetworkManager.Client.exceptions.ServiceQuotaExceededException

  • NetworkManager.Client.exceptions.AccessDeniedException

  • NetworkManager.Client.exceptions.ResourceNotFoundException

  • NetworkManager.Client.exceptions.ConflictException

  • NetworkManager.Client.exceptions.ThrottlingException

  • NetworkManager.Client.exceptions.InternalServerException