# ListExecutors
<a name="API_ListExecutors"></a>

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
<a name="API_ListExecutors_RequestSyntax"></a>

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

## Request Parameters
<a name="API_ListExecutors_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ExecutorStateFilter](#API_ListExecutors_RequestSyntax) **   <a name="athena-ListExecutors-request-ExecutorStateFilter"></a>
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  
Valid Values: `CREATING | CREATED | REGISTERED | TERMINATING | TERMINATED | FAILED`   
Required: No

 ** [MaxResults](#API_ListExecutors_RequestSyntax) **   <a name="athena-ListExecutors-request-MaxResults"></a>
The maximum number of executors to return.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListExecutors_RequestSyntax) **   <a name="athena-ListExecutors-request-NextToken"></a>
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](#API_ListExecutors_RequestSyntax) **   <a name="athena-ListExecutors-request-SessionId"></a>
The session ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_ListExecutors_ResponseSyntax"></a>

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

## Response Elements
<a name="API_ListExecutors_ResponseElements"></a>

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](#API_ListExecutors_ResponseSyntax) **   <a name="athena-ListExecutors-response-ExecutorsSummary"></a>
Contains summary information about the executor.  
Type: Array of [ExecutorsSummary](API_ExecutorsSummary.md) objects

 ** [NextToken](#API_ListExecutors_ResponseSyntax) **   <a name="athena-ListExecutors-response-NextToken"></a>
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.

 ** [SessionId](#API_ListExecutors_ResponseSyntax) **   <a name="athena-ListExecutors-response-SessionId"></a>
The session ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_ListExecutors_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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.    
 ** AthenaErrorCode **   
The error code returned when the query execution failed to process, or when the processing request for the named query failed.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
A resource, such as a workgroup, was not found.    
 ** ResourceName **   
The name of the Amazon resource.
HTTP Status Code: 400

## See Also
<a name="API_ListExecutors_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/athena-2017-05-18/ListExecutors) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/athena-2017-05-18/ListExecutors) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/athena-2017-05-18/ListExecutors) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/athena-2017-05-18/ListExecutors) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/athena-2017-05-18/ListExecutors) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/athena-2017-05-18/ListExecutors) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/athena-2017-05-18/ListExecutors) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/athena-2017-05-18/ListExecutors) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/athena-2017-05-18/ListExecutors) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/athena-2017-05-18/ListExecutors)