/AWS1/CL_ATH=>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¶
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
NextTokenfrom the response object of the previous page call.