Skip to content

DescribeClientVpnEndpointsRequest

Source code in docs_src/capo_ec2/types/describe_client_vpn_endpoints_request.py
class DescribeClientVpnEndpointsRequest(TypedDict, closed=True):
    client_vpn_endpoint_ids: NotRequired[
        "capo_ec2.types.client_vpn_endpoint_id_list.ClientVpnEndpointIdList"
    ]
    """<p>The ID of the Client VPN endpoint.</p>"""
    max_results: NotRequired[
        "capo_ec2.types.describe_client_vpn_endpoint_max_results.DescribeClientVpnEndpointMaxResults"
    ]
    """<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>"""
    next_token: NotRequired["capo_ec2.types.next_token.NextToken"]
    """<p>The token to retrieve the next page of results.</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>endpoint-id</code> - The ID of the Client VPN endpoint.</p> </li> <li> <p> <code>transport-protocol</code> - The transport protocol (<code>tcp</code> | <code>udp</code>).</p> </li> </ul>"""
    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_ids instance-attribute

client_vpn_endpoint_ids: NotRequired[ClientVpnEndpointIdList]

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.

  • endpoint-id - The ID of the Client VPN endpoint.

  • transport-protocol - The transport protocol (tcp | udp).

max_results instance-attribute

max_results: NotRequired[DescribeClientVpnEndpointMaxResults]

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.