DescribeClientVpnEndpoints - Amazon Elastic Compute Cloud


Describes one or more Client VPN endpoints in the account.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.


The ID of the Client VPN endpoint.

Type: Array of strings

Required: No


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.

Type: Boolean

Required: No


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

Type: Array of Filter objects

Required: No


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.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 1000.

Required: No


The token to retrieve the next page of results.

Type: String

Required: No

Response Elements

The following elements are returned by the service.


Information about the Client VPN endpoints.

Type: Array of ClientVpnEndpoint objects


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

Type: String


The ID of the request.

Type: String


For information about the errors that are common to all actions, see Common client error codes.



This example describes the Client VPN endpoints in your account.

Sample Request &AUTHPARAMS

Sample Response

<DescribeClientVpnEndpointsResponse xmlns="""> <requestId">e69f64d5-e763-4cf5-844e-c278b1946ddf</requestId"> <clientVpnEndpoint"> <item"> <authenticationOptions"> <item"> <mutualAuthentication"> <clientRootCertificateChain">arn:aws:acm:us-east-1:724145273726:certificate/82916b3c-7449-43cf-ab9e-31c18ef401c6</clientRootCertificateChain"> </mutualAuthentication"> <type">certificate-authentication</type"> </item"> </authenticationOptions"> <clientCidrBlock"></clientCidrBlock"> <connectionLogOptions"> <Enabled">false</Enabled"> </connectionLogOptions"> <creationTime">2018-12-11T13:14:10</creationTime"> <description">ash-test</description"> <dnsName"></dnsName"> <clientVpnEndpointId">cvpn-endpoint-0043a94c5c27c7997</clientVpnEndpointId"> <status"> <code">pending-associate</code"> </status"> <serverCertificateArn">arn:aws:acm:us-east-1:724145273726:certificate/82916b3c-7449-43cf-ab9e-31c18ef401c6</serverCertificateArn"> <splitTunnel">false</splitTunnel"> <transportProtocol">tcp</transportProtocol"> <vpnProtocol">openvpn</vpnProtocol"> <item"> </clientVpnEndpoint"> </DescribeClientVpnEndpointsResponse">

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: