Describe Client Vpn Authorization Rules

ec2_describe_client_vpn_authorization_rules

R Documentation

Describes the authorization rules for a specified Client VPN endpoint¶

Description¶

Describes the authorization rules for a specified Client VPN endpoint.

Usage¶

ec2_describe_client_vpn_authorization_rules(ClientVpnEndpointId, DryRun,
  NextToken, Filters, MaxResults)

Arguments¶

ClientVpnEndpointId

[required] The ID of the Client VPN endpoint.

DryRun

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.

NextToken

The token to retrieve the next page of results.

Filters

One or more filters. Filter names and values are case-sensitive.

description - The description of the authorization rule.
destination-cidr - The CIDR of the network to which the authorization rule applies.
group-id - The ID of the Active Directory group to which the authorization rule grants access.

MaxResults

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.

Value¶

A list with the following syntax:

list(
  AuthorizationRules = list(
    list(
      ClientVpnEndpointId = "string",
      Description = "string",
      GroupId = "string",
      AccessAll = TRUE|FALSE,
      DestinationCidr = "string",
      Status = list(
        Code = "authorizing"|"active"|"failed"|"revoking",
        Message = "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_client_vpn_authorization_rules(
  ClientVpnEndpointId = "string",
  DryRun = TRUE|FALSE,
  NextToken = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123
)