v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-171,1822,9897.4 MB

Describes one or more Client VPN endpoints in the account.

get/#Action=DescribeClientVpnEndpoints

Query parameters

ClientVpnEndpointIdstring[]

The ID of the Client VPN endpoint.

MaxResultsinteger

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.

NextTokenstring

The token to retrieve the next page of results.

Namestring

The name of the filter. Filter names are case-sensitive.

Valuesstring[]

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an <code>OR</code>, and the request returns all results that match any of the specified values.

<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>
DryRunboolean

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>.

Action'DescribeClientVpnEndpoints' required
Version'2016-11-15' required

Response

Success