GET

/#Action=DescribeClientVpnConnections

http://ec2.{region}.amazonaws.com/#Action=DescribeClientVpnConnections

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

Access Token Required: API Key

Query Params

ClientVpnEndpointIdstringrequired

The ID of the Client VPN endpoint.

Filterarray

One or more filters. Filter names and values are case-sensitive. <ul> <li> <code>connection-id</code> - The ID of the connection. </li> <li> <code>username</code> - For Active Directory client authentication, the user name of the client who established the client connection. </li> </ul>

NextTokenstring

The token to retrieve the next page of results.

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.

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

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://ec2.{region}.amazonaws.com/#Action=DescribeClientVpnConnections' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}