get_query_runtime_statistics ¶

def get_query_runtime_statistics(
    self,
    query_execution_id: "capo_athena.types.query_execution_id.QueryExecutionId",
    *,
    config_overrides: Optional[AthenaClientConfig] = None,
) -> "capo_athena.types.get_query_runtime_statistics_output.GetQueryRuntimeStatisticsOutput":
    """<p>Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Statistics from the <code>Timeline</code> section of the response object are available as soon as <a>QueryExecutionStatus$State</a> is in a SUCCEEDED or FAILED state. The remaining non-timeline statistics in the response (like stage-level input and output row count and data size) are updated asynchronously and may not be available immediately after a query completes or, in some cases, may not be returned. The non-timeline statistics are also not included when a query has row-level filters defined in Lake Formation.</p>

    Args:
        query_execution_id: <p>The unique ID of the query execution.</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.get_query_runtime_statistics_input.GetQueryRuntimeStatisticsInput]",
    ) -> OperationResponse[
        "capo_athena.types.get_query_runtime_statistics_output.GetQueryRuntimeStatisticsOutput"
    ]:
        import capo_athena._operations.amazon_athena.get_query_runtime_statistics

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetQueryRuntimeStatistics")
    )
    input_: capo_athena.types.get_query_runtime_statistics_input.GetQueryRuntimeStatisticsInput = {
        "query_execution_id": query_execution_id
    }

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