Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

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.

Request Syntax


{
   "ExecutorStateFilter": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SessionId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ExecutorStateFilter

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.

Type: String

Required: No

MaxResults

The maximum number of executors to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

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.

Type: String

Length Constraints: Maximum length of 2048.

Required: No

SessionId

The session ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Response Syntax


{
   "ExecutorsSummary": [ 
      { 
         "ExecutorId": "string",
         "ExecutorSize": number,
         "ExecutorState": "string",
         "ExecutorType": "string",
         "StartDateTime": number,
         "TerminationDateTime": number
      }
   ],
   "NextToken": "string",
   "SessionId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ExecutorsSummary

Contains summary information about the executor.

Type: Array of ExecutorsSummary objects

NextToken

Type: String

Length Constraints: Maximum length of 2048.

SessionId

The session ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

Indicates a platform issue, which may be due to a transient condition or outage.

HTTP Status Code: 500

InvalidRequestException

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

HTTP Status Code: 400

ResourceNotFoundException

A resource, such as a workgroup, was not found.

HTTP Status Code: 400