GET

/#Action=DescribeClientVpnAuthorizationRules

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

Describes the authorization rules for a specified Client VPN endpoint.

Access Token Required: API Key

Query Params

ClientVpnEndpointIdstringrequired

The ID of the Client VPN endpoint.

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

NextTokenstring

The token to retrieve the next page of results.

Filterarray

One or more filters. Filter names and values are case-sensitive. <ul> <li> <code>description</code> - The description of the authorization rule. </li> <li> <code>destination-cidr</code> - The CIDR of the network to which the authorization rule applies. </li> <li> <code>group-id</code> - The ID of the Active Directory group to which the authorization rule grants access. </li> </ul>

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.

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=DescribeClientVpnAuthorizationRules' \
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}