Athena / Client / list_executors

list_executors#

Athena.Client.list_executors(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_executors(
    SessionId='string',
    ExecutorStateFilter='CREATING'|'CREATED'|'REGISTERED'|'TERMINATING'|'TERMINATED'|'FAILED',
    MaxResults=123,
    NextToken='string'
)

Parameters:

SessionId (string) –
[REQUIRED]

The session ID.
ExecutorStateFilter (string) –
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.
MaxResults (integer) – The maximum number of executors to return.
NextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'SessionId': 'string',
    'NextToken': 'string',
    'ExecutorsSummary': [
        {
            'ExecutorId': 'string',
            'ExecutorType': 'COORDINATOR'|'GATEWAY'|'WORKER',
            'StartDateTime': 123,
            'TerminationDateTime': 123,
            'ExecutorState': 'CREATING'|'CREATED'|'REGISTERED'|'TERMINATING'|'TERMINATED'|'FAILED',
            'ExecutorSize': 123
        },
    ]
}

Response Structure

(dict) –
- SessionId (string) –
  
  The session ID.
- NextToken (string) –
  
  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.
- ExecutorsSummary (list) –
  
  Contains summary information about the executor.
  - (dict) –
    
    Contains summary information about an executor.
    - ExecutorId (string) –
      
      The UUID of the executor.
    - ExecutorType (string) –
      
      The type of executor used for the application ( COORDINATOR , GATEWAY , or WORKER ).
    - StartDateTime (integer) –
      
      The date and time that the executor started.
    - TerminationDateTime (integer) –
      
      The date and time that the executor was terminated.
    - ExecutorState (string) –
      
      The processing state of the executor. 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.
    - ExecutorSize (integer) –
      
      The smallest unit of compute that a session can request from Athena. Size is measured in data processing unit (DPU) values, a relative measure of processing power.

Exceptions

Athena.Client.exceptions.InternalServerException
Athena.Client.exceptions.InvalidRequestException
Athena.Client.exceptions.ResourceNotFoundException