drs / Client / cancel_recovery_plan_execution

cancel_recovery_plan_execution

drs.Client.cancel_recovery_plan_execution(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.cancel_recovery_plan_execution(
    recoveryPlanExecutionArn='string'
)
Parameters:

recoveryPlanExecutionArn (string) –

[REQUIRED]

The ARN of the Recovery Plan execution to cancel.

Return type:

dict

Returns:

Response Syntax

{
    'recoveryPlanExecution': {
        'recoveryPlanExecutionArn': 'string',
        'recoveryPlanArn': 'string',
        'mode': 'DRILL'|'RECOVERY',
        'status': 'CREATED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED',
        'startedAt': 'string',
        'completedAt': 'string',
        'errorDetail': {
            'message': 'string',
            'code': 'string'
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • recoveryPlanExecution (dict) –

      The cancelled Recovery Plan execution.

      • recoveryPlanExecutionArn (string) –

        The ARN of the Recovery Plan execution.

      • recoveryPlanArn (string) –

        The ARN of the Recovery Plan being executed.

      • mode (string) –

        The execution mode.

      • status (string) –

        The execution status.

      • startedAt (string) –

        The timestamp when the execution started.

      • completedAt (string) –

        The timestamp when the execution completed.

      • errorDetail (dict) –

        Error details if the execution failed.

        • message (string) –

          The error message.

        • code (string) –

          The error code.

      • tags (dict) –

        The tags associated with the Recovery Plan execution.

        • (string) –

          • (string) –

Exceptions