Skip to content

EC2  >  Operations  >  delete_customer_gateway

delete_customer_gateway

Operation

delete_customer_gateway async 

delete_customer_gateway(input: DeleteCustomerGatewayInput, plugins: list[Plugin] | None = None) -> DeleteCustomerGatewayOutput

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

Parameters:

Name Type Description Default
input DeleteCustomerGatewayInput

An instance of DeleteCustomerGatewayInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DeleteCustomerGatewayOutput

An instance of DeleteCustomerGatewayOutput.

Input

DeleteCustomerGatewayInput dataclass

Bases: _SerdeShape

Contains the parameters for DeleteCustomerGateway.

Attributes

customer_gateway_id class-attribute instance-attribute 
customer_gateway_id: str | None = ...

The ID of the customer gateway.

dry_run class-attribute instance-attribute 
dry_run: bool | None = ...

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.

Output

DeleteCustomerGatewayOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteCustomerGatewayOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.