drs / Client / list_recovery_plan_executions

list_recovery_plan_executions¶

drs.Client.list_recovery_plan_executions(**kwargs)¶

Lists executions of Recovery Plans, optionally filtered by plan or status.

Request Syntax

response = client.list_recovery_plan_executions(
    recoveryPlanArn='string',
    status='CREATED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED',
    maxResults=123,
    nextToken='string'
)

Parameters:

recoveryPlanArn (string) – Filter executions by Recovery Plan ARN.
status (string) – Filter executions by status.
maxResults (integer) – Maximum number of results to return.
nextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'recoveryPlanExecutions': [
        {
            'recoveryPlanExecutionArn': 'string',
            'recoveryPlanArn': 'string',
            'mode': 'DRILL'|'RECOVERY',
            'status': 'CREATED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELLING'|'CANCELLED',
            'startedAt': 'string',
            'errorDetail': {
                'message': 'string',
                'code': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- recoveryPlanExecutions (list) –
  
  The list of Recovery Plan executions.
  - (dict) –
    
    Summary information about a Recovery Plan execution.
    - recoveryPlanExecutionArn (string) –
      
      The ARN of the Recovery Plan execution.
    - recoveryPlanArn (string) –
      
      The ARN of the Recovery Plan.
    - mode (string) –
      
      The execution mode.
    - status (string) –
      
      The execution status.
    - startedAt (string) –
      
      The timestamp when the execution started.
    - errorDetail (dict) –
      
      Error details if the execution failed.
      - message (string) –
        
        The error message.
      - code (string) –
        
        The error code.
- nextToken (string) –
  
  The token for the next page of results.

Exceptions

drs.Client.exceptions.InternalServerException
drs.Client.exceptions.ThrottlingException
drs.Client.exceptions.AccessDeniedException
drs.Client.exceptions.ValidationException
drs.Client.exceptions.UninitializedAccountException