/AWS1/CL_EC2=>DESCRIBECLIENTVPNCONNECTIONS()

About DescribeClientVpnConnections

Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.

Method Signature

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.

• connection-id - The ID of the connection.

• username - For Active Directory client authentication, the user name of the client who established the client connection.

iv_nexttoken TYPE /AWS1/EC2NEXTTOKEN /AWS1/EC2NEXTTOKEN

The token to retrieve the next page of results.

iv_maxresults TYPE /AWS1/EC2DSCCLIVPNCXNSMAXRSS /AWS1/EC2DSCCLIVPNCXNSMAXRSS

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_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_ec2dscclientvpncxnsrs /AWS1/CL_EC2DSCCLIENTVPNCXNSRS

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~describeclientvpnconnections(
  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_connections( ) 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_timestamp( ).
      lv_string = lo_row_1->get_connectionid( ).
      lv_string = lo_row_1->get_username( ).
      lv_string = lo_row_1->get_connestablishedtime( ).
      lv_string = lo_row_1->get_ingressbytes( ).
      lv_string = lo_row_1->get_egressbytes( ).
      lv_string = lo_row_1->get_ingresspackets( ).
      lv_string = lo_row_1->get_egresspackets( ).
      lv_string = lo_row_1->get_clientip( ).
      lv_string = lo_row_1->get_commonname( ).
      lo_clientvpnconnectionstat = lo_row_1->get_status( ).
      IF lo_clientvpnconnectionstat IS NOT INITIAL.
        lv_clientvpnconnectionstat_1 = lo_clientvpnconnectionstat->get_code( ).
        lv_string = lo_clientvpnconnectionstat->get_message( ).
      ENDIF.
      lv_string = lo_row_1->get_connectionendtime( ).
      LOOP AT lo_row_1->get_posturecplncstatuses( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.