drs / Client / update_recovery_plan

update_recovery_plan¶

drs.Client.update_recovery_plan(**kwargs)¶

Updates a Recovery Plan’s name or description.

Request Syntax

response = client.update_recovery_plan(
    recoveryPlanArn='string',
    name='string',
    description='string'
)

Parameters:

recoveryPlanArn (string) –
[REQUIRED]

The ARN of the Recovery Plan to update.
name (string) – The name of a Recovery Plan.
description (string) – The description of a Recovery Plan.

Return type:

dict

Returns:

Response Syntax

{
    'recoveryPlan': {
        'recoveryPlanArn': 'string',
        'name': 'string',
        'description': 'string',
        'status': 'ACTIVE'|'INVALID',
        'createdAt': 'string',
        'updatedAt': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) –
- recoveryPlan (dict) –
  
  A Recovery Plan resource.
  - recoveryPlanArn (string) –
    
    The ARN of the Recovery Plan.
  - name (string) –
    
    The name of a Recovery Plan.
  - description (string) –
    
    The description 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.
  - tags (dict) –
    
    The tags associated with the Recovery Plan.
    - (string) –
      - (string) –

Exceptions

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