Skip to content

describe_client_vpn_connections

Operation

describe_client_vpn_connections

describe_client_vpn_connections(request: DescribeClientVpnConnectionsInput | DescribeClientVpnConnectionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeClientVpnConnectionsInputDict]) -> DescribeClientVpnConnectionsOutput

Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.

Parameters:

Name Type Description Default
request DescribeClientVpnConnectionsInput | DescribeClientVpnConnectionsInputDict | 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[DescribeClientVpnConnectionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeClientVpnConnectionsOutput

An instance of DescribeClientVpnConnectionsOutput.

describe_client_vpn_connections async

describe_client_vpn_connections(request: DescribeClientVpnConnectionsInput | DescribeClientVpnConnectionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeClientVpnConnectionsInputDict]) -> DescribeClientVpnConnectionsOutput

Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.

Parameters:

Name Type Description Default
request DescribeClientVpnConnectionsInput | DescribeClientVpnConnectionsInputDict | 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[DescribeClientVpnConnectionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeClientVpnConnectionsOutput

An instance of DescribeClientVpnConnectionsOutput.

Input

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

DescribeClientVpnConnectionsInputDict

Bases: TypedDict

Dictionary form of DescribeClientVpnConnectionsInput.

Attributes

client_vpn_endpoint_id instance-attribute
client_vpn_endpoint_id: Required[str]

The ID of the Client VPN endpoint.

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.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

One or more filters. Filter names and values are case-sensitive.

  • connection-id - The ID of the connection.

  • username - For Active Directory client authentication, the user name of the client who established the client connection.

max_results instance-attribute
max_results: int | None

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

next_token instance-attribute
next_token: str | None

The token to retrieve the next page of results.

DescribeClientVpnConnectionsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeClientVpnConnectionsInput structure.

Attributes

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

The ID of the Client VPN endpoint.

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.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

One or more filters. Filter names and values are case-sensitive.

  • connection-id - The ID of the connection.

  • username - For Active Directory client authentication, the user name of the client who established the client connection.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

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

The token to retrieve the next page of results.

Output

DescribeClientVpnConnectionsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeClientVpnConnectionsOutput structure.

Attributes

connections class-attribute instance-attribute
connections: list[ClientVpnConnection] | None = ...

Information about the active and terminated client connections.

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

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

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.