NetworkManager / Client / disassociate_customer_gateway

disassociate_customer_gateway#

NetworkManager.Client.disassociate_customer_gateway(**kwargs)#

Disassociates a customer gateway from a device and a link.

Request Syntax

response = client.disassociate_customer_gateway(
    GlobalNetworkId='string',
    CustomerGatewayArn='string'
)

Parameters:

GlobalNetworkId (string) –
[REQUIRED]

The ID of the global network.
CustomerGatewayArn (string) –
[REQUIRED]

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

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) –
  
  Information about 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.AccessDeniedException
NetworkManager.Client.exceptions.ResourceNotFoundException
NetworkManager.Client.exceptions.ConflictException
NetworkManager.Client.exceptions.ThrottlingException
NetworkManager.Client.exceptions.InternalServerException