drs / Client / list_recovery_plans

list_recovery_plans¶

drs.Client.list_recovery_plans(**kwargs)¶

Lists all Recovery Plans in the account.

Request Syntax

response = client.list_recovery_plans(
    maxResults=123,
    nextToken='string'
)

Parameters:

maxResults (integer) – Maximum number of results to return.
nextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'recoveryPlans': [
        {
            'recoveryPlanArn': 'string',
            'name': 'string',
            'status': 'ACTIVE'|'INVALID',
            'createdAt': 'string',
            'updatedAt': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- recoveryPlans (list) –
  
  The list of Recovery Plans.
  - (dict) –
    
    Summary information about a Recovery Plan.
    - recoveryPlanArn (string) –
      
      The ARN of the Recovery Plan.
    - name (string) –
      
      The name of a Recovery Plan.
    - status (string) –
      
      The status of the Recovery Plan.
    - createdAt (string) –
      
      The timestamp when the Recovery Plan was created.
    - updatedAt (string) –
      
      The timestamp when the Recovery Plan was last updated.
- 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