DESCRIBECLIENTVPNROUTES()`¶

About DescribeClientVpnRoutes¶

Describes the routes for the specified Client VPN endpoint.

Method Signature¶

METHODS /AWS1/IF_EC2~DESCRIBECLIENTVPNROUTES
  IMPORTING
    !IV_CLIENTVPNENDPOINTID TYPE /AWS1/EC2CLIENTVPNENDPOINTID OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EC2DSCCLIVPNROUTESMAXRSS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EC2NEXTTOKEN OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2dscclivpnroutesrs
  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:¶

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

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

destination-cidr - The CIDR of the route destination.

origin - How the route was associated with the Client VPN endpoint (associate | add-route).

target-subnet - The ID of the subnet through which traffic is routed.

`iv_maxresults` `TYPE /AWS1/EC2DSCCLIVPNROUTESMAXRSS` `/AWS1/EC2DSCCLIVPNROUTESMAXRSS`¶

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.

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

The token to retrieve the next page of results.

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

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ec2dscclivpnroutesrs` `/AWS1/CL_EC2DSCCLIVPNROUTESRS`¶

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->describeclientvpnroutes(
  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_routes( ) 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_destinationcidr( ).
      lv_string = lo_row_1->get_targetsubnet( ).
      lv_string = lo_row_1->get_type( ).
      lv_string = lo_row_1->get_origin( ).
      lo_clientvpnroutestatus = lo_row_1->get_status( ).
      IF lo_clientvpnroutestatus IS NOT INITIAL.
        lv_clientvpnroutestatuscod = lo_clientvpnroutestatus->get_code( ).
        lv_string = lo_clientvpnroutestatus->get_message( ).
      ENDIF.
      lv_string = lo_row_1->get_description( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_EC2=>DESCRIBECLIENTVPNROUTES()¶