2025/11/17 - AWS Backup - 14 updated api methods
Changes AWS Backup now supports specifying a logically air-gapped backup vault as a primary backup target in backup plans and on-demand backup jobs.
{'BackupPlan': {'Rules': {'CopyActions': {'Lifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'}},
'Lifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'},
'TargetLogicallyAirGappedBackupVaultArn': 'string'}}}
Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks that create recovery points for resources.
If you call CreateBackupPlan with a plan that already exists, you receive an AlreadyExistsException exception.
See also: AWS API Documentation
Request Syntax
client.create_backup_plan(
BackupPlan={
'BackupPlanName': 'string',
'Rules': [
{
'RuleName': 'string',
'TargetBackupVaultName': 'string',
'TargetLogicallyAirGappedBackupVaultArn': 'string',
'ScheduleExpression': 'string',
'StartWindowMinutes': 123,
'CompletionWindowMinutes': 123,
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
},
'RecoveryPointTags': {
'string': 'string'
},
'CopyActions': [
{
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
},
'DestinationBackupVaultArn': 'string'
},
],
'EnableContinuousBackup': True|False,
'ScheduleExpressionTimezone': 'string',
'IndexActions': [
{
'ResourceTypes': [
'string',
]
},
]
},
],
'AdvancedBackupSettings': [
{
'ResourceType': 'string',
'BackupOptions': {
'string': 'string'
}
},
]
},
BackupPlanTags={
'string': 'string'
},
CreatorRequestId='string'
)
dict
[REQUIRED]
The body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
BackupPlanName (string) -- [REQUIRED]
The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
Rules (list) -- [REQUIRED]
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) -- [REQUIRED]
A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
TargetBackupVaultName (string) -- [REQUIRED]
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.
TargetLogicallyAirGappedBackupVaultArn (string) --
The ARN of a logically air-gapped vault. ARN must be in the same account and Region. If provided, supported fully managed resources back up directly to logically air-gapped vault, while other supported resources create a temporary (billable) snapshot in backup vault, then copy it to logically air-gapped vault. Unsupported resources only back up to the specified backup vault.
ScheduleExpression (string) --
A CRON expression in UTC specifying when Backup initiates a backup job. When no CRON expression is provided, Backup will use the default expression cron(0 5 ? * * *).
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.
This parameter has a maximum value of 100 years (52,560,000 minutes).
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 will transition and expire 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 storage.
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.
This parameter has a maximum value of 100 years (36,500 days).
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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
RecoveryPointTags (dict) --
The tags to assign to the resources.
(string) --
(string) --
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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
DestinationBackupVaultArn (string) -- [REQUIRED]
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) --
There can up to one IndexAction in each BackupRule, as each backup can have 0 or 1 backup index associated with it.
Within the array is ResourceTypes. Only 1 resource type will be accepted for each BackupRule. Valid values:
EBS for Amazon Elastic Block Store
S3 for Amazon Simple Storage Service (Amazon S3)
(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) --
Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
(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 available for Windows VSS backup jobs and S3 backups.
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.
For S3 backups, set to "S3BackupACLs":"disabled" to exclude ACLs from the backup, or "S3BackupObjectTags":"disabled" to exclude object tags from the backup. By default, both ACLs and object tags are included in S3 backups.
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) --
dict
The tags to assign to the backup plan.
(string) --
(string) --
string
Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
This field is autopopulated if not provided.
dict
Response Syntax
{
'BackupPlanId': 'string',
'BackupPlanArn': 'string',
'CreationDate': datetime(2015, 1, 1),
'VersionId': 'string',
'AdvancedBackupSettings': [
{
'ResourceType': 'string',
'BackupOptions': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
BackupPlanId (string) --
The ID of the 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.
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.
VersionId (string) --
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
AdvancedBackupSettings (list) --
The settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
(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 available for Windows VSS backup jobs and S3 backups.
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.
For S3 backups, set to "S3BackupACLs":"disabled" to exclude ACLs from the backup, or "S3BackupObjectTags":"disabled" to exclude object tags from the backup. By default, both ACLs and object tags are included in S3 backups.
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) --
{'RecoveryPointLifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'}}
Returns backup job details for the specified BackupJobId.
See also: AWS API Documentation
Request Syntax
client.describe_backup_job(
BackupJobId='string'
)
string
[REQUIRED]
Uniquely identifies a request to Backup to back up a resource.
dict
Response Syntax
{
'AccountId': 'string',
'BackupJobId': 'string',
'BackupVaultName': 'string',
'RecoveryPointLifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
},
'BackupVaultArn': 'string',
'VaultType': 'string',
'VaultLockState': 'string',
'RecoveryPointArn': 'string',
'EncryptionKeyArn': 'string',
'IsEncrypted': True|False,
'ResourceArn': 'string',
'CreationDate': datetime(2015, 1, 1),
'CompletionDate': datetime(2015, 1, 1),
'State': 'CREATED'|'PENDING'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETED'|'FAILED'|'EXPIRED'|'PARTIAL',
'StatusMessage': 'string',
'PercentDone': 'string',
'BackupSizeInBytes': 123,
'IamRoleArn': 'string',
'CreatedBy': {
'BackupPlanId': 'string',
'BackupPlanArn': 'string',
'BackupPlanName': 'string',
'BackupPlanVersion': 'string',
'BackupRuleId': 'string',
'BackupRuleName': 'string',
'BackupRuleCron': 'string',
'BackupRuleTimezone': 'string'
},
'ResourceType': 'string',
'BytesTransferred': 123,
'ExpectedCompletionDate': datetime(2015, 1, 1),
'StartBy': datetime(2015, 1, 1),
'BackupOptions': {
'string': 'string'
},
'BackupType': 'string',
'ParentJobId': 'string',
'IsParent': True|False,
'NumberOfChildJobs': 123,
'ChildJobsInState': {
'string': 123
},
'ResourceName': 'string',
'InitiationDate': datetime(2015, 1, 1),
'MessageCategory': 'string'
}
Response Structure
(dict) --
AccountId (string) --
Returns the account ID that owns the backup job.
BackupJobId (string) --
Uniquely identifies a request to Backup to back up a resource.
BackupVaultName (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.
RecoveryPointLifecycle (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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
BackupVaultArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
VaultType (string) --
The type of backup vault where the recovery point is stored. Valid values are BACKUP_VAULT for standard backup vaults and LOGICALLY_AIR_GAPPED_BACKUP_VAULT for logically air-gapped vaults.
VaultLockState (string) --
The lock state of the backup vault. For logically air-gapped vaults, this indicates whether the vault is locked in compliance mode. Valid values include LOCKED and UNLOCKED.
RecoveryPointArn (string) --
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
EncryptionKeyArn (string) --
The Amazon Resource Name (ARN) of the KMS key used to encrypt the backup. This can be a customer-managed key or an Amazon Web Services managed key, depending on the vault configuration.
IsEncrypted (boolean) --
A boolean value indicating whether the backup is encrypted. All backups in Backup are encrypted, but this field indicates the encryption status for transparency.
ResourceArn (string) --
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
CreationDate (datetime) --
The date and time that a backup job 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.
CompletionDate (datetime) --
The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
State (string) --
The current state of a backup job.
StatusMessage (string) --
A detailed message explaining the status of the job to back up a resource.
PercentDone (string) --
Contains an estimated percentage that is complete of a job at the time the job status was queried.
BackupSizeInBytes (integer) --
The size, in bytes, of a backup (recovery point).
This value can render differently depending on the resource type as Backup pulls in data information from other Amazon Web Services services. For example, the value returned may show a value of 0, which may differ from the anticipated value.
The expected behavior for values by resource type are described as follows:
Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have this value populate from the operation GetBackupJobStatus.
For Amazon DynamoDB with advanced features, this value refers to the size of the recovery point (backup).
Amazon EC2 and Amazon EBS show volume size (provisioned storage) returned as part of this value. Amazon EBS does not return backup size information; snapshot size will have the same value as the original resource that was backed up.
For Amazon EFS, this value refers to the delta bytes transferred during a backup.
Amazon FSx does not populate this value from the operation GetBackupJobStatus for FSx file systems.
An Amazon RDS instance will show as 0.
For virtual machines running VMware, this value is passed to Backup through an asynchronous workflow, which can mean this displayed value can under-represent the actual backup size.
IamRoleArn (string) --
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
CreatedBy (dict) --
Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.
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.
BackupPlanName (string) --
The name of the backup plan that created this recovery point. This provides human-readable context about which backup plan was responsible for the backup job.
BackupPlanVersion (string) --
Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
BackupRuleId (string) --
Uniquely identifies a rule used to schedule the backup of a selection of resources.
BackupRuleName (string) --
The name of the backup rule within the backup plan that created this recovery point. This helps identify which specific rule triggered the backup job.
BackupRuleCron (string) --
The cron expression that defines the schedule for the backup rule. This shows the frequency and timing of when backups are automatically triggered.
BackupRuleTimezone (string) --
The timezone used for the backup rule schedule. This provides context for when backups are scheduled to run in the specified timezone.
ResourceType (string) --
The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
BytesTransferred (integer) --
The size in bytes transferred to a backup vault at the time that the job status was queried.
ExpectedCompletionDate (datetime) --
The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
StartBy (datetime) --
Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
BackupOptions (dict) --
Represents the options specified as part of backup plan or on-demand backup job.
(string) --
(string) --
BackupType (string) --
Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type was a regular backup.
ParentJobId (string) --
This returns the parent (composite) resource backup job ID.
IsParent (boolean) --
This returns the boolean value that a backup job is a parent (composite) job.
NumberOfChildJobs (integer) --
This returns the number of child (nested) backup jobs.
ChildJobsInState (dict) --
This returns the statistics of the included child (nested) backup jobs.
(string) --
(integer) --
ResourceName (string) --
The non-unique name of the resource that belongs to the specified backup.
InitiationDate (datetime) --
The date a backup job was initiated.
MessageCategory (string) --
The job count for the specified message category.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.
{'CopyJob': {'CreatedByBackupJobId': 'string',
'DestinationRecoveryPointLifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'}}}
Returns metadata associated with creating a copy of a resource.
See also: AWS API Documentation
Request Syntax
client.describe_copy_job(
CopyJobId='string'
)
string
[REQUIRED]
Uniquely identifies a copy job.
dict
Response Syntax
{
'CopyJob': {
'AccountId': 'string',
'CopyJobId': 'string',
'SourceBackupVaultArn': 'string',
'SourceRecoveryPointArn': 'string',
'DestinationBackupVaultArn': 'string',
'DestinationVaultType': 'string',
'DestinationVaultLockState': 'string',
'DestinationRecoveryPointArn': 'string',
'DestinationEncryptionKeyArn': 'string',
'DestinationRecoveryPointLifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
},
'ResourceArn': 'string',
'CreationDate': datetime(2015, 1, 1),
'CompletionDate': datetime(2015, 1, 1),
'State': 'CREATED'|'RUNNING'|'COMPLETED'|'FAILED'|'PARTIAL',
'StatusMessage': 'string',
'BackupSizeInBytes': 123,
'IamRoleArn': 'string',
'CreatedBy': {
'BackupPlanId': 'string',
'BackupPlanArn': 'string',
'BackupPlanName': 'string',
'BackupPlanVersion': 'string',
'BackupRuleId': 'string',
'BackupRuleName': 'string',
'BackupRuleCron': 'string',
'BackupRuleTimezone': 'string'
},
'CreatedByBackupJobId': 'string',
'ResourceType': 'string',
'ParentJobId': 'string',
'IsParent': True|False,
'CompositeMemberIdentifier': 'string',
'NumberOfChildJobs': 123,
'ChildJobsInState': {
'string': 123
},
'ResourceName': 'string',
'MessageCategory': 'string'
}
}
Response Structure
(dict) --
CopyJob (dict) --
Contains detailed information about a copy job.
AccountId (string) --
The account ID that owns the copy job.
CopyJobId (string) --
Uniquely identifies a copy job.
SourceBackupVaultArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
SourceRecoveryPointArn (string) --
An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
DestinationBackupVaultArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
DestinationVaultType (string) --
The type of destination backup vault where the copied recovery point is stored. Valid values are BACKUP_VAULT for standard backup vaults and LOGICALLY_AIR_GAPPED_BACKUP_VAULT for logically air-gapped vaults.
DestinationVaultLockState (string) --
The lock state of the destination backup vault. For logically air-gapped vaults, this indicates whether the vault is locked in compliance mode. Valid values include LOCKED and UNLOCKED.
DestinationRecoveryPointArn (string) --
An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
DestinationEncryptionKeyArn (string) --
The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied backup in the destination vault. This can be a customer-managed key or an Amazon Web Services managed key.
DestinationRecoveryPointLifecycle (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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
ResourceArn (string) --
The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
CreationDate (datetime) --
The date and time a copy job 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.
CompletionDate (datetime) --
The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
State (string) --
The current state of a copy job.
StatusMessage (string) --
A detailed message explaining the status of the job to copy a resource.
BackupSizeInBytes (integer) --
The size, in bytes, of a copy job.
IamRoleArn (string) --
Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
CreatedBy (dict) --
Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.
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.
BackupPlanName (string) --
The name of the backup plan that created this recovery point. This provides human-readable context about which backup plan was responsible for the backup job.
BackupPlanVersion (string) --
Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
BackupRuleId (string) --
Uniquely identifies a rule used to schedule the backup of a selection of resources.
BackupRuleName (string) --
The name of the backup rule within the backup plan that created this recovery point. This helps identify which specific rule triggered the backup job.
BackupRuleCron (string) --
The cron expression that defines the schedule for the backup rule. This shows the frequency and timing of when backups are automatically triggered.
BackupRuleTimezone (string) --
The timezone used for the backup rule schedule. This provides context for when backups are scheduled to run in the specified timezone.
CreatedByBackupJobId (string) --
The backup job ID that initiated this copy job. Only applicable to scheduled copy jobs and automatic copy jobs to logically air-gapped vault.
ResourceType (string) --
The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
ParentJobId (string) --
This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.
IsParent (boolean) --
This is a boolean value indicating this is a parent (composite) copy job.
CompositeMemberIdentifier (string) --
The identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
NumberOfChildJobs (integer) --
The number of child (nested) copy jobs.
ChildJobsInState (dict) --
This returns the statistics of the included child (nested) copy jobs.
(string) --
(integer) --
ResourceName (string) --
The non-unique name of the resource that belongs to the specified backup.
MessageCategory (string) --
This parameter is the job count for the specified message category.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and InvalidParameters. See Monitoring for a list of MessageCategory strings.
The the value ANY returns count of all message categories.
AGGREGATE_ALL aggregates job counts for all message categories and returns the sum
{'Lifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'}}
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
See also: AWS API Documentation
Request Syntax
client.describe_recovery_point(
BackupVaultName='string',
RecoveryPointArn='string',
BackupVaultAccountId='string'
)
string
[REQUIRED]
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.
string
[REQUIRED]
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
string
The account ID of the specified backup vault.
dict
Response Syntax
{
'RecoveryPointArn': 'string',
'BackupVaultName': 'string',
'BackupVaultArn': 'string',
'SourceBackupVaultArn': 'string',
'ResourceArn': 'string',
'ResourceType': 'string',
'CreatedBy': {
'BackupPlanId': 'string',
'BackupPlanArn': 'string',
'BackupPlanName': 'string',
'BackupPlanVersion': 'string',
'BackupRuleId': 'string',
'BackupRuleName': 'string',
'BackupRuleCron': 'string',
'BackupRuleTimezone': 'string'
},
'IamRoleArn': 'string',
'Status': 'COMPLETED'|'PARTIAL'|'DELETING'|'EXPIRED'|'AVAILABLE'|'STOPPED'|'CREATING',
'StatusMessage': 'string',
'CreationDate': datetime(2015, 1, 1),
'InitiationDate': datetime(2015, 1, 1),
'CompletionDate': datetime(2015, 1, 1),
'BackupSizeInBytes': 123,
'CalculatedLifecycle': {
'MoveToColdStorageAt': datetime(2015, 1, 1),
'DeleteAt': datetime(2015, 1, 1)
},
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
},
'EncryptionKeyArn': 'string',
'IsEncrypted': True|False,
'StorageClass': 'WARM'|'COLD'|'DELETED',
'LastRestoreTime': datetime(2015, 1, 1),
'ParentRecoveryPointArn': 'string',
'CompositeMemberIdentifier': 'string',
'IsParent': True|False,
'ResourceName': 'string',
'VaultType': 'BACKUP_VAULT'|'LOGICALLY_AIR_GAPPED_BACKUP_VAULT'|'RESTORE_ACCESS_BACKUP_VAULT',
'IndexStatus': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING',
'IndexStatusMessage': 'string',
'EncryptionKeyType': 'AWS_OWNED_KMS_KEY'|'CUSTOMER_MANAGED_KMS_KEY'
}
Response Structure
(dict) --
RecoveryPointArn (string) --
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
BackupVaultName (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 Region where they are created.
BackupVaultArn (string) --
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
SourceBackupVaultArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will be null.
ResourceArn (string) --
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
ResourceType (string) --
The type of Amazon Web Services resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
CreatedBy (dict) --
Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
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.
BackupPlanName (string) --
The name of the backup plan that created this recovery point. This provides human-readable context about which backup plan was responsible for the backup job.
BackupPlanVersion (string) --
Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
BackupRuleId (string) --
Uniquely identifies a rule used to schedule the backup of a selection of resources.
BackupRuleName (string) --
The name of the backup rule within the backup plan that created this recovery point. This helps identify which specific rule triggered the backup job.
BackupRuleCron (string) --
The cron expression that defines the schedule for the backup rule. This shows the frequency and timing of when backups are automatically triggered.
BackupRuleTimezone (string) --
The timezone used for the backup rule schedule. This provides context for when backups are scheduled to run in the specified timezone.
IamRoleArn (string) --
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
Status (string) --
A status code specifying the state of the recovery point. For more information, see Recovery point status in the Backup Developer Guide.
CREATING status indicates that an Backup job has been initiated for a resource. The backup process has started and is actively processing a backup job for the associated recovery point.
AVAILABLE status indicates that the backup was successfully created for the recovery point. The backup process has completed without any issues, and the recovery point is now ready for use.
PARTIAL status indicates a composite recovery point has one or more nested recovery points that were not in the backup.
EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.
STOPPED status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup. For recovery points of Amazon S3, Amazon RDS, and Amazon Aurora resources, this status occurs when the retention period of a continuous backup rule is changed. To resolve STOPPED status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted. For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.
StatusMessage (string) --
A status message explaining the status of the recovery point.
CreationDate (datetime) --
The date and time that a recovery point 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.
InitiationDate (datetime) --
The date and time when the backup job that created this recovery point was initiated, in Unix format and Coordinated Universal Time (UTC).
CompletionDate (datetime) --
The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
BackupSizeInBytes (integer) --
The size, in bytes, of a backup.
CalculatedLifecycle (dict) --
A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
MoveToColdStorageAt (datetime) --
A timestamp that specifies when to transition a recovery point to cold storage.
DeleteAt (datetime) --
A timestamp that specifies when to delete a recovery point.
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 that are 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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
EncryptionKeyArn (string) --
The server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
IsEncrypted (boolean) --
A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.
StorageClass (string) --
Specifies the storage class of the recovery point. Valid values are WARM or COLD.
LastRestoreTime (datetime) --
The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
ParentRecoveryPointArn (string) --
This is an ARN that uniquely identifies a parent (composite) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
CompositeMemberIdentifier (string) --
The identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
IsParent (boolean) --
This returns the boolean value that a recovery point is a parent (composite) job.
ResourceName (string) --
The name of the resource that belongs to the specified backup.
VaultType (string) --
The type of vault in which the described recovery point is stored.
IndexStatus (string) --
This is the current status for the backup index associated with the specified recovery point.
Statuses are: PENDING | ACTIVE | FAILED | DELETING
A recovery point with an index that has the status of ACTIVE can be included in a search.
IndexStatusMessage (string) --
A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.
EncryptionKeyType (string) --
The type of encryption key used for the recovery point. Valid values are CUSTOMER_MANAGED_KMS_KEY for customer-managed keys or Amazon Web Services_OWNED_KMS_KEY for Amazon Web Services-owned keys.
{'BackupPlan': {'Rules': {'CopyActions': {'Lifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'}},
'Lifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'},
'TargetLogicallyAirGappedBackupVaultArn': 'string'}}}
Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.
See also: AWS API Documentation
Request Syntax
client.get_backup_plan(
BackupPlanId='string',
VersionId='string',
MaxScheduledRunsPreview=123
)
string
[REQUIRED]
Uniquely identifies a backup plan.
string
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
integer
Number of future scheduled backup runs to preview. When set to 0 (default), no scheduled runs preview is included in the response. Valid range is 0-10.
dict
Response Syntax
{
'BackupPlan': {
'BackupPlanName': 'string',
'Rules': [
{
'RuleName': 'string',
'TargetBackupVaultName': 'string',
'TargetLogicallyAirGappedBackupVaultArn': 'string',
'ScheduleExpression': 'string',
'StartWindowMinutes': 123,
'CompletionWindowMinutes': 123,
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
},
'RecoveryPointTags': {
'string': 'string'
},
'RuleId': 'string',
'CopyActions': [
{
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
},
'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'
}
},
],
'ScheduledRunsPreview': [
{
'ExecutionTime': datetime(2015, 1, 1),
'RuleId': 'string',
'RuleExecutionType': 'CONTINUOUS'|'SNAPSHOTS'|'CONTINUOUS_AND_SNAPSHOTS'
},
]
}
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.
TargetLogicallyAirGappedBackupVaultArn (string) --
The ARN of a logically air-gapped vault. ARN must be in the same account and Region. If provided, supported fully managed resources back up directly to logically air-gapped vault, while other supported resources create a temporary (billable) snapshot in backup vault, then copy it to logically air-gapped vault. Unsupported resources only back up to the specified backup vault.
ScheduleExpression (string) --
A cron expression in UTC specifying when Backup initiates a backup job. When no CRON expression is provided, Backup will use the default expression cron(0 5 ? * * *).
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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
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 available for Windows VSS backup jobs and S3 backups.
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.
For S3 backups, set to "S3BackupACLs":"disabled" to exclude ACLs from the backup, or "S3BackupObjectTags":"disabled" to exclude object tags from the backup. By default, both ACLs and object tags are included in S3 backups.
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 available for Windows VSS backup jobs and S3 backups.
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.
For S3 backups, set to "S3BackupACLs":"disabled" to exclude ACLs from the backup, or "S3BackupObjectTags":"disabled" to exclude object tags from the backup. By default, both ACLs and object tags are included in S3 backups.
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) --
ScheduledRunsPreview (list) --
List of upcoming scheduled backup runs. Only included when MaxScheduledRunsPreview parameter is greater than 0. Contains up to 10 future backup executions with their scheduled times, execution types, and associated rule IDs.
(dict) --
Contains information about a scheduled backup plan execution, including the execution time, rule type, and associated rule identifier.
ExecutionTime (datetime) --
The timestamp when the backup is scheduled to run, in Unix format and Coordinated Universal Time (UTC). The value is accurate to milliseconds.
RuleId (string) --
The unique identifier of the backup rule that will execute at the scheduled time.
RuleExecutionType (string) --
The type of backup rule execution. Valid values are CONTINUOUS (point-in-time recovery), SNAPSHOTS (snapshot backups), or CONTINUOUS_AND_SNAPSHOTS (both types combined).
{'BackupPlan': {'Rules': {'CopyActions': {'Lifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'}},
'Lifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'},
'TargetLogicallyAirGappedBackupVaultArn': 'string'}}}
Returns a valid JSON document specifying a backup plan or an error.
See also: AWS API Documentation
Request Syntax
client.get_backup_plan_from_json(
BackupPlanTemplateJson='string'
)
string
[REQUIRED]
A customer-supplied backup plan document in JSON format.
dict
Response Syntax
{
'BackupPlan': {
'BackupPlanName': 'string',
'Rules': [
{
'RuleName': 'string',
'TargetBackupVaultName': 'string',
'TargetLogicallyAirGappedBackupVaultArn': 'string',
'ScheduleExpression': 'string',
'StartWindowMinutes': 123,
'CompletionWindowMinutes': 123,
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
},
'RecoveryPointTags': {
'string': 'string'
},
'RuleId': 'string',
'CopyActions': [
{
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
},
'DestinationBackupVaultArn': 'string'
},
],
'EnableContinuousBackup': True|False,
'ScheduleExpressionTimezone': 'string',
'IndexActions': [
{
'ResourceTypes': [
'string',
]
},
]
},
],
'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.
TargetLogicallyAirGappedBackupVaultArn (string) --
The ARN of a logically air-gapped vault. ARN must be in the same account and Region. If provided, supported fully managed resources back up directly to logically air-gapped vault, while other supported resources create a temporary (billable) snapshot in backup vault, then copy it to logically air-gapped vault. Unsupported resources only back up to the specified backup vault.
ScheduleExpression (string) --
A cron expression in UTC specifying when Backup initiates a backup job. When no CRON expression is provided, Backup will use the default expression cron(0 5 ? * * *).
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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
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 available for Windows VSS backup jobs and S3 backups.
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.
For S3 backups, set to "S3BackupACLs":"disabled" to exclude ACLs from the backup, or "S3BackupObjectTags":"disabled" to exclude object tags from the backup. By default, both ACLs and object tags are included in S3 backups.
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) --
{'BackupPlanDocument': {'Rules': {'CopyActions': {'Lifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'}},
'Lifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'},
'TargetLogicallyAirGappedBackupVaultArn': 'string'}}}
Returns the template specified by its templateId as a backup plan.
See also: AWS API Documentation
Request Syntax
client.get_backup_plan_from_template(
BackupPlanTemplateId='string'
)
string
[REQUIRED]
Uniquely identifies a stored backup plan template.
dict
Response Syntax
{
'BackupPlanDocument': {
'BackupPlanName': 'string',
'Rules': [
{
'RuleName': 'string',
'TargetBackupVaultName': 'string',
'TargetLogicallyAirGappedBackupVaultArn': 'string',
'ScheduleExpression': 'string',
'StartWindowMinutes': 123,
'CompletionWindowMinutes': 123,
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
},
'RecoveryPointTags': {
'string': 'string'
},
'RuleId': 'string',
'CopyActions': [
{
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
},
'DestinationBackupVaultArn': 'string'
},
],
'EnableContinuousBackup': True|False,
'ScheduleExpressionTimezone': 'string',
'IndexActions': [
{
'ResourceTypes': [
'string',
]
},
]
},
],
'AdvancedBackupSettings': [
{
'ResourceType': 'string',
'BackupOptions': {
'string': 'string'
}
},
]
}
}
Response Structure
(dict) --
BackupPlanDocument (dict) --
Returns the body of a backup plan based on the target template, including the name, rules, and backup vault of the plan.
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.
TargetLogicallyAirGappedBackupVaultArn (string) --
The ARN of a logically air-gapped vault. ARN must be in the same account and Region. If provided, supported fully managed resources back up directly to logically air-gapped vault, while other supported resources create a temporary (billable) snapshot in backup vault, then copy it to logically air-gapped vault. Unsupported resources only back up to the specified backup vault.
ScheduleExpression (string) --
A cron expression in UTC specifying when Backup initiates a backup job. When no CRON expression is provided, Backup will use the default expression cron(0 5 ? * * *).
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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
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 available for Windows VSS backup jobs and S3 backups.
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.
For S3 backups, set to "S3BackupACLs":"disabled" to exclude ACLs from the backup, or "S3BackupObjectTags":"disabled" to exclude object tags from the backup. By default, both ACLs and object tags are included in S3 backups.
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) --
{'BackupJobs': {'RecoveryPointLifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'}}}
Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.
See also: AWS API Documentation
Request Syntax
client.list_backup_jobs(
NextToken='string',
MaxResults=123,
ByResourceArn='string',
ByState='CREATED'|'PENDING'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETED'|'FAILED'|'EXPIRED'|'PARTIAL',
ByBackupVaultName='string',
ByCreatedBefore=datetime(2015, 1, 1),
ByCreatedAfter=datetime(2015, 1, 1),
ByResourceType='string',
ByAccountId='string',
ByCompleteAfter=datetime(2015, 1, 1),
ByCompleteBefore=datetime(2015, 1, 1),
ByParentJobId='string',
ByMessageCategory='string'
)
string
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
integer
The maximum number of items to be returned.
string
Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
string
Returns only backup jobs that are in the specified state.
Completed with issues is a status found only in the Backup console. For API, this status refers to jobs with a state of COMPLETED and a MessageCategory with a value other than SUCCESS; that is, the status is completed but comes with a status message.
To obtain the job count for Completed with issues, run two GET requests, and subtract the second, smaller number:
GET /backup-jobs/?state=COMPLETED
GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
string
Returns only backup jobs that will be stored in the specified backup vault. 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.
datetime
Returns only backup jobs that were created before the specified date.
datetime
Returns only backup jobs that were created after the specified date.
string
Returns only backup jobs for the specified resources:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Redshift for Amazon Redshift
S3 for Amazon Simple Storage Service (Amazon S3)
SAP HANA on Amazon EC2 for SAP HANA databases on Amazon Elastic Compute Cloud instances
Storage Gateway for Storage Gateway
Timestream for Amazon Timestream
VirtualMachine for VMware virtual machines
string
The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.
If used from an Organizations management account, passing * returns all jobs across the organization.
datetime
Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
datetime
Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
string
This is a filter to list child (nested) jobs based on parent job ID.
string
This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and InvalidParameters.
View Monitoring
The wildcard () returns count of all message categories.
AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
dict
Response Syntax
{
'BackupJobs': [
{
'AccountId': 'string',
'BackupJobId': 'string',
'BackupVaultName': 'string',
'BackupVaultArn': 'string',
'VaultType': 'string',
'VaultLockState': 'string',
'RecoveryPointArn': 'string',
'RecoveryPointLifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
},
'EncryptionKeyArn': 'string',
'IsEncrypted': True|False,
'ResourceArn': 'string',
'CreationDate': datetime(2015, 1, 1),
'CompletionDate': datetime(2015, 1, 1),
'State': 'CREATED'|'PENDING'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETED'|'FAILED'|'EXPIRED'|'PARTIAL',
'StatusMessage': 'string',
'PercentDone': 'string',
'BackupSizeInBytes': 123,
'IamRoleArn': 'string',
'CreatedBy': {
'BackupPlanId': 'string',
'BackupPlanArn': 'string',
'BackupPlanName': 'string',
'BackupPlanVersion': 'string',
'BackupRuleId': 'string',
'BackupRuleName': 'string',
'BackupRuleCron': 'string',
'BackupRuleTimezone': 'string'
},
'ExpectedCompletionDate': datetime(2015, 1, 1),
'StartBy': datetime(2015, 1, 1),
'ResourceType': 'string',
'BytesTransferred': 123,
'BackupOptions': {
'string': 'string'
},
'BackupType': 'string',
'ParentJobId': 'string',
'IsParent': True|False,
'ResourceName': 'string',
'InitiationDate': datetime(2015, 1, 1),
'MessageCategory': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
BackupJobs (list) --
An array of structures containing metadata about your backup jobs returned in JSON format.
(dict) --
Contains detailed information about a backup job.
AccountId (string) --
The account ID that owns the backup job.
BackupJobId (string) --
Uniquely identifies a request to Backup to back up a resource.
BackupVaultName (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.
BackupVaultArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
VaultType (string) --
The type of backup vault where the recovery point is stored. Valid values are BACKUP_VAULT for standard backup vaults and LOGICALLY_AIR_GAPPED_BACKUP_VAULT for logically air-gapped vaults.
VaultLockState (string) --
The lock state of the backup vault. For logically air-gapped vaults, this indicates whether the vault is locked in compliance mode. Valid values include LOCKED and UNLOCKED.
RecoveryPointArn (string) --
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
RecoveryPointLifecycle (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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
EncryptionKeyArn (string) --
The Amazon Resource Name (ARN) of the KMS key used to encrypt the backup. This can be a customer-managed key or an Amazon Web Services managed key, depending on the vault configuration.
IsEncrypted (boolean) --
A boolean value indicating whether the backup is encrypted. All backups in Backup are encrypted, but this field indicates the encryption status for transparency.
ResourceArn (string) --
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
CreationDate (datetime) --
The date and time a backup job 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.
CompletionDate (datetime) --
The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
State (string) --
The current state of a backup job.
StatusMessage (string) --
A detailed message explaining the status of the job to back up a resource.
PercentDone (string) --
Contains an estimated percentage complete of a job at the time the job status was queried.
BackupSizeInBytes (integer) --
The size, in bytes, of a backup (recovery point).
This value can render differently depending on the resource type as Backup pulls in data information from other Amazon Web Services services. For example, the value returned may show a value of 0, which may differ from the anticipated value.
The expected behavior for values by resource type are described as follows:
Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have this value populate from the operation GetBackupJobStatus.
For Amazon DynamoDB with advanced features, this value refers to the size of the recovery point (backup).
Amazon EC2 and Amazon EBS show volume size (provisioned storage) returned as part of this value. Amazon EBS does not return backup size information; snapshot size will have the same value as the original resource that was backed up.
For Amazon EFS, this value refers to the delta bytes transferred during a backup.
Amazon FSx does not populate this value from the operation GetBackupJobStatus for FSx file systems.
An Amazon RDS instance will show as 0.
For virtual machines running VMware, this value is passed to Backup through an asynchronous workflow, which can mean this displayed value can under-represent the actual backup size.
IamRoleArn (string) --
Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.
CreatedBy (dict) --
Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
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.
BackupPlanName (string) --
The name of the backup plan that created this recovery point. This provides human-readable context about which backup plan was responsible for the backup job.
BackupPlanVersion (string) --
Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
BackupRuleId (string) --
Uniquely identifies a rule used to schedule the backup of a selection of resources.
BackupRuleName (string) --
The name of the backup rule within the backup plan that created this recovery point. This helps identify which specific rule triggered the backup job.
BackupRuleCron (string) --
The cron expression that defines the schedule for the backup rule. This shows the frequency and timing of when backups are automatically triggered.
BackupRuleTimezone (string) --
The timezone used for the backup rule schedule. This provides context for when backups are scheduled to run in the specified timezone.
ExpectedCompletionDate (datetime) --
The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
StartBy (datetime) --
Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
ResourceType (string) --
The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
BytesTransferred (integer) --
The size in bytes transferred to a backup vault at the time that the job status was queried.
BackupOptions (dict) --
Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (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. If you specify an invalid option, you get an InvalidParameterValueException exception.
(string) --
(string) --
BackupType (string) --
Represents the type of backup for a backup job.
ParentJobId (string) --
This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.
IsParent (boolean) --
This is a boolean value indicating this is a parent (composite) backup job.
ResourceName (string) --
The non-unique name of the resource that belongs to the specified backup.
InitiationDate (datetime) --
The date on which the backup job was initiated.
MessageCategory (string) --
This parameter is the job count for the specified message category.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. See Monitoring for a list of MessageCategory strings.
The the value ANY returns count of all message categories.
AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
NextToken (string) --
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
{'BySourceRecoveryPointArn': 'string'}
Response {'CopyJobs': {'CreatedByBackupJobId': 'string',
'DestinationRecoveryPointLifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'}}}
Returns metadata about your copy jobs.
See also: AWS API Documentation
Request Syntax
client.list_copy_jobs(
NextToken='string',
MaxResults=123,
ByResourceArn='string',
ByState='CREATED'|'RUNNING'|'COMPLETED'|'FAILED'|'PARTIAL',
ByCreatedBefore=datetime(2015, 1, 1),
ByCreatedAfter=datetime(2015, 1, 1),
ByResourceType='string',
ByDestinationVaultArn='string',
ByAccountId='string',
ByCompleteBefore=datetime(2015, 1, 1),
ByCompleteAfter=datetime(2015, 1, 1),
ByParentJobId='string',
ByMessageCategory='string',
BySourceRecoveryPointArn='string'
)
string
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
integer
The maximum number of items to be returned.
string
Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
string
Returns only copy jobs that are in the specified state.
datetime
Returns only copy jobs that were created before the specified date.
datetime
Returns only copy jobs that were created after the specified date.
string
Returns only backup jobs for the specified resources:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Redshift for Amazon Redshift
S3 for Amazon Simple Storage Service (Amazon S3)
SAP HANA on Amazon EC2 for SAP HANA databases on Amazon Elastic Compute Cloud instances
Storage Gateway for Storage Gateway
Timestream for Amazon Timestream
VirtualMachine for VMware virtual machines
string
An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
string
The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.
datetime
Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
datetime
Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
string
This is a filter to list child (nested) jobs based on parent job ID.
string
This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS.
View Monitoring for a list of accepted strings.
The the value ANY returns count of all message categories.
AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
string
Filters copy jobs by the specified source recovery point ARN.
dict
Response Syntax
{
'CopyJobs': [
{
'AccountId': 'string',
'CopyJobId': 'string',
'SourceBackupVaultArn': 'string',
'SourceRecoveryPointArn': 'string',
'DestinationBackupVaultArn': 'string',
'DestinationVaultType': 'string',
'DestinationVaultLockState': 'string',
'DestinationRecoveryPointArn': 'string',
'DestinationEncryptionKeyArn': 'string',
'DestinationRecoveryPointLifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
},
'ResourceArn': 'string',
'CreationDate': datetime(2015, 1, 1),
'CompletionDate': datetime(2015, 1, 1),
'State': 'CREATED'|'RUNNING'|'COMPLETED'|'FAILED'|'PARTIAL',
'StatusMessage': 'string',
'BackupSizeInBytes': 123,
'IamRoleArn': 'string',
'CreatedBy': {
'BackupPlanId': 'string',
'BackupPlanArn': 'string',
'BackupPlanName': 'string',
'BackupPlanVersion': 'string',
'BackupRuleId': 'string',
'BackupRuleName': 'string',
'BackupRuleCron': 'string',
'BackupRuleTimezone': 'string'
},
'CreatedByBackupJobId': 'string',
'ResourceType': 'string',
'ParentJobId': 'string',
'IsParent': True|False,
'CompositeMemberIdentifier': 'string',
'NumberOfChildJobs': 123,
'ChildJobsInState': {
'string': 123
},
'ResourceName': 'string',
'MessageCategory': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CopyJobs (list) --
An array of structures containing metadata about your copy jobs returned in JSON format.
(dict) --
Contains detailed information about a copy job.
AccountId (string) --
The account ID that owns the copy job.
CopyJobId (string) --
Uniquely identifies a copy job.
SourceBackupVaultArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
SourceRecoveryPointArn (string) --
An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
DestinationBackupVaultArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
DestinationVaultType (string) --
The type of destination backup vault where the copied recovery point is stored. Valid values are BACKUP_VAULT for standard backup vaults and LOGICALLY_AIR_GAPPED_BACKUP_VAULT for logically air-gapped vaults.
DestinationVaultLockState (string) --
The lock state of the destination backup vault. For logically air-gapped vaults, this indicates whether the vault is locked in compliance mode. Valid values include LOCKED and UNLOCKED.
DestinationRecoveryPointArn (string) --
An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
DestinationEncryptionKeyArn (string) --
The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied backup in the destination vault. This can be a customer-managed key or an Amazon Web Services managed key.
DestinationRecoveryPointLifecycle (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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
ResourceArn (string) --
The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
CreationDate (datetime) --
The date and time a copy job 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.
CompletionDate (datetime) --
The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
State (string) --
The current state of a copy job.
StatusMessage (string) --
A detailed message explaining the status of the job to copy a resource.
BackupSizeInBytes (integer) --
The size, in bytes, of a copy job.
IamRoleArn (string) --
Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
CreatedBy (dict) --
Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.
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.
BackupPlanName (string) --
The name of the backup plan that created this recovery point. This provides human-readable context about which backup plan was responsible for the backup job.
BackupPlanVersion (string) --
Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
BackupRuleId (string) --
Uniquely identifies a rule used to schedule the backup of a selection of resources.
BackupRuleName (string) --
The name of the backup rule within the backup plan that created this recovery point. This helps identify which specific rule triggered the backup job.
BackupRuleCron (string) --
The cron expression that defines the schedule for the backup rule. This shows the frequency and timing of when backups are automatically triggered.
BackupRuleTimezone (string) --
The timezone used for the backup rule schedule. This provides context for when backups are scheduled to run in the specified timezone.
CreatedByBackupJobId (string) --
The backup job ID that initiated this copy job. Only applicable to scheduled copy jobs and automatic copy jobs to logically air-gapped vault.
ResourceType (string) --
The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
ParentJobId (string) --
This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.
IsParent (boolean) --
This is a boolean value indicating this is a parent (composite) copy job.
CompositeMemberIdentifier (string) --
The identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
NumberOfChildJobs (integer) --
The number of child (nested) copy jobs.
ChildJobsInState (dict) --
This returns the statistics of the included child (nested) copy jobs.
(string) --
(integer) --
ResourceName (string) --
The non-unique name of the resource that belongs to the specified backup.
MessageCategory (string) --
This parameter is the job count for the specified message category.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and InvalidParameters. See Monitoring for a list of MessageCategory strings.
The the value ANY returns count of all message categories.
AGGREGATE_ALL aggregates job counts for all message categories and returns the sum
NextToken (string) --
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
{'RecoveryPoints': {'Lifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'}}}
Returns detailed information about the recovery points stored in a backup vault.
See also: AWS API Documentation
Request Syntax
client.list_recovery_points_by_backup_vault(
BackupVaultName='string',
BackupVaultAccountId='string',
NextToken='string',
MaxResults=123,
ByResourceArn='string',
ByResourceType='string',
ByBackupPlanId='string',
ByCreatedBefore=datetime(2015, 1, 1),
ByCreatedAfter=datetime(2015, 1, 1),
ByParentRecoveryPointArn='string'
)
string
[REQUIRED]
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.
string
This parameter will sort the list of recovery points by account ID.
string
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
integer
The maximum number of items to be returned.
string
Returns only recovery points that match the specified resource Amazon Resource Name (ARN).
string
Returns only recovery points that match the specified resource type(s):
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Redshift for Amazon Redshift
S3 for Amazon Simple Storage Service (Amazon S3)
SAP HANA on Amazon EC2 for SAP HANA databases on Amazon Elastic Compute Cloud instances
Storage Gateway for Storage Gateway
Timestream for Amazon Timestream
VirtualMachine for VMware virtual machines
string
Returns only recovery points that match the specified backup plan ID.
datetime
Returns only recovery points that were created before the specified timestamp.
datetime
Returns only recovery points that were created after the specified timestamp.
string
This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).
dict
Response Syntax
{
'NextToken': 'string',
'RecoveryPoints': [
{
'RecoveryPointArn': 'string',
'BackupVaultName': 'string',
'BackupVaultArn': 'string',
'SourceBackupVaultArn': 'string',
'ResourceArn': 'string',
'ResourceType': 'string',
'CreatedBy': {
'BackupPlanId': 'string',
'BackupPlanArn': 'string',
'BackupPlanName': 'string',
'BackupPlanVersion': 'string',
'BackupRuleId': 'string',
'BackupRuleName': 'string',
'BackupRuleCron': 'string',
'BackupRuleTimezone': 'string'
},
'IamRoleArn': 'string',
'Status': 'COMPLETED'|'PARTIAL'|'DELETING'|'EXPIRED'|'AVAILABLE'|'STOPPED'|'CREATING',
'StatusMessage': 'string',
'CreationDate': datetime(2015, 1, 1),
'InitiationDate': datetime(2015, 1, 1),
'CompletionDate': datetime(2015, 1, 1),
'BackupSizeInBytes': 123,
'CalculatedLifecycle': {
'MoveToColdStorageAt': datetime(2015, 1, 1),
'DeleteAt': datetime(2015, 1, 1)
},
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
},
'EncryptionKeyArn': 'string',
'IsEncrypted': True|False,
'LastRestoreTime': datetime(2015, 1, 1),
'ParentRecoveryPointArn': 'string',
'CompositeMemberIdentifier': 'string',
'IsParent': True|False,
'ResourceName': 'string',
'VaultType': 'BACKUP_VAULT'|'LOGICALLY_AIR_GAPPED_BACKUP_VAULT'|'RESTORE_ACCESS_BACKUP_VAULT',
'IndexStatus': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING',
'IndexStatusMessage': 'string',
'EncryptionKeyType': 'AWS_OWNED_KMS_KEY'|'CUSTOMER_MANAGED_KMS_KEY'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
RecoveryPoints (list) --
An array of objects that contain detailed information about recovery points saved in a backup vault.
(dict) --
Contains detailed information about the recovery points stored in a backup vault.
RecoveryPointArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
BackupVaultName (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.
BackupVaultArn (string) --
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
SourceBackupVaultArn (string) --
The backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account this value will be null.
ResourceArn (string) --
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
ResourceType (string) --
The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
CreatedBy (dict) --
Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.
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.
BackupPlanName (string) --
The name of the backup plan that created this recovery point. This provides human-readable context about which backup plan was responsible for the backup job.
BackupPlanVersion (string) --
Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
BackupRuleId (string) --
Uniquely identifies a rule used to schedule the backup of a selection of resources.
BackupRuleName (string) --
The name of the backup rule within the backup plan that created this recovery point. This helps identify which specific rule triggered the backup job.
BackupRuleCron (string) --
The cron expression that defines the schedule for the backup rule. This shows the frequency and timing of when backups are automatically triggered.
BackupRuleTimezone (string) --
The timezone used for the backup rule schedule. This provides context for when backups are scheduled to run in the specified timezone.
IamRoleArn (string) --
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
Status (string) --
A status code specifying the state of the recovery point.
StatusMessage (string) --
A message explaining the current status of the recovery point.
CreationDate (datetime) --
The date and time a recovery point 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.
InitiationDate (datetime) --
The date and time when the backup job that created this recovery point was initiated, in Unix format and Coordinated Universal Time (UTC).
CompletionDate (datetime) --
The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
BackupSizeInBytes (integer) --
The size, in bytes, of a backup.
CalculatedLifecycle (dict) --
A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
MoveToColdStorageAt (datetime) --
A timestamp that specifies when to transition a recovery point to cold storage.
DeleteAt (datetime) --
A timestamp that specifies when to delete a recovery point.
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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
EncryptionKeyArn (string) --
The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
IsEncrypted (boolean) --
A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.
LastRestoreTime (datetime) --
The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
ParentRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the parent (composite) recovery point.
CompositeMemberIdentifier (string) --
The identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
IsParent (boolean) --
This is a boolean value indicating this is a parent (composite) recovery point.
ResourceName (string) --
The non-unique name of the resource that belongs to the specified backup.
VaultType (string) --
The type of vault in which the described recovery point is stored.
IndexStatus (string) --
This is the current status for the backup index associated with the specified recovery point.
Statuses are: PENDING | ACTIVE | FAILED | DELETING
A recovery point with an index that has the status of ACTIVE can be included in a search.
IndexStatusMessage (string) --
A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.
EncryptionKeyType (string) --
The type of encryption key used for the recovery point. Valid values are CUSTOMER_MANAGED_KMS_KEY for customer-managed keys or Amazon Web Services_OWNED_KMS_KEY for Amazon Web Services-owned keys.
{'Lifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'},
'LogicallyAirGappedBackupVaultArn': 'string'}
Starts an on-demand backup job for the specified resource.
See also: AWS API Documentation
Request Syntax
client.start_backup_job(
BackupVaultName='string',
LogicallyAirGappedBackupVaultArn='string',
ResourceArn='string',
IamRoleArn='string',
IdempotencyToken='string',
StartWindowMinutes=123,
CompleteWindowMinutes=123,
Lifecycle={
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
},
RecoveryPointTags={
'string': 'string'
},
BackupOptions={
'string': 'string'
},
Index='ENABLED'|'DISABLED'
)
string
[REQUIRED]
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.
string
The ARN of a logically air-gapped vault. ARN must be in the same account and Region. If provided, supported fully managed resources back up directly to logically air-gapped vault, while other supported resources create a temporary (billable) snapshot in backup vault, then copy it to logically air-gapped vault. Unsupported resources only back up to the specified backup vault.
string
[REQUIRED]
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
string
[REQUIRED]
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
string
A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.
This field is autopopulated if not provided.
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, and the default is 8 hours. If this value is included, it must be at least 60 minutes to avoid errors.
This parameter has a maximum value of 100 years (52,560,000 minutes).
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).
integer
A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.
Like StartWindowMinutes, this parameter has a maximum value of 100 years (52,560,000 minutes).
dict
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire 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.
This parameter has a maximum value of 100 years (36,500 days).
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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
dict
The tags to assign to the resources.
(string) --
(string) --
dict
The backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (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.
(string) --
(string) --
string
Include this parameter to enable index creation if your backup job has a resource type that supports backup indexes.
Resource types that support backup indexes include:
EBS for Amazon Elastic Block Store
S3 for Amazon Simple Storage Service (Amazon S3)
Index can have 1 of 2 possible values, either ENABLED or DISABLED.
To create a backup index for an eligible ACTIVE recovery point that does not yet have a backup index, set value to ENABLED.
To delete a backup index, set value to DISABLED.
dict
Response Syntax
{
'BackupJobId': 'string',
'RecoveryPointArn': 'string',
'CreationDate': datetime(2015, 1, 1),
'IsParent': True|False
}
Response Structure
(dict) --
BackupJobId (string) --
Uniquely identifies a request to Backup to back up a resource.
RecoveryPointArn (string) --
Note: This field is only returned for Amazon EFS and Advanced DynamoDB resources.
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
CreationDate (datetime) --
The date and time that a backup job 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.
IsParent (boolean) --
This is a returned boolean value indicating this is a parent (composite) backup job.
{'Lifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'}}
Starts a job to create a one-time copy of the specified resource.
Does not support continuous backups.
See Copy job retry for information on how Backup retries copy job operations.
See also: AWS API Documentation
Request Syntax
client.start_copy_job(
RecoveryPointArn='string',
SourceBackupVaultName='string',
DestinationBackupVaultArn='string',
IamRoleArn='string',
IdempotencyToken='string',
Lifecycle={
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
}
)
string
[REQUIRED]
An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
string
[REQUIRED]
The name of a logical source 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.
string
[REQUIRED]
An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
string
[REQUIRED]
Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
string
A customer-chosen string that you can use to distinguish between otherwise identical calls to StartCopyJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.
This field is autopopulated if not provided.
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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
dict
Response Syntax
{
'CopyJobId': 'string',
'CreationDate': datetime(2015, 1, 1),
'IsParent': True|False
}
Response Structure
(dict) --
CopyJobId (string) --
Uniquely identifies a copy job.
CreationDate (datetime) --
The date and time that a copy job 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.
IsParent (boolean) --
This is a returned boolean value indicating this is a parent (composite) copy job.
{'BackupPlan': {'Rules': {'CopyActions': {'Lifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'}},
'Lifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'},
'TargetLogicallyAirGappedBackupVaultArn': 'string'}}}
Updates the specified backup plan. The new version is uniquely identified by its ID.
See also: AWS API Documentation
Request Syntax
client.update_backup_plan(
BackupPlanId='string',
BackupPlan={
'BackupPlanName': 'string',
'Rules': [
{
'RuleName': 'string',
'TargetBackupVaultName': 'string',
'TargetLogicallyAirGappedBackupVaultArn': 'string',
'ScheduleExpression': 'string',
'StartWindowMinutes': 123,
'CompletionWindowMinutes': 123,
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
},
'RecoveryPointTags': {
'string': 'string'
},
'CopyActions': [
{
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
},
'DestinationBackupVaultArn': 'string'
},
],
'EnableContinuousBackup': True|False,
'ScheduleExpressionTimezone': 'string',
'IndexActions': [
{
'ResourceTypes': [
'string',
]
},
]
},
],
'AdvancedBackupSettings': [
{
'ResourceType': 'string',
'BackupOptions': {
'string': 'string'
}
},
]
}
)
string
[REQUIRED]
The ID of the backup plan.
dict
[REQUIRED]
The body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
BackupPlanName (string) -- [REQUIRED]
The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
Rules (list) -- [REQUIRED]
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) -- [REQUIRED]
A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
TargetBackupVaultName (string) -- [REQUIRED]
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.
TargetLogicallyAirGappedBackupVaultArn (string) --
The ARN of a logically air-gapped vault. ARN must be in the same account and Region. If provided, supported fully managed resources back up directly to logically air-gapped vault, while other supported resources create a temporary (billable) snapshot in backup vault, then copy it to logically air-gapped vault. Unsupported resources only back up to the specified backup vault.
ScheduleExpression (string) --
A CRON expression in UTC specifying when Backup initiates a backup job. When no CRON expression is provided, Backup will use the default expression cron(0 5 ? * * *).
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.
This parameter has a maximum value of 100 years (52,560,000 minutes).
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 will transition and expire 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 storage.
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.
This parameter has a maximum value of 100 years (36,500 days).
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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
RecoveryPointTags (dict) --
The tags to assign to the resources.
(string) --
(string) --
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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
DestinationBackupVaultArn (string) -- [REQUIRED]
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) --
There can up to one IndexAction in each BackupRule, as each backup can have 0 or 1 backup index associated with it.
Within the array is ResourceTypes. Only 1 resource type will be accepted for each BackupRule. Valid values:
EBS for Amazon Elastic Block Store
S3 for Amazon Simple Storage Service (Amazon S3)
(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) --
Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
(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 available for Windows VSS backup jobs and S3 backups.
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.
For S3 backups, set to "S3BackupACLs":"disabled" to exclude ACLs from the backup, or "S3BackupObjectTags":"disabled" to exclude object tags from the backup. By default, both ACLs and object tags are included in S3 backups.
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) --
dict
Response Syntax
{
'BackupPlanId': 'string',
'BackupPlanArn': 'string',
'CreationDate': datetime(2015, 1, 1),
'VersionId': 'string',
'AdvancedBackupSettings': [
{
'ResourceType': 'string',
'BackupOptions': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
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.
CreationDate (datetime) --
The date and time 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.
VersionId (string) --
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.
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 available for Windows VSS backup jobs and S3 backups.
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.
For S3 backups, set to "S3BackupACLs":"disabled" to exclude ACLs from the backup, or "S3BackupObjectTags":"disabled" to exclude object tags from the backup. By default, both ACLs and object tags are included in S3 backups.
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) --
{'Lifecycle': {'DeleteAfterEvent': 'DELETE_AFTER_COPY'}}
Sets the transition lifecycle of a recovery point.
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.
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.
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.
This operation does not support continuous backups.
See also: AWS API Documentation
Request Syntax
client.update_recovery_point_lifecycle(
BackupVaultName='string',
RecoveryPointArn='string',
Lifecycle={
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
}
)
string
[REQUIRED]
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.
string
[REQUIRED]
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
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.
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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
dict
Response Syntax
{
'BackupVaultArn': 'string',
'RecoveryPointArn': 'string',
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False,
'DeleteAfterEvent': 'DELETE_AFTER_COPY'
},
'CalculatedLifecycle': {
'MoveToColdStorageAt': datetime(2015, 1, 1),
'DeleteAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
BackupVaultArn (string) --
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
RecoveryPointArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
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.
DeleteAfterEvent (string) --
The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
CalculatedLifecycle (dict) --
A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
MoveToColdStorageAt (datetime) --
A timestamp that specifies when to transition a recovery point to cold storage.
DeleteAt (datetime) --
A timestamp that specifies when to delete a recovery point.