Skip to content

EC2  >  Operations  >  delete_client_vpn_endpoint

delete_client_vpn_endpoint

Operation

delete_client_vpn_endpoint async

delete_client_vpn_endpoint(input: DeleteClientVpnEndpointInput, plugins: list[Plugin] | None = None) -> DeleteClientVpnEndpointOutput

Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.

Parameters:

Name Type Description Default
input DeleteClientVpnEndpointInput

An instance of DeleteClientVpnEndpointInput.

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
DeleteClientVpnEndpointOutput

An instance of DeleteClientVpnEndpointOutput.

Input

DeleteClientVpnEndpointInput dataclass

Bases: _SerdeShape

Dataclass for DeleteClientVpnEndpointInput structure.

Attributes

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

The ID of the Client VPN to be deleted.

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

DeleteClientVpnEndpointOutput dataclass

Bases: _SerdeShape

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

status class-attribute instance-attribute
status: ClientVpnEndpointStatus | None = ...

The current state of the Client VPN endpoint.