EC2 / Client / delete_customer_gateway

delete_customer_gateway

EC2.Client.delete_customer_gateway(**kwargs)

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

See also: AWS API Documentation

Request Syntax

response = client.delete_customer_gateway(
    CustomerGatewayId='string',
    DryRun=True|False
)

Parameters:

• CustomerGatewayId (string) –

  [REQUIRED]

  The ID of the customer gateway.

• DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

Returns:

None

Examples

This example deletes the specified customer gateway.

response = client.delete_customer_gateway(
    CustomerGatewayId='cgw-0e11f167',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}