Skip to content

EC2  >  Operations  >  detach_vpn_gateway

detach_vpn_gateway

Operation

detach_vpn_gateway async

detach_vpn_gateway(request: DetachVpnGatewayInput | DetachVpnGatewayInputDict, /, *, plugins: list[Plugin] | None = None) -> DetachVpnGatewayOutput
detach_vpn_gateway(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DetachVpnGatewayInputDict]) -> DetachVpnGatewayOutput

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

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
DetachVpnGatewayOutput

An instance of DetachVpnGatewayOutput.

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

DetachVpnGatewayInput dataclass

Bases: _SerdeShape

Contains the parameters for DetachVpnGateway.

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.

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

The ID of the VPC.

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

The ID of the virtual private gateway.

Dictionaries

DetachVpnGatewayInputDict

Bases: TypedDict

Dictionary form of DetachVpnGatewayInput.

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.

vpc_id instance-attribute
vpc_id: Required[str]

The ID of the VPC.

vpn_gateway_id instance-attribute
vpn_gateway_id: Required[str]

The ID of the virtual private gateway.

Output

DetachVpnGatewayOutput dataclass

Bases: _SerdeShape

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