LISTSERVERS()`¶

About ListServers¶

Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.

Method Signature¶

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

IMPORTING¶

Optional arguments:¶

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

Specifies the number of servers to return as a response to the ListServers query.

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

When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_trnlistserversrsp` `/AWS1/CL_TRNLISTSERVERSRSP`¶

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->listservers(
  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.
  lv_nexttoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_servers( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_arn = lo_row_1->get_arn( ).
      lv_domain = lo_row_1->get_domain( ).
      lv_identityprovidertype = lo_row_1->get_identityprovidertype( ).
      lv_endpointtype = lo_row_1->get_endpointtype( ).
      lv_role = lo_row_1->get_loggingrole( ).
      lv_serverid = lo_row_1->get_serverid( ).
      lv_state = lo_row_1->get_state( ).
      lv_usercount = lo_row_1->get_usercount( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_TRN=>LISTSERVERS()¶