Skip to content

stop_calculation_execution async

stop_calculation_execution(
    calculation_execution_id: CalculationExecutionId,
    *,
    config_overrides: Optional[AsyncAthenaClientConfig] = None,
) -> StopCalculationExecutionResponse

Requests the cancellation of a calculation. A StopCalculationExecution call on a calculation that is already in a terminal state (for example, STOPPED, FAILED, or COMPLETED) succeeds but has no effect.

Cancelling a calculation is done on a best effort basis. If a calculation cannot be cancelled, you can be charged for its completion. If you are concerned about being charged for a calculation that cannot be cancelled, consider terminating the session in which the calculation is running.

Parameters:

Raises:

Source code in docs_src/capo_athena/_services/async_athena.py
async def stop_calculation_execution(
    self,
    calculation_execution_id: "capo_athena.types.calculation_execution_id.CalculationExecutionId",
    *,
    config_overrides: Optional[AsyncAthenaClientConfig] = None,
) -> "capo_athena.types.stop_calculation_execution_response.StopCalculationExecutionResponse":
    """<p>Requests the cancellation of a calculation. A <code>StopCalculationExecution</code> call on a calculation that is already in a terminal state (for example, <code>STOPPED</code>, <code>FAILED</code>, or <code>COMPLETED</code>) succeeds but has no effect.</p> <note> <p>Cancelling a calculation is done on a best effort basis. If a calculation cannot be cancelled, you can be charged for its completion. If you are concerned about being charged for a calculation that cannot be cancelled, consider terminating the session in which the calculation is running.</p> </note>

    Args:
        calculation_execution_id: <p>The calculation execution UUID.</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.resource_not_found_exception.ResourceNotFoundException: <p>A resource, such as a workgroup, was not found.</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_calculation_execution_request.StopCalculationExecutionRequest]",
    ) -> AsyncOperationResponse[
        "capo_athena.types.stop_calculation_execution_response.StopCalculationExecutionResponse"
    ]:
        import capo_athena._operations.amazon_athena.stop_calculation_execution

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopCalculationExecution")
    )
    input_: capo_athena.types.stop_calculation_execution_request.StopCalculationExecutionRequest = {
        "calculation_execution_id": calculation_execution_id
    }

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