Skip to content

EC2  >  Operations  >  delete_vpn_gateway

delete_vpn_gateway

Operation

delete_vpn_gateway async

delete_vpn_gateway(request: DeleteVpnGatewayInput | DeleteVpnGatewayInputDict, /, *, plugins: list[Plugin] | None = None) -> DeleteVpnGatewayOutput
delete_vpn_gateway(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteVpnGatewayInputDict]) -> DeleteVpnGatewayOutput

Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

Parameters:

Name Type Description Default
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
DeleteVpnGatewayOutput

An instance of DeleteVpnGatewayOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DeleteVpnGatewayInput dataclass

Bases: _SerdeShape

Contains the parameters for DeleteVpnGateway.

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

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

The ID of the virtual private gateway.

Dictionaries

DeleteVpnGatewayInputDict

Bases: TypedDict

Dictionary form of DeleteVpnGatewayInput.

Attributes
dry_run 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.

vpn_gateway_id instance-attribute
vpn_gateway_id: Required[str]

The ID of the virtual private gateway.

Output

DeleteVpnGatewayOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteVpnGatewayOutput 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.