Skip to content

cancel_recovery_plan_execution

cancel_recovery_plan_execution(
    recovery_plan_execution_arn: StrictDRSARN,
    *,
    config_overrides: Optional[drsClientConfig] = None,
) -> CancelRecoveryPlanExecutionResponse

Cancels an in-progress Recovery Plan execution. Remaining steps are skipped.

Parameters:

  • recovery_plan_execution_arn (StrictDRSARN) –

    The ARN of the Recovery Plan execution to cancel.

Raises:

Source code in docs_src/capo_drs/_services/drs.py
def cancel_recovery_plan_execution(
    self,
    recovery_plan_execution_arn: "capo_drs.types.strict_drsarn.StrictDRSARN",
    *,
    config_overrides: Optional[drsClientConfig] = None,
) -> "capo_drs.types.cancel_recovery_plan_execution_response.CancelRecoveryPlanExecutionResponse":
    """<p>Cancels an in-progress Recovery Plan execution. Remaining steps are skipped.</p>

    Args:
        recovery_plan_execution_arn: <p>The ARN of the Recovery Plan execution to cancel.</p>

    Raises:
        capo_drs.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_drs.errors.conflict_exception.ConflictException: <p>The request could not be completed due to a conflict with the current state of the target resource.</p>
        capo_drs.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_drs.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource for this operation was not found.</p>
        capo_drs.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_drs.errors.uninitialized_account_exception.UninitializedAccountException: <p>The account performing the request has not been initialized.</p>
        capo_drs.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the AWS service.</p>
        capo_drs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_drs.types.cancel_recovery_plan_execution_request.CancelRecoveryPlanExecutionRequest]",
    ) -> OperationResponse[
        "capo_drs.types.cancel_recovery_plan_execution_response.CancelRecoveryPlanExecutionResponse"
    ]:
        import capo_drs._operations.elastic_disaster_recovery_service.cancel_recovery_plan_execution

        output, http_response = (
            capo_drs._operations.elastic_disaster_recovery_service.cancel_recovery_plan_execution.cancel_recovery_plan_execution(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_drs.types.cancel_recovery_plan_execution_response.CancelRecoveryPlanExecutionResponse",
    ) -> dict[str, Any]:
        import capo_drs.types.cancel_recovery_plan_execution_response

        return (
            capo_drs.types.cancel_recovery_plan_execution_response.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CancelRecoveryPlanExecution", redact_output=_redact_output
        ),
    )
    input_: capo_drs.types.cancel_recovery_plan_execution_request.CancelRecoveryPlanExecutionRequest = {
        "recovery_plan_execution_arn": recovery_plan_execution_arn
    }

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