Skip to content

/AWS1/CL_ECA=>DESCRIBEUSERS()

About DescribeUsers

Returns a list of users.

Method Signature

IMPORTING

Optional arguments:

iv_engine TYPE /AWS1/ECAENGINETYPE /AWS1/ECAENGINETYPE

The engine.

iv_userid TYPE /AWS1/ECAUSERID /AWS1/ECAUSERID

The ID of the user.

it_filters TYPE /AWS1/CL_ECAFILTER=>TT_FILTERLIST TT_FILTERLIST

Filter to determine the list of User IDs to return.

iv_maxrecords TYPE /AWS1/ECAINTEGEROPTIONAL /AWS1/ECAINTEGEROPTIONAL

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

iv_marker TYPE /AWS1/ECASTRING /AWS1/ECASTRING

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

RETURNING

oo_output TYPE REF TO /aws1/cl_ecadescrusersresult /AWS1/CL_ECADESCRUSERSRESULT

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_eca~describeusers(
  it_filters = VALUE /aws1/cl_ecafilter=>tt_filterlist(
    (
      new /aws1/cl_ecafilter(
        it_values = VALUE /aws1/cl_ecafiltervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_ecafiltervaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_engine = |string|
  iv_marker = |string|
  iv_maxrecords = 123
  iv_userid = |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_users( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_userid( ).
      lv_string = lo_row_1->get_username( ).
      lv_string = lo_row_1->get_status( ).
      lv_enginetype = lo_row_1->get_engine( ).
      lv_string = lo_row_1->get_minimumengineversion( ).
      lv_string = lo_row_1->get_accessstring( ).
      LOOP AT lo_row_1->get_usergroupids( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_usergroupid = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lo_authentication = lo_row_1->get_authentication( ).
      IF lo_authentication IS NOT INITIAL.
        lv_authenticationtype = lo_authentication->get_type( ).
        lv_integeroptional = lo_authentication->get_passwordcount( ).
      ENDIF.
      lv_string = lo_row_1->get_arn( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_marker( ).
ENDIF.