LISTEXECUTORS()`¶

About ListExecutors¶

Lists, in descending order, the executors that joined a session. Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.

Method Signature¶

METHODS /AWS1/IF_ATH~LISTEXECUTORS
  IMPORTING
    !IV_SESSIONID TYPE /AWS1/ATHSESSIONID OPTIONAL
    !IV_EXECUTORSTATEFILTER TYPE /AWS1/ATHEXECUTORSTATE OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/ATHMAXLISTEXECUTORSCOUNT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ATHSESSIONMANAGERTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_athlistexecutorsrsp
  RAISING
    /AWS1/CX_ATHINTERNALSERVEREX
    /AWS1/CX_ATHINVALIDREQUESTEX
    /AWS1/CX_ATHRESOURCENOTFOUNDEX
    /AWS1/CX_ATHCLIENTEXC
    /AWS1/CX_ATHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_sessionid` `TYPE /AWS1/ATHSESSIONID` `/AWS1/ATHSESSIONID`¶

The session ID.

Optional arguments:¶

`iv_executorstatefilter` `TYPE /AWS1/ATHEXECUTORSTATE` `/AWS1/ATHEXECUTORSTATE`¶

A filter for a specific executor state. A description of each state follows.

CREATING - The executor is being started, including acquiring resources.

CREATED - The executor has been started.

REGISTERED - The executor has been registered.

TERMINATING - The executor is in the process of shutting down.

TERMINATED - The executor is no longer running.

FAILED - Due to a failure, the executor is no longer running.

`iv_maxresults` `TYPE /AWS1/ATHMAXLISTEXECUTORSCOUNT` `/AWS1/ATHMAXLISTEXECUTORSCOUNT`¶

The maximum number of executors to return.

`iv_nexttoken` `TYPE /AWS1/ATHSESSIONMANAGERTOKEN` `/AWS1/ATHSESSIONMANAGERTOKEN`¶

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_athlistexecutorsrsp` `/AWS1/CL_ATHLISTEXECUTORSRSP`¶

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->listexecutors(
  iv_executorstatefilter = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_sessionid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_sessionid = lo_result->get_sessionid( ).
  lv_sessionmanagertoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_executorssummary( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_executorid = lo_row_1->get_executorid( ).
      lv_executortype = lo_row_1->get_executortype( ).
      lv_long = lo_row_1->get_startdatetime( ).
      lv_long = lo_row_1->get_terminationdatetime( ).
      lv_executorstate = lo_row_1->get_executorstate( ).
      lv_long = lo_row_1->get_executorsize( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_ATH=>LISTEXECUTORS()¶