terminate_client_vpn_connections `async` ¶

terminate_client_vpn_connections(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    client_vpn_endpoint_id: Optional[ClientVpnEndpointId] = None,
    connection_id: Optional[String] = None,
    username: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
) -> TerminateClientVpnConnectionsResult

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:

client_vpn_endpoint_id (Optional[ClientVpnEndpointId], default: None ) –

The ID of the Client VPN endpoint to which the client is connected.
connection_id (Optional[String], default: None ) –

The ID of the client connection to be terminated.
username (Optional[String], default: 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.
dry_run (Optional[Boolean], default: 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.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_ec2/_services/async_ec2.py

async def terminate_client_vpn_connections(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    client_vpn_endpoint_id: Optional[
        "capo_ec2.types.client_vpn_endpoint_id.ClientVpnEndpointId"
    ] = None,
    connection_id: Optional["capo_ec2.types.string.String"] = None,
    username: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.terminate_client_vpn_connections_result.TerminateClientVpnConnectionsResult":
    """<p>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.</p>

    Args:
        client_vpn_endpoint_id: <p>The ID of the Client VPN endpoint to which the client is connected.</p>
        connection_id: <p>The ID of the client connection to be terminated.</p>
        username: <p>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.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.terminate_client_vpn_connections_request.TerminateClientVpnConnectionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.terminate_client_vpn_connections_result.TerminateClientVpnConnectionsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.terminate_client_vpn_connections

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.terminate_client_vpn_connections.async_terminate_client_vpn_connections(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("TerminateClientVpnConnections")
    )
    input_: capo_ec2.types.terminate_client_vpn_connections_request.TerminateClientVpnConnectionsRequest = {}
    if client_vpn_endpoint_id is not None:
        input_["client_vpn_endpoint_id"] = client_vpn_endpoint_id
    if connection_id is not None:
        input_["connection_id"] = connection_id
    if username is not None:
        input_["username"] = username
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

terminate_client_vpn_connections async ¶

terminate_client_vpn_connections `async` ¶