Skip to content

list_query_executions

list_query_executions(
    *,
    config_overrides: Optional[AthenaClientConfig] = None,
    next_token: Optional[Token] = None,
    max_results: Optional[MaxQueryExecutionsCount] = None,
    work_group: Optional[WorkGroupName] = None,
) -> ListQueryExecutionsOutput

Provides a list of available query execution IDs for the queries in the specified workgroup. Athena keeps a query history for 45 days. 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.

Parameters:

  • next_token (Optional[Token], default: None ) –

    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.

  • max_results (Optional[MaxQueryExecutionsCount], default: None ) –

    The maximum number of query executions to return in this request.

  • work_group (Optional[WorkGroupName], default: None ) –

    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.

Raises:

  • InternalServerException –

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

  • InvalidRequestException –

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

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_athena/_services/athena.py
def list_query_executions(
    self,
    *,
    config_overrides: Optional[AthenaClientConfig] = None,
    next_token: Optional["capo_athena.types.token.Token"] = None,
    max_results: Optional[
        "capo_athena.types.max_query_executions_count.MaxQueryExecutionsCount"
    ] = None,
    work_group: Optional["capo_athena.types.work_group_name.WorkGroupName"] = None,
) -> "capo_athena.types.list_query_executions_output.ListQueryExecutionsOutput":
    """<p>Provides a list of available query execution IDs for the queries in the specified workgroup. Athena keeps a query history for 45 days. 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.</p>

    Args:
        next_token: <p>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 <code>NextToken</code> from the response object of the previous page call.</p>
        max_results: <p>The maximum number of query executions to return in this request.</p>
        work_group: <p>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.</p>

    Raises:
        capo_athena.errors.internal_server_exception.InternalServerException: <p>Indicates a platform issue, which may be due to a transient condition or outage.</p>
        capo_athena.errors.invalid_request_exception.InvalidRequestException: <p>Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.</p>
        capo_athena.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_athena.types.list_query_executions_input.ListQueryExecutionsInput]",
    ) -> OperationResponse[
        "capo_athena.types.list_query_executions_output.ListQueryExecutionsOutput"
    ]:
        import capo_athena._operations.amazon_athena.list_query_executions

        output, http_response = (
            capo_athena._operations.amazon_athena.list_query_executions.list_query_executions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListQueryExecutions")
    )
    input_: capo_athena.types.list_query_executions_input.ListQueryExecutionsInput = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if work_group is not None:
        input_["work_group"] = work_group

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output