Backup / Client / get_backup_plan

get_backup_plan#

Backup.Client.get_backup_plan(**kwargs)#

Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.

Request Syntax

response = client.get_backup_plan(
    BackupPlanId='string',
    VersionId='string'
)

Parameters:

BackupPlanId (string) –
[REQUIRED]

Uniquely identifies a backup plan.
VersionId (string) – Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

Return type:

dict

Returns:

Response Syntax

{
    'BackupPlan': {
        'BackupPlanName': 'string',
        'Rules': [
            {
                'RuleName': 'string',
                'TargetBackupVaultName': 'string',
                'ScheduleExpression': 'string',
                'StartWindowMinutes': 123,
                'CompletionWindowMinutes': 123,
                'Lifecycle': {
                    'MoveToColdStorageAfterDays': 123,
                    'DeleteAfterDays': 123,
                    'OptInToArchiveForSupportedResources': True|False
                },
                'RecoveryPointTags': {
                    'string': 'string'
                },
                'RuleId': 'string',
                'CopyActions': [
                    {
                        'Lifecycle': {
                            'MoveToColdStorageAfterDays': 123,
                            'DeleteAfterDays': 123,
                            'OptInToArchiveForSupportedResources': True|False
                        },
                        'DestinationBackupVaultArn': 'string'
                    },
                ],
                'EnableContinuousBackup': True|False,
                'ScheduleExpressionTimezone': 'string',
                'IndexActions': [
                    {
                        'ResourceTypes': [
                            'string',
                        ]
                    },
                ]
            },
        ],
        'AdvancedBackupSettings': [
            {
                'ResourceType': 'string',
                'BackupOptions': {
                    'string': 'string'
                }
            },
        ]
    },
    'BackupPlanId': 'string',
    'BackupPlanArn': 'string',
    'VersionId': 'string',
    'CreatorRequestId': 'string',
    'CreationDate': datetime(2015, 1, 1),
    'DeletionDate': datetime(2015, 1, 1),
    'LastExecutionDate': datetime(2015, 1, 1),
    'AdvancedBackupSettings': [
        {
            'ResourceType': 'string',
            'BackupOptions': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

(dict) –
- BackupPlan (dict) –
  
  Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
  - BackupPlanName (string) –
    
    The display name of a backup plan. Must contain only alphanumeric or ‘-_.’ special characters.
    
    If this is set in the console, it can contain 1 to 50 characters; if this is set through CLI or API, it can contain 1 to 200 characters.
  - Rules (list) –
    
    An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
    - (dict) –
      
      Specifies a scheduled task used to back up a selection of resources.
      - RuleName (string) –
        
        A display name for a backup rule. Must contain 1 to 50 alphanumeric or ‘-_.’ characters.
      - TargetBackupVaultName (string) –
        
        The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
      - ScheduleExpression (string) –
        
        A cron expression in UTC specifying when Backup initiates a backup job. For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC). For a table of examples, click the preceding link and scroll down the page.
      - StartWindowMinutes (integer) –
        
        A value in minutes after a backup is scheduled before a job will be canceled if it doesn’t start successfully. This value is optional. If this value is included, it must be at least 60 minutes to avoid errors.
        
        During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).
      - CompletionWindowMinutes (integer) –
        
        A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.
      - Lifecycle (dict) –
        
        The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.
        
        Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
        
        Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
        
        MoveToColdStorageAfterDays (integer) –
        
        The number of days after creation that a recovery point is moved to cold storage.
        
        DeleteAfterDays (integer) –
        
        The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in MoveToColdStorageAfterDays.
        
        OptInToArchiveForSupportedResources (boolean) –
        
        If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
      - RecoveryPointTags (dict) –
        
        The tags that are assigned to resources that are associated with this rule when restored from backup.
        
        (string) –
        
        (string) –
      - RuleId (string) –
        
        Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
      - CopyActions (list) –
        
        An array of CopyAction objects, which contains the details of the copy operation.
        
        (dict) –
        
        The details of the copy operation.
        
        Lifecycle (dict) –
        
        Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted.
        
        Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can’t be changed after a backup has been transitioned to cold.
        
        Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
        
        To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for MoveToColdStorageAfterDays and DeleteAfterDays.
        
        MoveToColdStorageAfterDays (integer) –
        
        The number of days after creation that a recovery point is moved to cold storage.
        
        DeleteAfterDays (integer) –
        
        The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in MoveToColdStorageAfterDays.
        
        OptInToArchiveForSupportedResources (boolean) –
        
        If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
        
        DestinationBackupVaultArn (string) –
        
        An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
      - EnableContinuousBackup (boolean) –
        
        Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.
      - ScheduleExpressionTimezone (string) –
        
        The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
      - IndexActions (list) –
        
        IndexActions is an array you use to specify how backup data should be indexed.
        
        eEach BackupRule can have 0 or 1 IndexAction, as each backup can have up to one index associated with it.
        
        Within the array is ResourceType. Only one will be accepted for each BackupRule.
        
        (dict) –
        
        This is an optional array within a BackupRule.
        
        IndexAction consists of one ResourceTypes.
        
        ResourceTypes (list) –
        
        0 or 1 index action will be accepted for each BackupRule.
        
        Valid values:
        
        EBS for Amazon Elastic Block Store
        
        S3 for Amazon Simple Storage Service (Amazon S3)
        
        (string) –
  - AdvancedBackupSettings (list) –
    
    Contains a list of BackupOptions for each resource type.
    - (dict) –
      
      The backup options for each resource type.
      - ResourceType (string) –
        
        Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.
        
        Valid values: EC2.
      - BackupOptions (dict) –
        
        Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
        
        Valid values:
        
        Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.
        
        Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.
        
        If you specify an invalid option, you get an InvalidParameterValueException exception.
        
        For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.
        
        (string) –
        
        (string) –
- BackupPlanId (string) –
  
  Uniquely identifies a backup plan.
- BackupPlanArn (string) –
  
  An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
- VersionId (string) –
  
  Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
- CreatorRequestId (string) –
  
  A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
- CreationDate (datetime) –
  
  The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- DeletionDate (datetime) –
  
  The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- LastExecutionDate (datetime) –
  
  The last time this backup plan was run. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- AdvancedBackupSettings (list) –
  
  Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.
  - (dict) –
    
    The backup options for each resource type.
    - ResourceType (string) –
      
      Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.
      
      Valid values: EC2.
    - BackupOptions (dict) –
      
      Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
      
      Valid values:
      
      Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.
      
      Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.
      
      If you specify an invalid option, you get an InvalidParameterValueException exception.
      
      For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.
      - (string) –
        
        (string) –

Exceptions

Backup.Client.exceptions.ResourceNotFoundException
Backup.Client.exceptions.InvalidParameterValueException
Backup.Client.exceptions.MissingParameterValueException
Backup.Client.exceptions.ServiceUnavailableException