Skip to content

terminate_client_vpn_connections

Operation

terminate_client_vpn_connections

terminate_client_vpn_connections(request: TerminateClientVpnConnectionsInput | TerminateClientVpnConnectionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[TerminateClientVpnConnectionsInputDict]) -> TerminateClientVpnConnectionsOutput

Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.

Parameters:

Name Type Description Default
request TerminateClientVpnConnectionsInput | TerminateClientVpnConnectionsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[TerminateClientVpnConnectionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
TerminateClientVpnConnectionsOutput

An instance of TerminateClientVpnConnectionsOutput.

terminate_client_vpn_connections async

terminate_client_vpn_connections(request: TerminateClientVpnConnectionsInput | TerminateClientVpnConnectionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[TerminateClientVpnConnectionsInputDict]) -> TerminateClientVpnConnectionsOutput

Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.

Parameters:

Name Type Description Default
request TerminateClientVpnConnectionsInput | TerminateClientVpnConnectionsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[TerminateClientVpnConnectionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
TerminateClientVpnConnectionsOutput

An instance of TerminateClientVpnConnectionsOutput.

Input

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

TerminateClientVpnConnectionsInputDict

Bases: TypedDict

Dictionary form of TerminateClientVpnConnectionsInput.

Attributes

client_vpn_endpoint_id instance-attribute
client_vpn_endpoint_id: Required[str]

The ID of the Client VPN endpoint to which the client is connected.

connection_id instance-attribute
connection_id: str | None

The ID of the client connection to be terminated.

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.

username instance-attribute
username: str | None

The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections.

TerminateClientVpnConnectionsInput dataclass

Bases: _SerdeShape

Dataclass for TerminateClientVpnConnectionsInput structure.

Attributes

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

The ID of the Client VPN endpoint to which the client is connected.

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

The ID of the client connection to be terminated.

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.

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

The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections.

Output

TerminateClientVpnConnectionsOutput dataclass

Bases: _SerdeShape

Dataclass for TerminateClientVpnConnectionsOutput structure.

Attributes

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

The ID of the Client VPN endpoint.

connection_statuses class-attribute instance-attribute
connection_statuses: list[TerminateConnectionStatus] | None = ...

The current state of the client connections.

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.

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

The user who established the terminated client connections.