DESCRIBECLIENTVPNAUTHRULES()`¶

About DescribeClientVpnAuthorizationRules¶

Describes the authorization rules for a specified Client VPN endpoint.

Method Signature¶

METHODS /AWS1/IF_EC2~DESCRIBECLIENTVPNAUTHRULES
  IMPORTING
    !IV_CLIENTVPNENDPOINTID TYPE /AWS1/EC2CLIENTVPNENDPOINTID OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EC2NEXTTOKEN OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EC2DSCCLIVPNAUTHRLSMAX00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2dscclivpnauthrlsrs
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_clientvpnendpointid` `TYPE /AWS1/EC2CLIENTVPNENDPOINTID` `/AWS1/EC2CLIENTVPNENDPOINTID`¶

The ID of the Client VPN endpoint.

Optional arguments:¶

`iv_dryrun` `TYPE /AWS1/EC2BOOLEAN` `/AWS1/EC2BOOLEAN`¶

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.

`iv_nexttoken` `TYPE /AWS1/EC2NEXTTOKEN` `/AWS1/EC2NEXTTOKEN`¶

The token to retrieve the next page of results.

`it_filters` `TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST` `TT_FILTERLIST`¶

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.

`iv_maxresults` `TYPE /AWS1/EC2DSCCLIVPNAUTHRLSMAX00` `/AWS1/EC2DSCCLIVPNAUTHRLSMAX00`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ec2dscclivpnauthrlsrs` `/AWS1/CL_EC2DSCCLIVPNAUTHRLSRS`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->describeclientvpnauthrules(
  it_filters = VALUE /aws1/cl_ec2filter=>tt_filterlist(
    (
      new /aws1/cl_ec2filter(
        it_values = VALUE /aws1/cl_ec2valuestringlist_w=>tt_valuestringlist(
          ( new /aws1/cl_ec2valuestringlist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_clientvpnendpointid = |string|
  iv_dryrun = ABAP_TRUE
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_authorizationrules( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_clientvpnendpointid( ).
      lv_string = lo_row_1->get_description( ).
      lv_string = lo_row_1->get_groupid( ).
      lv_boolean = lo_row_1->get_accessall( ).
      lv_string = lo_row_1->get_destinationcidr( ).
      lo_clientvpnauthorizationr = lo_row_1->get_status( ).
      IF lo_clientvpnauthorizationr IS NOT INITIAL.
        lv_clientvpnauthorizationr_1 = lo_clientvpnauthorizationr->get_code( ).
        lv_string = lo_clientvpnauthorizationr->get_message( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_EC2=>DESCRIBECLIENTVPNAUTHRULES()¶