LISTUSERS()`¶

About ListUsers¶

Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

Method Signature¶

METHODS /AWS1/IF_TRN~LISTUSERS
  IMPORTING
    !IV_MAXRESULTS TYPE /AWS1/TRNMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/TRNNEXTTOKEN OPTIONAL
    !IV_SERVERID TYPE /AWS1/TRNSERVERID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_trnlistusersresponse
  RAISING
    /AWS1/CX_TRNINTERNALSVCERROR
    /AWS1/CX_TRNINVALIDNEXTTOKENEX
    /AWS1/CX_TRNINVALIDREQUESTEX
    /AWS1/CX_TRNRESOURCENOTFOUNDEX
    /AWS1/CX_TRNSERVICEUNAVAILEX
    /AWS1/CX_TRNCLIENTEXC
    /AWS1/CX_TRNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_serverid` `TYPE /AWS1/TRNSERVERID` `/AWS1/TRNSERVERID`¶

A system-assigned unique identifier for a server that has users assigned to it.

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/TRNMAXRESULTS` `/AWS1/TRNMAXRESULTS`¶

Specifies the number of users to return as a response to the ListUsers request.

`iv_nexttoken` `TYPE /AWS1/TRNNEXTTOKEN` `/AWS1/TRNNEXTTOKEN`¶

If there are additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass the NextToken to a subsequent ListUsers command, to continue listing additional users.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_trnlistusersresponse` `/AWS1/CL_TRNLISTUSERSRESPONSE`¶

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->listusers(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_serverid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_nexttoken = lo_result->get_nexttoken( ).
  lv_serverid = lo_result->get_serverid( ).
  LOOP AT lo_result->get_users( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_arn = lo_row_1->get_arn( ).
      lv_homedirectory = lo_row_1->get_homedirectory( ).
      lv_homedirectorytype = lo_row_1->get_homedirectorytype( ).
      lv_role = lo_row_1->get_role( ).
      lv_sshpublickeycount = lo_row_1->get_sshpublickeycount( ).
      lv_username = lo_row_1->get_username( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_TRN=>LISTUSERS()¶