LISTSESSIONS()`¶

About ListSessions¶

Lists the sessions in a workgroup that are in an active state like CREATING, CREATED, IDLE, or BUSY. Newer sessions are listed first; older sessions are listed later.

Method Signature¶

METHODS /AWS1/IF_ATH~LISTSESSIONS
  IMPORTING
    !IV_WORKGROUP TYPE /AWS1/ATHWORKGROUPNAME OPTIONAL
    !IV_STATEFILTER TYPE /AWS1/ATHSESSIONSTATE OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/ATHMAXSESSIONSCOUNT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ATHSESSIONMANAGERTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_athlistsessionsrsp
  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_workgroup` `TYPE /AWS1/ATHWORKGROUPNAME` `/AWS1/ATHWORKGROUPNAME`¶

The workgroup to which the session belongs.

Optional arguments:¶

`iv_statefilter` `TYPE /AWS1/ATHSESSIONSTATE` `/AWS1/ATHSESSIONSTATE`¶

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

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

CREATED - The session has been started.

IDLE - The session is able to accept a calculation.

BUSY - The session is processing another task and is unable to accept a calculation.

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

TERMINATED - The session and its resources are no longer running.

DEGRADED - The session has no healthy coordinators.

FAILED - Due to a failure, the session and its resources are no longer running.

`iv_maxresults` `TYPE /AWS1/ATHMAXSESSIONSCOUNT` `/AWS1/ATHMAXSESSIONSCOUNT`¶

The maximum number of sessions 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_athlistsessionsrsp` `/AWS1/CL_ATHLISTSESSIONSRSP`¶

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->listsessions(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_statefilter = |string|
  iv_workgroup = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_sessionmanagertoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_sessions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_sessionid = lo_row_1->get_sessionid( ).
      lv_descriptionstring = lo_row_1->get_description( ).
      lo_engineversion = lo_row_1->get_engineversion( ).
      IF lo_engineversion IS NOT INITIAL.
        lv_namestring = lo_engineversion->get_selectedengineversion( ).
        lv_namestring = lo_engineversion->get_effectiveengineversion( ).
      ENDIF.
      lv_namestring = lo_row_1->get_notebookversion( ).
      lo_sessionstatus = lo_row_1->get_status( ).
      IF lo_sessionstatus IS NOT INITIAL.
        lv_date = lo_sessionstatus->get_startdatetime( ).
        lv_date = lo_sessionstatus->get_lastmodifieddatetime( ).
        lv_date = lo_sessionstatus->get_enddatetime( ).
        lv_date = lo_sessionstatus->get_idlesincedatetime( ).
        lv_sessionstate = lo_sessionstatus->get_state( ).
        lv_descriptionstring = lo_sessionstatus->get_statechangereason( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_ATH=>LISTSESSIONS()¶