Skip to content

EC2  >  Operations  >  disassociate_client_vpn_target_network

disassociate_client_vpn_target_network

Operation

disassociate_client_vpn_target_network async

disassociate_client_vpn_target_network(request: DisassociateClientVpnTargetNetworkInput | DisassociateClientVpnTargetNetworkInputDict, /, *, plugins: list[Plugin] | None = None) -> DisassociateClientVpnTargetNetworkOutput
disassociate_client_vpn_target_network(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DisassociateClientVpnTargetNetworkInputDict]) -> DisassociateClientVpnTargetNetworkOutput

Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:

  • The route that was automatically added for the VPC is deleted

  • All active client connections are terminated

  • New client connections are disallowed

  • The Client VPN endpoint's status changes to pending-associate

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
DisassociateClientVpnTargetNetworkOutput

An instance of DisassociateClientVpnTargetNetworkOutput.

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

DisassociateClientVpnTargetNetworkInput dataclass

Bases: _SerdeShape

Dataclass for DisassociateClientVpnTargetNetworkInput structure.

Attributes
association_id class-attribute instance-attribute
association_id: str | None = ...

The ID of the target network association.

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

The ID of the Client VPN endpoint from which to disassociate the target network.

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.

Dictionaries

DisassociateClientVpnTargetNetworkInputDict

Bases: TypedDict

Dictionary form of DisassociateClientVpnTargetNetworkInput.

Attributes
association_id instance-attribute
association_id: Required[str]

The ID of the target network association.

client_vpn_endpoint_id instance-attribute
client_vpn_endpoint_id: Required[str]

The ID of the Client VPN endpoint from which to disassociate the target network.

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.

Output

DisassociateClientVpnTargetNetworkOutput dataclass

Bases: _SerdeShape

Dataclass for DisassociateClientVpnTargetNetworkOutput structure.

Attributes

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

The ID of the target network association.

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: AssociationStatus | None = ...

The current state of the target network association.