DESCRIBECLIENTVPNENDPOINTS()`¶

About DescribeClientVpnEndpoints¶

Describes one or more Client VPN endpoints in the account.

Method Signature¶

IMPORTING¶

Optional arguments:¶

`it_clientvpnendpointids` `TYPE /AWS1/CL_EC2CLIVPNENDPTIDLST_W=>TT_CLIENTVPNENDPOINTIDLIST` `TT_CLIENTVPNENDPOINTIDLIST`¶

The ID of the Client VPN endpoint.

`iv_maxresults` `TYPE /AWS1/EC2DSCCLIVPNENDPTMAXRSS` `/AWS1/EC2DSCCLIVPNENDPTMAXRSS`¶

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.

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

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

endpoint-id - The ID of the Client VPN endpoint.

transport-protocol - The transport protocol (tcp | udp).

`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_ec2dscclivpnendptsrs` `/AWS1/CL_EC2DSCCLIVPNENDPTSRS`¶

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->/aws1/if_ec2~describeclientvpnendpoints(
  it_clientvpnendpointids = VALUE /aws1/cl_ec2clivpnendptidlst_w=>tt_clientvpnendpointidlist(
    ( new /aws1/cl_ec2clivpnendptidlst_w( |string| ) )
  )
  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_dryrun = ABAP_TRUE
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

LOOP AT lo_result->get_clientvpnendpoints( ) into lo_row.
  lv_string = lo_row_1->get_clientvpnendpointid( ).
  lv_string = lo_row_1->get_description( ).
  lv_clientvpnendpointstatus_1 = lo_clientvpnendpointstatus->get_code( ).
  lv_string = lo_clientvpnendpointstatus->get_message( ).
  lv_string = lo_row_1->get_creationtime( ).
  lv_string = lo_row_1->get_deletiontime( ).
  lv_string = lo_row_1->get_dnsname( ).
  lv_string = lo_row_1->get_clientcidrblock( ).
  LOOP AT lo_row_1->get_dnsservers( ) into lo_row_2.
    lv_string = lo_row_3->get_value( ).
  ENDLOOP.
  lv_boolean = lo_row_1->get_splittunnel( ).
  lv_vpnprotocol = lo_row_1->get_vpnprotocol( ).
  lv_transportprotocol = lo_row_1->get_transportprotocol( ).
  lv_integer = lo_row_1->get_vpnport( ).
  LOOP AT lo_row_1->get_associatedtargetnetworks( ) into lo_row_4.
    lv_string = lo_row_5->get_networkid( ).
    lv_associatednetworktype = lo_row_5->get_networktype( ).
  ENDLOOP.
  lv_string = lo_row_1->get_servercertificatearn( ).
  LOOP AT lo_row_1->get_authenticationoptions( ) into lo_row_6.
    lv_clientvpnauthentication = lo_row_7->get_type( ).
    lv_string = lo_directoryserviceauthent->get_directoryid( ).
    lv_string = lo_certificateauthenticati->get_clientrootcertchain( ).
    lv_string = lo_federatedauthentication->get_samlproviderarn( ).
    lv_string = lo_federatedauthentication->get_selfservicesamlpvdrarn( ).
  ENDLOOP.
  lv_boolean = lo_connectionlogresponseop->get_enabled( ).
  lv_string = lo_connectionlogresponseop->get_cloudwatchloggroup( ).
  lv_string = lo_connectionlogresponseop->get_cloudwatchlogstream( ).
  LOOP AT lo_row_1->get_tags( ) into lo_row_8.
    lv_string = lo_row_9->get_key( ).
    lv_string = lo_row_9->get_value( ).
  ENDLOOP.
  LOOP AT lo_row_1->get_securitygroupids( ) into lo_row_10.
    lv_securitygroupid = lo_row_11->get_value( ).
  ENDLOOP.
  lv_vpcid = lo_row_1->get_vpcid( ).
  lv_string = lo_row_1->get_selfserviceportalurl( ).
  lv_boolean = lo_clientconnectresponseop->get_enabled( ).
  lv_string = lo_clientconnectresponseop->get_lambdafunctionarn( ).
  lv_clientvpnendpointattrib_1 = lo_clientvpnendpointattrib->get_code( ).
  lv_string = lo_clientvpnendpointattrib->get_message( ).
  lv_integer = lo_row_1->get_sessiontimeouthours( ).
  lv_boolean = lo_clientloginbannerrespon->get_enabled( ).
  lv_string = lo_clientloginbannerrespon->get_bannertext( ).
  lv_boolean = lo_clientrouteenforcementr->get_enforced( ).
  lv_boolean = lo_row_1->get_discnctonsessiontimeout( ).
ENDLOOP.
lv_nexttoken = lo_result->get_nexttoken( ).

/AWS1/CL_EC2=>DESCRIBECLIENTVPNENDPOINTS()¶