stop_query_execution `async` ¶

stop_query_execution(
    query_execution_id: QueryExecutionId,
    *,
    config_overrides: Optional[AsyncAthenaClientConfig] = None,
) -> StopQueryExecutionOutput

Stops a query execution. Requires you to have access to the workgroup in which the query ran.

Parameters:

query_execution_id (QueryExecutionId) –

The unique ID of the query execution to stop.

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/async_athena.py

async def stop_query_execution(
    self,
    query_execution_id: "capo_athena.types.query_execution_id.QueryExecutionId",
    *,
    config_overrides: Optional[AsyncAthenaClientConfig] = None,
) -> "capo_athena.types.stop_query_execution_output.StopQueryExecutionOutput":
    """<p>Stops a query execution. Requires you to have access to the workgroup in which the query ran.</p>

    Args:
        query_execution_id: <p>The unique ID of the query execution to stop.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_athena.types.stop_query_execution_input.StopQueryExecutionInput]",
    ) -> AsyncOperationResponse[
        "capo_athena.types.stop_query_execution_output.StopQueryExecutionOutput"
    ]:
        import capo_athena._operations.amazon_athena.stop_query_execution

        (
            output,
            http_response,
        ) = await capo_athena._operations.amazon_athena.stop_query_execution.async_stop_query_execution(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopQueryExecution")
    )
    input_: capo_athena.types.stop_query_execution_input.StopQueryExecutionInput = {
        "query_execution_id": query_execution_id
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

stop_query_execution async ¶

stop_query_execution `async` ¶