Skip to content

DescribeClientVpnConnectionsRequest

Source code in docs_src/capo_ec2/types/describe_client_vpn_connections_request.py
class DescribeClientVpnConnectionsRequest(TypedDict, closed=True):
    client_vpn_endpoint_id: NotRequired[
        "capo_ec2.types.client_vpn_endpoint_id.ClientVpnEndpointId"
    ]
    """<p>The ID of the Client VPN endpoint.</p>"""
    filters: NotRequired["capo_ec2.types.filter_list.FilterList"]
    """<p>One or more filters. Filter names and values are case-sensitive.</p> <ul> <li> <p> <code>connection-id</code> - The ID of the connection.</p> </li> <li> <p> <code>username</code> - For Active Directory client authentication, the user name of the client who established the client connection.</p> </li> </ul>"""
    next_token: NotRequired["capo_ec2.types.next_token.NextToken"]
    """<p>The token to retrieve the next page of results.</p>"""
    max_results: NotRequired[
        "capo_ec2.types.describe_client_vpn_connections_max_results.DescribeClientVpnConnectionsMaxResults"
    ]
    """<p>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.</p>"""
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<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>"""

client_vpn_endpoint_id instance-attribute

client_vpn_endpoint_id: NotRequired[ClientVpnEndpointId]

The ID of the Client VPN endpoint.

dry_run instance-attribute

dry_run: NotRequired[Boolean]

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: NotRequired[FilterList]

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: NotRequired[DescribeClientVpnConnectionsMaxResults]

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: NotRequired[NextToken]

The token to retrieve the next page of results.