stop_durable_execution ¶

def stop_durable_execution(
    self,
    durable_execution_arn: "capo_lambda.types.durable_execution_arn.DurableExecutionArn",
    *,
    config_overrides: Optional[LambdaClientConfig] = None,
    error: Optional["capo_lambda.types.error_object.ErrorObject"] = None,
) -> (
    "capo_lambda.types.stop_durable_execution_response.StopDurableExecutionResponse"
):
    """<p>Stops a running <a href="https://docs.aws.amazon.com/lambda/latest/dg/durable-functions.html">durable execution</a>. The execution transitions to STOPPED status and cannot be resumed. Any in-progress operations are terminated.</p>

    Args:
        durable_execution_arn: <p>The Amazon Resource Name (ARN) of the durable execution.</p>
        error: <p>Optional error details explaining why the execution is being stopped.</p>

    Raises:
        capo_lambda.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One of the parameters in the request is not valid.</p>
        capo_lambda.errors.kms_access_denied_exception.KMSAccessDeniedException: <p>Lambda couldn't decrypt the environment variables because KMS access was denied. Check the Lambda function's KMS permissions.</p>
        capo_lambda.errors.kms_disabled_exception.KMSDisabledException: <p>Lambda couldn't decrypt the environment variables because the KMS key used is disabled. Check the Lambda function's KMS key settings.</p>
        capo_lambda.errors.kms_invalid_state_exception.KMSInvalidStateException: <p>Lambda couldn't decrypt the environment variables because the state of the KMS key used is not valid for Decrypt. Check the function's KMS key settings.</p>
        capo_lambda.errors.kms_not_found_exception.KMSNotFoundException: <p>Lambda couldn't decrypt the environment variables because the KMS key was not found. Check the function's KMS key settings.</p>
        capo_lambda.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource specified in the request does not exist.</p>
        capo_lambda.errors.service_exception.ServiceException: <p>The Lambda service encountered an internal error.</p>
        capo_lambda.errors.too_many_requests_exception.TooManyRequestsException: <p>The request throughput limit was exceeded. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html#api-requests">Lambda quotas</a>.</p>
        capo_lambda.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lambda.types.stop_durable_execution_request.StopDurableExecutionRequest]",
    ) -> OperationResponse[
        "capo_lambda.types.stop_durable_execution_response.StopDurableExecutionResponse"
    ]:
        import capo_lambda._operations.aws_gir_api_service.stop_durable_execution

        output, http_response = (
            capo_lambda._operations.aws_gir_api_service.stop_durable_execution.stop_durable_execution(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_lambda.types.stop_durable_execution_request.StopDurableExecutionRequest",
    ) -> dict[str, Any]:
        import capo_lambda.types.stop_durable_execution_request

        return capo_lambda.types.stop_durable_execution_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("StopDurableExecution", redact_input=_redact_input),
    )
    input_: capo_lambda.types.stop_durable_execution_request.StopDurableExecutionRequest = {
        "durable_execution_arn": durable_execution_arn
    }
    if error is not None:
        input_["error"] = error

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