drs / Client / start_recovery_plan_execution

start_recovery_plan_execution¶

drs.Client.start_recovery_plan_execution(**kwargs)¶

Starts executing a Recovery Plan in DRILL or RECOVERY mode. A plan cannot have more than one execution in a non-terminal status at a time.

Request Syntax

response = client.start_recovery_plan_execution(
    recoveryPlanArn='string',
    mode='DRILL'|'RECOVERY',
    clientToken='string',
    sourceServers=[
        {
            'sourceServerID': 'string',
            'recoverySnapshotID': 'string'
        },
    ],
    tags={
        'string': 'string'
    }
)

Parameters:

recoveryPlanArn (string) –
[REQUIRED]

The ARN of the Recovery Plan to execute.
mode (string) –
[REQUIRED]

The execution mode ( DRILL or RECOVERY).
clientToken (string) –
A unique string provided to ensure request idempotency.

This field is autopopulated if not provided.
sourceServers (list) –
Optional list of source servers with specific recovery snapshots. If not provided, the latest snapshot is used for each server.
- (dict) –
  
  A source server with a specific recovery snapshot for plan execution.
  - sourceServerID (string) – [REQUIRED]
    
    The ID of the source server.
  - recoverySnapshotID (string) – [REQUIRED]
    
    The ID of the recovery snapshot to use.
tags (dict) –
The tags to apply to the Recovery Plan execution.
- (string) –
  - (string) –

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 started 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

drs.Client.exceptions.ResourceNotFoundException
drs.Client.exceptions.InternalServerException
drs.Client.exceptions.ConflictException
drs.Client.exceptions.ServiceQuotaExceededException
drs.Client.exceptions.ThrottlingException
drs.Client.exceptions.AccessDeniedException
drs.Client.exceptions.ValidationException
drs.Client.exceptions.UninitializedAccountException