Athena / Client / list_query_executions

list_query_executions#

Athena.Client.list_query_executions(**kwargs)#

Provides a list of available query execution IDs for the queries in the specified workgroup. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.

For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_query_executions(
    NextToken='string',
    MaxResults=123,
    WorkGroup='string'
)
Parameters:

  • 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.

  • MaxResults (integer) – The maximum number of query executions to return in this request.

  • WorkGroup (string) – The name of the workgroup from which queries are being returned. If a workgroup is not specified, a list of available query execution IDs for the queries in the primary workgroup is returned.

Return type:

dict

Returns:

Response Syntax

{
    'QueryExecutionIds': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • QueryExecutionIds (list) –

      The unique IDs of each query execution as an array of strings.

      • (string) –

    • NextToken (string) –

      A token to be used by the next request if this request is truncated.

Exceptions

  • Athena.Client.exceptions.InternalServerException

  • Athena.Client.exceptions.InvalidRequestException