2023/11/27 - AWS Backup - 14 new 18 updated api methods
Changes AWS Backup now supports restore testing, a new feature that allows customers to automate restore testing and validating their backups. Additionally, this release adds support for EBS Snapshots Archive tier.
This returns restore jobs that contain the specified protected resource.
You must include ResourceArn . You can optionally include NextToken , ByStatus , MaxResults , ByRecoveryPointCreationDateAfter , and ByRecoveryPointCreationDateBefore .
See also: AWS API Documentation
Request Syntax
client.list_restore_jobs_by_protected_resource(
ResourceArn='string',
ByStatus='PENDING'|'RUNNING'|'COMPLETED'|'ABORTED'|'FAILED',
ByRecoveryPointCreationDateAfter=datetime(2015, 1, 1),
ByRecoveryPointCreationDateBefore=datetime(2015, 1, 1),
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
Returns only restore jobs that match the specified resource Amazon Resource Name (ARN).
string
Returns only restore jobs associated with the specified job status.
datetime
Returns only restore jobs of recovery points that were created after the specified date.
datetime
Returns only restore jobs of recovery points that were created before the specified date.
string
The next item following a partial list of returned items. For example, if a request ismade 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.
dict
Response Syntax
{
'RestoreJobs': [
{
'AccountId': 'string',
'RestoreJobId': 'string',
'RecoveryPointArn': 'string',
'CreationDate': datetime(2015, 1, 1),
'CompletionDate': datetime(2015, 1, 1),
'Status': 'PENDING'|'RUNNING'|'COMPLETED'|'ABORTED'|'FAILED',
'StatusMessage': 'string',
'PercentDone': 'string',
'BackupSizeInBytes': 123,
'IamRoleArn': 'string',
'ExpectedCompletionTimeMinutes': 123,
'CreatedResourceArn': 'string',
'ResourceType': 'string',
'RecoveryPointCreationDate': datetime(2015, 1, 1),
'CreatedBy': {
'RestoreTestingPlanArn': 'string'
},
'ValidationStatus': 'FAILED'|'SUCCESSFUL'|'TIMED_OUT'|'VALIDATING',
'ValidationStatusMessage': 'string',
'DeletionStatus': 'DELETING'|'FAILED'|'SUCCESSFUL',
'DeletionStatusMessage': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RestoreJobs (list) --
An array of objects that contain detailed information about jobs to restore saved resources.>
(dict) --
Contains metadata about a restore job.
AccountId (string) --
The account ID that owns the restore job.
RestoreJobId (string) --
Uniquely identifies the job that restores a recovery point.
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 .
CreationDate (datetime) --
The date and time a restore 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 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.
Status (string) --
A status code specifying the state of the job initiated by Backup to restore a recovery point.
StatusMessage (string) --
A detailed message explaining the status of the job to restore a recovery point.
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 the restored resource.
IamRoleArn (string) --
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access .
ExpectedCompletionTimeMinutes (integer) --
The amount of time in minutes that a job restoring a recovery point is expected to take.
CreatedResourceArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
ResourceType (string) --
The resource type of the listed restore jobs; 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.
RecoveryPointCreationDate (datetime) --
The date on which a recovery point was created.
CreatedBy (dict) --
Contains identifying information about the creation of a restore job.
RestoreTestingPlanArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
ValidationStatus (string) --
This is the status of validation run on the indicated restore job.
ValidationStatusMessage (string) --
This describes the status of validation run on the indicated restore job.
DeletionStatus (string) --
This notes the status of the data generated by the restore test. The status may be Deleting , Failed , or Successful .
DeletionStatusMessage (string) --
This describes the restore job deletion status.
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 youto return more items in your list starting at the location pointed to by the next token
This request returns the minimal required set of metadata needed to start a restore job with secure default settings. BackupVaultName and RecoveryPointArn are required parameters. BackupVaultAccountId is an optional parameter.
See also: AWS API Documentation
Request Syntax
client.get_restore_testing_inferred_metadata(
BackupVaultAccountId='string',
BackupVaultName='string',
RecoveryPointArn='string'
)
string
This is the account ID of the specified backup vault.
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 ServicesRegion where they are created. They consist of letters, numbers, and hyphens.
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
Response Syntax
{
'InferredMetadata': {
'string': 'string'
}
}
Response Structure
(dict) --
InferredMetadata (dict) --
This is a string map of the metadata inferred from the request.
(string) --
(string) --
Most elements except the RestoreTestingSelectionName can be updated with this request.
RestoreTestingSelection can use either protected resource ARNs or conditions, but not both. That is, if your selection has ProtectedResourceArns , requesting an update with the parameter ProtectedResourceConditions will be unsuccessful.
See also: AWS API Documentation
Request Syntax
client.update_restore_testing_selection(
RestoreTestingPlanName='string',
RestoreTestingSelection={
'IamRoleArn': 'string',
'ProtectedResourceArns': [
'string',
],
'ProtectedResourceConditions': {
'StringEquals': [
{
'Key': 'string',
'Value': 'string'
},
],
'StringNotEquals': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'RestoreMetadataOverrides': {
'string': 'string'
},
'ValidationWindowHours': 123
},
RestoreTestingSelectionName='string'
)
string
[REQUIRED]
The restore testing plan name is required to update the indicated testing plan.
dict
[REQUIRED]
To update your restore testing selection, you can use either protected resource ARNs or conditions, but not both. That is, if your selection has ProtectedResourceArns , requesting an update with the parameter ProtectedResourceConditions will be unsuccessful.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access .
ProtectedResourceArns (list) --
You can include a list of specific ARNs, such as ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."] or you can include a wildcard: ProtectedResourceArns: ["*"] , but not both.
(string) --
ProtectedResourceConditions (dict) --
A list of conditions that you define for resources in your restore testing plan using tags.
For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": "true" }, . Condition operators are case sensitive.
StringEquals (list) --
Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching."
(dict) --
Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: + - = . _ : /
Key (string) -- [REQUIRED]
The tag key (String). The key can't start with aws: .
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$
Value (string) -- [REQUIRED]
The value of the key.
Length Constraints: Maximum length of 256.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
StringNotEquals (list) --
Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called "negated matching."
(dict) --
Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: + - = . _ : /
Key (string) -- [REQUIRED]
The tag key (String). The key can't start with aws: .
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$
Value (string) -- [REQUIRED]
The value of the key.
Length Constraints: Maximum length of 256.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
RestoreMetadataOverrides (dict) --
You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection . Key values are not case sensitive.
See the complete list of restore testing inferred metadata.
(string) --
(string) --
ValidationWindowHours (integer) --
This value represents the time, in hours, data is retained after a restore test so that optional validation can be completed.
Accepted value is an integer between 0 and 168 (the hourly equivalent of seven days).
string
[REQUIRED]
This is the required restore testing selection name of the restore testing selection you wish to update.
dict
Response Syntax
{
'CreationTime': datetime(2015, 1, 1),
'RestoreTestingPlanArn': 'string',
'RestoreTestingPlanName': 'string',
'RestoreTestingSelectionName': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
CreationTime (datetime) --
This is the time the resource testing selection was updated successfully.
RestoreTestingPlanArn (string) --
Unique string that is the name of the restore testing plan.
RestoreTestingPlanName (string) --
This is the restore testing plan with which the updated restore testing selection is associated.
RestoreTestingSelectionName (string) --
This is the returned restore testing selection name.
UpdateTime (datetime) --
This is the time the update completed for the restore testing selection.
Returns RestoreTestingPlan details for the specified RestoreTestingPlanName . The details are the body of a restore testing plan in JSON format, in addition to plan metadata.
See also: AWS API Documentation
Request Syntax
client.get_restore_testing_plan(
RestoreTestingPlanName='string'
)
string
[REQUIRED]
Required unique name of the restore testing plan.
dict
Response Syntax
{
'RestoreTestingPlan': {
'CreationTime': datetime(2015, 1, 1),
'CreatorRequestId': 'string',
'LastExecutionTime': datetime(2015, 1, 1),
'LastUpdateTime': datetime(2015, 1, 1),
'RecoveryPointSelection': {
'Algorithm': 'LATEST_WITHIN_WINDOW'|'RANDOM_WITHIN_WINDOW',
'ExcludeVaults': [
'string',
],
'IncludeVaults': [
'string',
],
'RecoveryPointTypes': [
'CONTINUOUS'|'SNAPSHOT',
],
'SelectionWindowDays': 123
},
'RestoreTestingPlanArn': 'string',
'RestoreTestingPlanName': 'string',
'ScheduleExpression': 'string',
'ScheduleExpressionTimezone': 'string',
'StartWindowHours': 123
}
}
Response Structure
(dict) --
RestoreTestingPlan (dict) --
Specifies the body of a restore testing plan. Includes RestoreTestingPlanName .
CreationTime (datetime) --
The date and time that a restore testing plan was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
CreatorRequestId (string) --
This 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.
LastExecutionTime (datetime) --
The last time a restore test was run with the specified restore testing plan. 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.
LastUpdateTime (datetime) --
The date and time that the restore testing plan was updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of LastUpdateTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
RecoveryPointSelection (dict) --
The specified criteria to assign a set of resources, such as recovery point types or backup vaults.
Algorithm (string) --
Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"
ExcludeVaults (list) --
Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.
(string) --
IncludeVaults (list) --
Accepted values include wildcard ["*"] or by specific ARNs or ARN wilcard replacement ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...] ["arn:aws:backup:::backup-vault:asdf-*", ...]
(string) --
RecoveryPointTypes (list) --
These are the types of recovery points.
(string) --
SelectionWindowDays (integer) --
Accepted values are integers from 1 to 365.
RestoreTestingPlanArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
RestoreTestingPlanName (string) --
This is the restore testing plan name.
ScheduleExpression (string) --
A CRON expression in specified timezone when a restore testing plan is executed.
ScheduleExpressionTimezone (string) --
Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
StartWindowHours (integer) --
Defaults to 24 hours.
A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).
Input the Restore Testing Plan name and Restore Testing Selection name.
All testing selections associated with a restore testing plan must be deleted before the restore testing plan can be deleted.
See also: AWS API Documentation
Request Syntax
client.delete_restore_testing_selection(
RestoreTestingPlanName='string',
RestoreTestingSelectionName='string'
)
string
[REQUIRED]
Required unique name of the restore testing plan that contains the restore testing selection you wish to delete.
string
[REQUIRED]
Required unique name of the restore testing selection you wish to delete.
None
Returns a list of restore testing selections. Can be filtered by MaxResults and RestoreTestingPlanName .
See also: AWS API Documentation
Request Syntax
client.list_restore_testing_selections(
MaxResults=123,
NextToken='string',
RestoreTestingPlanName='string'
)
integer
The maximum number of items to be returned.
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 nexttoken.
string
[REQUIRED]
Returns restore testing selections by the specified restore testing plan name.
dict
Response Syntax
{
'NextToken': 'string',
'RestoreTestingSelections': [
{
'CreationTime': datetime(2015, 1, 1),
'IamRoleArn': 'string',
'ProtectedResourceType': 'string',
'RestoreTestingPlanName': 'string',
'RestoreTestingSelectionName': 'string',
'ValidationWindowHours': 123
},
]
}
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 nexttoken.
RestoreTestingSelections (list) --
The returned restore testing selections associated with the restore testing plan.
(dict) --
This contains metadata about a restore testing selection.
CreationTime (datetime) --
This is the date and time that a restore testing selection was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26,2018 12:11:30.087 AM.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access .
ProtectedResourceType (string) --
The type of Amazon Web Services resource included in a restore testing selection; for example, an Amazon EBS volume or an Amazon RDS database.
RestoreTestingPlanName (string) --
Unique string that is the name of the restore testing plan.
The name cannot be changed after creation. The name must consist of only alphanumeric characters and underscores. Maximum length is 50.
RestoreTestingSelectionName (string) --
Unique name of a restore testing selection.
ValidationWindowHours (integer) --
This value represents the time, in hours, data is retained after a restore test so that optional validation can be completed.
Accepted value is an integer between 0 and 168 (the hourly equivalent of seven days).
This request deletes the specified restore testing plan.
Deletion can only successfully occur if all associated restore testing selections are deleted first.
See also: AWS API Documentation
Request Syntax
client.delete_restore_testing_plan(
RestoreTestingPlanName='string'
)
string
[REQUIRED]
Required unique name of the restore testing plan you wish to delete.
None
This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must be completed sequentially.
This consists of RestoreTestingSelectionName , ProtectedResourceType , and one of the following:
ProtectedResourceArns
ProtectedResourceConditions
Each protected resource type can have one single value.
A restore testing selection can include a wildcard value ("*") for ProtectedResourceArns along with ProtectedResourceConditions . Alternatively, you can include up to 30 specific protected resource ARNs in ProtectedResourceArns .
Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.
See also: AWS API Documentation
Request Syntax
client.create_restore_testing_selection(
CreatorRequestId='string',
RestoreTestingPlanName='string',
RestoreTestingSelection={
'IamRoleArn': 'string',
'ProtectedResourceArns': [
'string',
],
'ProtectedResourceConditions': {
'StringEquals': [
{
'Key': 'string',
'Value': 'string'
},
],
'StringNotEquals': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'ProtectedResourceType': 'string',
'RestoreMetadataOverrides': {
'string': 'string'
},
'RestoreTestingSelectionName': 'string',
'ValidationWindowHours': 123
}
)
string
This is an optional unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
string
[REQUIRED]
Input the restore testing plan name that was returned from the related CreateRestoreTestingPlan request.
dict
[REQUIRED]
This consists of RestoreTestingSelectionName , ProtectedResourceType , and one of the following:
ProtectedResourceArns
ProtectedResourceConditions
Each protected resource type can have one single value.
A restore testing selection can include a wildcard value ("*") for ProtectedResourceArns along with ProtectedResourceConditions . Alternatively, you can include up to 30 specific protected resource ARNs in ProtectedResourceArns .
IamRoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access .
ProtectedResourceArns (list) --
Each protected resource can be filtered by its specific ARNs, such as ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."] or by a wildcard: ProtectedResourceArns: ["*"] , but not both.
(string) --
ProtectedResourceConditions (dict) --
If you have included the wildcard in ProtectedResourceArns, you can include resource conditions, such as ProtectedResourceConditions: { StringEquals: [{ key: "XXXX", value: "YYYY" }] .
StringEquals (list) --
Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching."
(dict) --
Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: + - = . _ : /
Key (string) -- [REQUIRED]
The tag key (String). The key can't start with aws: .
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$
Value (string) -- [REQUIRED]
The value of the key.
Length Constraints: Maximum length of 256.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
StringNotEquals (list) --
Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called "negated matching."
(dict) --
Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: + - = . _ : /
Key (string) -- [REQUIRED]
The tag key (String). The key can't start with aws: .
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$
Value (string) -- [REQUIRED]
The value of the key.
Length Constraints: Maximum length of 256.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
ProtectedResourceType (string) -- [REQUIRED]
The type of Amazon Web Services resource included in a restore testing selection; for example, an Amazon EBS volume or an Amazon RDS database.
Supported resource types accepted include:
Aurora for Amazon Aurora
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
S3 for Amazon S3
RestoreMetadataOverrides (dict) --
You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection . Key values are not case sensitive.
See the complete list of restore testing inferred metadata.
(string) --
(string) --
RestoreTestingSelectionName (string) -- [REQUIRED]
This is the unique name of the restore testing selection that belongs to the related restore testing plan.
ValidationWindowHours (integer) --
This is amount of hours (1 to 168) available to run a validation script on the data. The data will be deleted upon the completion of the validation script or the end of the specified retention period, whichever comes first.
dict
Response Syntax
{
'CreationTime': datetime(2015, 1, 1),
'RestoreTestingPlanArn': 'string',
'RestoreTestingPlanName': 'string',
'RestoreTestingSelectionName': 'string'
}
Response Structure
(dict) --
CreationTime (datetime) --
This is the time the resource testing selection was created successfully.
RestoreTestingPlanArn (string) --
This is the ARN of the restore testing plan with which the restore testing selection is associated.
RestoreTestingPlanName (string) --
Unique string that is the name of the restore testing plan.
The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.
RestoreTestingSelectionName (string) --
This is the unique name of the restore testing selection that belongs to the related restore testing plan.
Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
See also: AWS API Documentation
Request Syntax
client.get_restore_testing_selection(
RestoreTestingPlanName='string',
RestoreTestingSelectionName='string'
)
string
[REQUIRED]
Required unique name of the restore testing plan.
string
[REQUIRED]
Required unique name of the restore testing selection.
dict
Response Syntax
{
'RestoreTestingSelection': {
'CreationTime': datetime(2015, 1, 1),
'CreatorRequestId': 'string',
'IamRoleArn': 'string',
'ProtectedResourceArns': [
'string',
],
'ProtectedResourceConditions': {
'StringEquals': [
{
'Key': 'string',
'Value': 'string'
},
],
'StringNotEquals': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'ProtectedResourceType': 'string',
'RestoreMetadataOverrides': {
'string': 'string'
},
'RestoreTestingPlanName': 'string',
'RestoreTestingSelectionName': 'string',
'ValidationWindowHours': 123
}
}
Response Structure
(dict) --
RestoreTestingSelection (dict) --
Unique name of the restore testing selection.
CreationTime (datetime) --
The date and time that a restore testing selection was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 201812:11:30.087 AM.
CreatorRequestId (string) --
This 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.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access .
ProtectedResourceArns (list) --
You can include specific ARNs, such as ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."] or you can include a wildcard: ProtectedResourceArns: ["*"] , but not both.
(string) --
ProtectedResourceConditions (dict) --
In a resource testing selection, this parameter filters by specific conditions such as StringEquals or StringNotEquals .
StringEquals (list) --
Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching."
(dict) --
Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: + - = . _ : /
Key (string) --
The tag key (String). The key can't start with aws: .
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$
Value (string) --
The value of the key.
Length Constraints: Maximum length of 256.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
StringNotEquals (list) --
Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called "negated matching."
(dict) --
Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: + - = . _ : /
Key (string) --
The tag key (String). The key can't start with aws: .
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$
Value (string) --
The value of the key.
Length Constraints: Maximum length of 256.
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
ProtectedResourceType (string) --
The type of Amazon Web Services resource included in a resource testing selection; for example, an Amazon EBS volume or an Amazon RDS database.
RestoreMetadataOverrides (dict) --
You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection . Key values are not case sensitive.
See the complete list of restore testing inferred metadata.
(string) --
(string) --
RestoreTestingPlanName (string) --
The RestoreTestingPlanName is a unique string that is the name of the restore testing plan.
RestoreTestingSelectionName (string) --
This is the unique name of the restore testing selection that belongs to the related restore testing plan.
ValidationWindowHours (integer) --
This is amount of hours (1 to 168) available to run a validation script on the data. The data will be deleted upon the completion of the validation script or the end of the specified retention period, whichever comes first.
This request returns the metadata for the specified restore job.
See also: AWS API Documentation
Request Syntax
client.get_restore_job_metadata(
RestoreJobId='string'
)
string
[REQUIRED]
This is a unique identifier of a restore job within Backup.
dict
Response Syntax
{
'RestoreJobId': 'string',
'Metadata': {
'string': 'string'
}
}
Response Structure
(dict) --
RestoreJobId (string) --
This is a unique identifier of a restore job within Backup.
Metadata (dict) --
This contains the metadata of the specified backup job.
(string) --
(string) --
This request will send changes to your specified restore testing plan. RestoreTestingPlanName cannot be updated after it is created.
RecoveryPointSelection can contain:
Algorithm
ExcludeVaults
IncludeVaults
RecoveryPointTypes
SelectionWindowDays
See also: AWS API Documentation
Request Syntax
client.update_restore_testing_plan(
RestoreTestingPlan={
'RecoveryPointSelection': {
'Algorithm': 'LATEST_WITHIN_WINDOW'|'RANDOM_WITHIN_WINDOW',
'ExcludeVaults': [
'string',
],
'IncludeVaults': [
'string',
],
'RecoveryPointTypes': [
'CONTINUOUS'|'SNAPSHOT',
],
'SelectionWindowDays': 123
},
'ScheduleExpression': 'string',
'ScheduleExpressionTimezone': 'string',
'StartWindowHours': 123
},
RestoreTestingPlanName='string'
)
dict
[REQUIRED]
Specifies the body of a restore testing plan.
RecoveryPointSelection (dict) --
Required: Algorithm ; RecoveryPointTypes ; IncludeVaults (one or more ).
Optional: SelectionWindowDays ('30' if not specified ); ExcludeVaults (defaults to empty list if not listed).
Algorithm (string) --
Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"
ExcludeVaults (list) --
Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.
(string) --
IncludeVaults (list) --
Accepted values include wildcard ["*"] or by specific ARNs or ARN wilcard replacement ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...] ["arn:aws:backup:::backup-vault:asdf-*", ...]
(string) --
RecoveryPointTypes (list) --
These are the types of recovery points.
(string) --
SelectionWindowDays (integer) --
Accepted values are integers from 1 to 365.
ScheduleExpression (string) --
A CRON expression in specified timezone when a restore testing plan is executed.
ScheduleExpressionTimezone (string) --
Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
StartWindowHours (integer) --
Defaults to 24 hours.
A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).
string
[REQUIRED]
This is the restore testing plan name you wish to update.
dict
Response Syntax
{
'CreationTime': datetime(2015, 1, 1),
'RestoreTestingPlanArn': 'string',
'RestoreTestingPlanName': 'string',
'UpdateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
CreationTime (datetime) --
This is the time the resource testing plan was created.
RestoreTestingPlanArn (string) --
Unique ARN (Amazon Resource Name) of the restore testing plan.
RestoreTestingPlanName (string) --
The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.
UpdateTime (datetime) --
This is the time the update completed for the restore testing plan.
This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.
You must include the parameter RestoreTestingPlan. You may optionally include CreatorRequestId and Tags.
See also: AWS API Documentation
Request Syntax
client.create_restore_testing_plan(
CreatorRequestId='string',
RestoreTestingPlan={
'RecoveryPointSelection': {
'Algorithm': 'LATEST_WITHIN_WINDOW'|'RANDOM_WITHIN_WINDOW',
'ExcludeVaults': [
'string',
],
'IncludeVaults': [
'string',
],
'RecoveryPointTypes': [
'CONTINUOUS'|'SNAPSHOT',
],
'SelectionWindowDays': 123
},
'RestoreTestingPlanName': 'string',
'ScheduleExpression': 'string',
'ScheduleExpressionTimezone': 'string',
'StartWindowHours': 123
},
Tags={
'string': 'string'
}
)
string
This is a unique string that identifies the request and allows failed requests to be retriedwithout the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
dict
[REQUIRED]
A restore testing plan must contain a unique RestoreTestingPlanName string you create and must contain a ScheduleExpression cron. You may optionally include a StartWindowHours integer and a CreatorRequestId string.
The RestoreTestingPlanName is a unique string that is the name of the restore testing plan. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.
RecoveryPointSelection (dict) -- [REQUIRED]
Required: Algorithm; Required: Recovery point types; IncludeVaults (one or more). Optional: SelectionWindowDays ('30' if not specified); ExcludeVaults (list of selectors), defaults to empty list if not listed.
Algorithm (string) --
Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"
ExcludeVaults (list) --
Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.
(string) --
IncludeVaults (list) --
Accepted values include wildcard ["*"] or by specific ARNs or ARN wilcard replacement ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...] ["arn:aws:backup:::backup-vault:asdf-*", ...]
(string) --
RecoveryPointTypes (list) --
These are the types of recovery points.
(string) --
SelectionWindowDays (integer) --
Accepted values are integers from 1 to 365.
RestoreTestingPlanName (string) -- [REQUIRED]
The RestoreTestingPlanName is a unique string that is the name of the restore testing plan. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.
ScheduleExpression (string) -- [REQUIRED]
A CRON expression in specified timezone when a restore testing plan is executed.
ScheduleExpressionTimezone (string) --
Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
StartWindowHours (integer) --
Defaults to 24 hours.
A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).
dict
Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters,numbers, spaces, and the following characters: + - = . _ : /.
(string) --
(string) --
dict
Response Syntax
{
'CreationTime': datetime(2015, 1, 1),
'RestoreTestingPlanArn': 'string',
'RestoreTestingPlanName': 'string'
}
Response Structure
(dict) --
CreationTime (datetime) --
The date and time a restore testing plan was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
RestoreTestingPlanArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the created restore testing plan.
RestoreTestingPlanName (string) --
This unique string is the name of the restore testing plan.
The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.
This request allows you to send your independent self-run restore test validation results. RestoreJobId and ValidationStatus are required. Optionally, you can input a ValidationStatusMessage .
See also: AWS API Documentation
Request Syntax
client.put_restore_validation_result(
RestoreJobId='string',
ValidationStatus='FAILED'|'SUCCESSFUL'|'TIMED_OUT'|'VALIDATING',
ValidationStatusMessage='string'
)
string
[REQUIRED]
This is a unique identifier of a restore job within Backup.
string
[REQUIRED]
This is the status of your restore validation.
string
This is an optional message string you can input to describe the validation status for the restore test validation.
None
Returns a list of restore testing plans.
See also: AWS API Documentation
Request Syntax
client.list_restore_testing_plans(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of items to be returned.
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 nexttoken.
dict
Response Syntax
{
'NextToken': 'string',
'RestoreTestingPlans': [
{
'CreationTime': datetime(2015, 1, 1),
'LastExecutionTime': datetime(2015, 1, 1),
'LastUpdateTime': datetime(2015, 1, 1),
'RestoreTestingPlanArn': 'string',
'RestoreTestingPlanName': 'string',
'ScheduleExpression': 'string',
'ScheduleExpressionTimezone': 'string',
'StartWindowHours': 123
},
]
}
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 nexttoken.
RestoreTestingPlans (list) --
This is a returned list of restore testing plans.
(dict) --
This contains metadata about a restore testing plan.
CreationTime (datetime) --
The date and time that a restore testing plan was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
LastExecutionTime (datetime) --
The last time a restore test was run with the specified restore testing plan. 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.
LastUpdateTime (datetime) --
The date and time that the restore testing plan was updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of LastUpdateTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
RestoreTestingPlanArn (string) --
An Amazon Resource Name (ARN) that uniquely identifiesa restore testing plan.
RestoreTestingPlanName (string) --
This is the restore testing plan name.
ScheduleExpression (string) --
A CRON expression in specified timezone when a restore testing plan is executed.
ScheduleExpressionTimezone (string) --
Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
StartWindowHours (integer) --
Defaults to 24 hours.
A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).
{'BackupPlan': {'Rules': {'CopyActions': {'Lifecycle': {'OptInToArchiveForSupportedResources': 'boolean'}},
'Lifecycle': {'OptInToArchiveForSupportedResources': 'boolean'}}}}
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',
'ScheduleExpression': 'string',
'StartWindowMinutes': 123,
'CompletionWindowMinutes': 123,
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False
},
'RecoveryPointTags': {
'string': 'string'
},
'CopyActions': [
{
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False
},
'DestinationBackupVaultArn': 'string'
},
],
'EnableContinuousBackup': True|False,
'ScheduleExpressionTimezone': 'string'
},
],
'AdvancedBackupSettings': [
{
'ResourceType': 'string',
'BackupOptions': {
'string': 'string'
}
},
]
},
BackupPlanTags={
'string': 'string'
},
CreatorRequestId='string'
)
dict
[REQUIRED]
Specifies 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. They consist of lowercase letters, numbers, and hyphens.
ScheduleExpression (string) --
A CRON expression in UTC specifying when Backup initiates a backup job.
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.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of 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) --
Specifies the number of days after creation that a recovery point is moved to cold storage.
DeleteAfterDays (integer) --
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays .
OptInToArchiveForSupportedResources (boolean) --
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
RecoveryPointTags (dict) --
To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
(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) --
Contains an array of Transition objects specifying how long 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 cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
MoveToColdStorageAfterDays (integer) --
Specifies the number of days after creation that a recovery point is moved to cold storage.
DeleteAfterDays (integer) --
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays .
OptInToArchiveForSupportedResources (boolean) --
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
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: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) --
This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
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) --
A list of backup options for each resource type.
ResourceType (string) --
Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide .
Valid values: EC2 .
BackupOptions (dict) --
Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
Valid values:
Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.
Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.
If you specify an invalid option, you get an InvalidParameterValueException exception.
For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.
(string) --
(string) --
dict
To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this 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.
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 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) --
A list of BackupOptions settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
(dict) --
A list of backup options for each resource type.
ResourceType (string) --
Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide .
Valid values: EC2 .
BackupOptions (dict) --
Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
Valid values:
Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.
Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.
If you specify an invalid option, you get an InvalidParameterValueException exception.
For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.
(string) --
(string) --
{'InitiationDate': 'timestamp'}
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',
'BackupVaultArn': 'string',
'RecoveryPointArn': 'string',
'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',
'BackupPlanVersion': 'string',
'BackupRuleId': '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. They consist of lowercase letters, numbers, and hyphens.
BackupVaultArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .
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 .
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.
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 .
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.
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) --
This is the non-unique name of the resource that belongs to the specified backup.
InitiationDate (datetime) --
This is the date a backup job was initiated.
MessageCategory (string) --
This is 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.
{'LastBackupVaultArn': 'string',
'LastRecoveryPointArn': 'string',
'LatestRestoreExecutionTimeMinutes': 'long',
'LatestRestoreJobCreationDate': 'timestamp',
'LatestRestoreRecoveryPointCreationDate': 'timestamp'}
Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource.
See also: AWS API Documentation
Request Syntax
client.describe_protected_resource(
ResourceArn='string'
)
string
[REQUIRED]
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
dict
Response Syntax
{
'ResourceArn': 'string',
'ResourceType': 'string',
'LastBackupTime': datetime(2015, 1, 1),
'ResourceName': 'string',
'LastBackupVaultArn': 'string',
'LastRecoveryPointArn': 'string',
'LatestRestoreExecutionTimeMinutes': 123,
'LatestRestoreJobCreationDate': datetime(2015, 1, 1),
'LatestRestoreRecoveryPointCreationDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
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 EBS volume or an Amazon RDS database.
LastBackupTime (datetime) --
The date and time that a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
ResourceName (string) --
This is the non-unique name of the resource that belongs to the specified backup.
LastBackupVaultArn (string) --
This is the ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.
LastRecoveryPointArn (string) --
This is the ARN (Amazon Resource Name) of the most recent recovery point.
LatestRestoreExecutionTimeMinutes (integer) --
This is the time in minutes the most recent restore job took to complete.
LatestRestoreJobCreationDate (datetime) --
This is the creation date of the most recent restore job.
LatestRestoreRecoveryPointCreationDate (datetime) --
This is the date the most recent recovery point was created.
{'Lifecycle': {'OptInToArchiveForSupportedResources': 'boolean'}}
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. They consist of lowercase letters, numbers, and hyphens.
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
This is 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',
'BackupPlanVersion': 'string',
'BackupRuleId': 'string'
},
'IamRoleArn': 'string',
'Status': 'COMPLETED'|'PARTIAL'|'DELETING'|'EXPIRED',
'StatusMessage': 'string',
'CreationDate': 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
},
'EncryptionKeyArn': 'string',
'IsEncrypted': True|False,
'StorageClass': 'WARM'|'COLD'|'DELETED',
'LastRestoreTime': datetime(2015, 1, 1),
'ParentRecoveryPointArn': 'string',
'CompositeMemberIdentifier': 'string',
'IsParent': True|False,
'ResourceName': 'string'
}
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. They consist of lowercase letters, numbers, and hyphens.
BackupVaultArn (string) --
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012: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:vault:BackupVault . 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 .
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.
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.
PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.
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.
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.
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 are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
MoveToColdStorageAfterDays (integer) --
Specifies the number of days after creation that a recovery point is moved to cold storage.
DeleteAfterDays (integer) --
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays .
OptInToArchiveForSupportedResources (boolean) --
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
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) --
This is 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) --
This is the non-unique name of the resource that belongs to the specified backup.
{'CreatedBy': {'RestoreTestingPlanArn': 'string'},
'DeletionStatus': 'DELETING | FAILED | SUCCESSFUL',
'DeletionStatusMessage': 'string',
'RecoveryPointCreationDate': 'timestamp',
'ValidationStatus': 'FAILED | SUCCESSFUL | TIMED_OUT | VALIDATING',
'ValidationStatusMessage': 'string'}
Returns metadata associated with a restore job that is specified by a job ID.
See also: AWS API Documentation
Request Syntax
client.describe_restore_job(
RestoreJobId='string'
)
string
[REQUIRED]
Uniquely identifies the job that restores a recovery point.
dict
Response Syntax
{
'AccountId': 'string',
'RestoreJobId': 'string',
'RecoveryPointArn': 'string',
'CreationDate': datetime(2015, 1, 1),
'CompletionDate': datetime(2015, 1, 1),
'Status': 'PENDING'|'RUNNING'|'COMPLETED'|'ABORTED'|'FAILED',
'StatusMessage': 'string',
'PercentDone': 'string',
'BackupSizeInBytes': 123,
'IamRoleArn': 'string',
'ExpectedCompletionTimeMinutes': 123,
'CreatedResourceArn': 'string',
'ResourceType': 'string',
'RecoveryPointCreationDate': datetime(2015, 1, 1),
'CreatedBy': {
'RestoreTestingPlanArn': 'string'
},
'ValidationStatus': 'FAILED'|'SUCCESSFUL'|'TIMED_OUT'|'VALIDATING',
'ValidationStatusMessage': 'string',
'DeletionStatus': 'DELETING'|'FAILED'|'SUCCESSFUL',
'DeletionStatusMessage': 'string'
}
Response Structure
(dict) --
AccountId (string) --
Returns the account ID that owns the restore job.
RestoreJobId (string) --
Uniquely identifies the job that restores a recovery point.
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 .
CreationDate (datetime) --
The date and time that a restore 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 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.
Status (string) --
Status code specifying the state of the job that is initiated by Backup to restore a recovery point.
StatusMessage (string) --
A message showing the status of a job to restore a recovery point.
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 the restored resource.
IamRoleArn (string) --
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access .
ExpectedCompletionTimeMinutes (integer) --
The amount of time in minutes that a job restoring a recovery point is expected to take.
CreatedResourceArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.
ResourceType (string) --
Returns metadata associated with a restore job listed by resource type.
RecoveryPointCreationDate (datetime) --
This is the creation date of the recovery point made by the specifed restore job.
CreatedBy (dict) --
Contains identifying information about the creation of a restore job.
RestoreTestingPlanArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
ValidationStatus (string) --
This is the status of validation run on the indicated restore job.
ValidationStatusMessage (string) --
This describes the status of validation run on the indicated restore job.
DeletionStatus (string) --
This notes the status of the data generated by the restore test. The status may be Deleting , Failed , or Successful .
DeletionStatusMessage (string) --
This describes the restore job deletion status.
{'BackupPlan': {'Rules': {'CopyActions': {'Lifecycle': {'OptInToArchiveForSupportedResources': 'boolean'}},
'Lifecycle': {'OptInToArchiveForSupportedResources': 'boolean'}}}}
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'
)
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.
dict
Response Syntax
{
'BackupPlan': {
'BackupPlanName': 'string',
'Rules': [
{
'RuleName': 'string',
'TargetBackupVaultName': 'string',
'ScheduleExpression': 'string',
'StartWindowMinutes': 123,
'CompletionWindowMinutes': 123,
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False
},
'RecoveryPointTags': {
'string': 'string'
},
'RuleId': 'string',
'CopyActions': [
{
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False
},
'DestinationBackupVaultArn': 'string'
},
],
'EnableContinuousBackup': True|False,
'ScheduleExpressionTimezone': 'string'
},
],
'AdvancedBackupSettings': [
{
'ResourceType': 'string',
'BackupOptions': {
'string': 'string'
}
},
]
},
'BackupPlanId': 'string',
'BackupPlanArn': 'string',
'VersionId': 'string',
'CreatorRequestId': 'string',
'CreationDate': datetime(2015, 1, 1),
'DeletionDate': datetime(2015, 1, 1),
'LastExecutionDate': datetime(2015, 1, 1),
'AdvancedBackupSettings': [
{
'ResourceType': 'string',
'BackupOptions': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
BackupPlan (dict) --
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules .
BackupPlanName (string) --
The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' 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. They consist of lowercase letters, numbers, and hyphens.
ScheduleExpression (string) --
A cron expression in UTC specifying when Backup initiates a backup job. For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide. . Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC). For a table of examples, click the preceding link and scroll down the page.
StartWindowMinutes (integer) --
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, it must be at least 60 minutes to avoid errors.
During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING ) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).
CompletionWindowMinutes (integer) --
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.
Lifecycle (dict) --
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
MoveToColdStorageAfterDays (integer) --
Specifies the number of days after creation that a recovery point is moved to cold storage.
DeleteAfterDays (integer) --
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays .
OptInToArchiveForSupportedResources (boolean) --
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
RecoveryPointTags (dict) --
An array of key-value pair strings 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) --
Contains an array of Transition objects specifying how long 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 cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
MoveToColdStorageAfterDays (integer) --
Specifies the number of days after creation that a recovery point is moved to cold storage.
DeleteAfterDays (integer) --
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays .
OptInToArchiveForSupportedResources (boolean) --
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
DestinationBackupVaultArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012: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) --
This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
AdvancedBackupSettings (list) --
Contains a list of BackupOptions for each resource type.
(dict) --
A list of backup options for each resource type.
ResourceType (string) --
Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide .
Valid values: EC2 .
BackupOptions (dict) --
Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
Valid values:
Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.
Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.
If you specify an invalid option, you get an InvalidParameterValueException exception.
For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.
(string) --
(string) --
BackupPlanId (string) --
Uniquely identifies a backup plan.
BackupPlanArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 .
VersionId (string) --
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
CreatorRequestId (string) --
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
CreationDate (datetime) --
The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
DeletionDate (datetime) --
The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
LastExecutionDate (datetime) --
The last time a job to back up resources was run with this backup plan. 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) --
A list of backup options for each resource type.
ResourceType (string) --
Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide .
Valid values: EC2 .
BackupOptions (dict) --
Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
Valid values:
Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.
Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.
If you specify an invalid option, you get an InvalidParameterValueException exception.
For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.
(string) --
(string) --
{'BackupPlan': {'Rules': {'CopyActions': {'Lifecycle': {'OptInToArchiveForSupportedResources': 'boolean'}},
'Lifecycle': {'OptInToArchiveForSupportedResources': 'boolean'}}}}
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',
'ScheduleExpression': 'string',
'StartWindowMinutes': 123,
'CompletionWindowMinutes': 123,
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False
},
'RecoveryPointTags': {
'string': 'string'
},
'RuleId': 'string',
'CopyActions': [
{
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False
},
'DestinationBackupVaultArn': 'string'
},
],
'EnableContinuousBackup': True|False,
'ScheduleExpressionTimezone': 'string'
},
],
'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 1 to 50 alphanumeric or '-_.' 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. They consist of lowercase letters, numbers, and hyphens.
ScheduleExpression (string) --
A cron expression in UTC specifying when Backup initiates a backup job. For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide. . Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC). For a table of examples, click the preceding link and scroll down the page.
StartWindowMinutes (integer) --
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, it must be at least 60 minutes to avoid errors.
During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING ) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).
CompletionWindowMinutes (integer) --
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.
Lifecycle (dict) --
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
MoveToColdStorageAfterDays (integer) --
Specifies the number of days after creation that a recovery point is moved to cold storage.
DeleteAfterDays (integer) --
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays .
OptInToArchiveForSupportedResources (boolean) --
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
RecoveryPointTags (dict) --
An array of key-value pair strings 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) --
Contains an array of Transition objects specifying how long 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 cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
MoveToColdStorageAfterDays (integer) --
Specifies the number of days after creation that a recovery point is moved to cold storage.
DeleteAfterDays (integer) --
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays .
OptInToArchiveForSupportedResources (boolean) --
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
DestinationBackupVaultArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012: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) --
This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
AdvancedBackupSettings (list) --
Contains a list of BackupOptions for each resource type.
(dict) --
A list of backup options for each resource type.
ResourceType (string) --
Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide .
Valid values: EC2 .
BackupOptions (dict) --
Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
Valid values:
Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.
Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.
If you specify an invalid option, you get an InvalidParameterValueException exception.
For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.
(string) --
(string) --
{'BackupPlanDocument': {'Rules': {'CopyActions': {'Lifecycle': {'OptInToArchiveForSupportedResources': 'boolean'}},
'Lifecycle': {'OptInToArchiveForSupportedResources': 'boolean'}}}}
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',
'ScheduleExpression': 'string',
'StartWindowMinutes': 123,
'CompletionWindowMinutes': 123,
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False
},
'RecoveryPointTags': {
'string': 'string'
},
'RuleId': 'string',
'CopyActions': [
{
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False
},
'DestinationBackupVaultArn': 'string'
},
],
'EnableContinuousBackup': True|False,
'ScheduleExpressionTimezone': 'string'
},
],
'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 1 to 50 alphanumeric or '-_.' 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. They consist of lowercase letters, numbers, and hyphens.
ScheduleExpression (string) --
A cron expression in UTC specifying when Backup initiates a backup job. For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide. . Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC). For a table of examples, click the preceding link and scroll down the page.
StartWindowMinutes (integer) --
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, it must be at least 60 minutes to avoid errors.
During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING ) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).
CompletionWindowMinutes (integer) --
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.
Lifecycle (dict) --
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
MoveToColdStorageAfterDays (integer) --
Specifies the number of days after creation that a recovery point is moved to cold storage.
DeleteAfterDays (integer) --
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays .
OptInToArchiveForSupportedResources (boolean) --
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
RecoveryPointTags (dict) --
An array of key-value pair strings 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) --
Contains an array of Transition objects specifying how long 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 cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
MoveToColdStorageAfterDays (integer) --
Specifies the number of days after creation that a recovery point is moved to cold storage.
DeleteAfterDays (integer) --
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays .
OptInToArchiveForSupportedResources (boolean) --
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
DestinationBackupVaultArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012: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) --
This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
AdvancedBackupSettings (list) --
Contains a list of BackupOptions for each resource type.
(dict) --
A list of backup options for each resource type.
ResourceType (string) --
Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide .
Valid values: EC2 .
BackupOptions (dict) --
Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
Valid values:
Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.
Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.
If you specify an invalid option, you get an InvalidParameterValueException exception.
For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.
(string) --
(string) --
{'ResourceType': 'string'}
Returns a set of metadata key-value pairs that were used to create the backup.
See also: AWS API Documentation
Request Syntax
client.get_recovery_point_restore_metadata(
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. They consist of lowercase letters, numbers, and hyphens.
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
This is the account ID of the specified backup vault.
dict
Response Syntax
{
'BackupVaultArn': 'string',
'RecoveryPointArn': 'string',
'RestoreMetadata': {
'string': 'string'
},
'ResourceType': 'string'
}
Response Structure
(dict) --
BackupVaultArn (string) --
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .
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 .
RestoreMetadata (dict) --
The set of metadata key-value pairs that describe the original configuration of the backed-up resource. These values vary depending on the service that is being restored.
(string) --
(string) --
ResourceType (string) --
This is the resource type associated with the recovery point.
{'BackupJobs': {'InitiationDate': 'timestamp'}}
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.
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. They consist of lowercase letters, numbers, and hyphens.
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
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
Storage Gateway for Storage Gateway
S3 for Amazon S3
VirtualMachine for 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',
'RecoveryPointArn': 'string',
'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',
'BackupPlanVersion': 'string',
'BackupRuleId': '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. They consist of lowercase letters, numbers, and hyphens.
BackupVaultArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .
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 .
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.
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 .
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.
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) --
This is the non-unique name of the resource that belongs to the specified backup.
InitiationDate (datetime) --
This is 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.
{'Results': {'LastBackupVaultArn': 'string', 'LastRecoveryPointArn': 'string'}}
Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
See also: AWS API Documentation
Request Syntax
client.list_protected_resources(
NextToken='string',
MaxResults=123
)
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.
dict
Response Syntax
{
'Results': [
{
'ResourceArn': 'string',
'ResourceType': 'string',
'LastBackupTime': datetime(2015, 1, 1),
'ResourceName': 'string',
'LastBackupVaultArn': 'string',
'LastRecoveryPointArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Results (list) --
An array of resources successfully backed up by Backup including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
(dict) --
A structure that contains information about a backed-up resource.
ResourceArn (string) --
An Amazon Resource Name (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; 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.
LastBackupTime (datetime) --
The date and time a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
ResourceName (string) --
This is the non-unique name of the resource that belongs to the specified backup.
LastBackupVaultArn (string) --
This is the ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.
LastRecoveryPointArn (string) --
This is the ARN (Amazon Resource Name) of the most recent recovery point.
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.
{'Results': {'LastBackupVaultArn': 'string', 'LastRecoveryPointArn': 'string'}}
This request lists the protected resources corresponding to each backup vault.
See also: AWS API Documentation
Request Syntax
client.list_protected_resources_by_backup_vault(
BackupVaultName='string',
BackupVaultAccountId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
This is the list of protected resources by backup vault within the vault(s) you specify by name.
string
This is the list of protected resources by backup vault within the vault(s) you specify 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.
dict
Response Syntax
{
'Results': [
{
'ResourceArn': 'string',
'ResourceType': 'string',
'LastBackupTime': datetime(2015, 1, 1),
'ResourceName': 'string',
'LastBackupVaultArn': 'string',
'LastRecoveryPointArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Results (list) --
These are the results returned for the request ListProtectedResourcesByBackupVault.
(dict) --
A structure that contains information about a backed-up resource.
ResourceArn (string) --
An Amazon Resource Name (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; 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.
LastBackupTime (datetime) --
The date and time a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
ResourceName (string) --
This is the non-unique name of the resource that belongs to the specified backup.
LastBackupVaultArn (string) --
This is the ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.
LastRecoveryPointArn (string) --
This is the ARN (Amazon Resource Name) of the most recent recovery point.
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': {'OptInToArchiveForSupportedResources': 'boolean'}}}
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. They consist of lowercase letters, numbers, and hyphens.
Note
Backup vault name might not be available when a supported service creates the backup.
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.
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',
'BackupPlanVersion': 'string',
'BackupRuleId': 'string'
},
'IamRoleArn': 'string',
'Status': 'COMPLETED'|'PARTIAL'|'DELETING'|'EXPIRED',
'StatusMessage': 'string',
'CreationDate': 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
},
'EncryptionKeyArn': 'string',
'IsEncrypted': True|False,
'LastRestoreTime': datetime(2015, 1, 1),
'ParentRecoveryPointArn': 'string',
'CompositeMemberIdentifier': 'string',
'IsParent': True|False,
'ResourceName': 'string'
},
]
}
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. They consist of lowercase letters, numbers, and hyphens.
BackupVaultArn (string) --
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012: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 .
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.
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 reason of the recovery point deletion failure.
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.
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 are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
MoveToColdStorageAfterDays (integer) --
Specifies the number of days after creation that a recovery point is moved to cold storage.
DeleteAfterDays (integer) --
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays .
OptInToArchiveForSupportedResources (boolean) --
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
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) --
This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
CompositeMemberIdentifier (string) --
This is 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) --
This is the non-unique name of the resource that belongs to the specified backup.
{'ByRestoreTestingPlanArn': 'string'}
Response {'RestoreJobs': {'CreatedBy': {'RestoreTestingPlanArn': 'string'},
'DeletionStatus': 'DELETING | FAILED | SUCCESSFUL',
'DeletionStatusMessage': 'string',
'RecoveryPointCreationDate': 'timestamp',
'ValidationStatus': 'FAILED | SUCCESSFUL | TIMED_OUT | '
'VALIDATING',
'ValidationStatusMessage': 'string'}}
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
See also: AWS API Documentation
Request Syntax
client.list_restore_jobs(
NextToken='string',
MaxResults=123,
ByAccountId='string',
ByCreatedBefore=datetime(2015, 1, 1),
ByCreatedAfter=datetime(2015, 1, 1),
ByStatus='PENDING'|'RUNNING'|'COMPLETED'|'ABORTED'|'FAILED',
ByCompleteBefore=datetime(2015, 1, 1),
ByCompleteAfter=datetime(2015, 1, 1),
ByRestoreTestingPlanArn='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
The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.
datetime
Returns only restore jobs that were created before the specified date.
datetime
Returns only restore jobs that were created after the specified date.
string
Returns only restore jobs associated with the specified job status.
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 returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).
dict
Response Syntax
{
'RestoreJobs': [
{
'AccountId': 'string',
'RestoreJobId': 'string',
'RecoveryPointArn': 'string',
'CreationDate': datetime(2015, 1, 1),
'CompletionDate': datetime(2015, 1, 1),
'Status': 'PENDING'|'RUNNING'|'COMPLETED'|'ABORTED'|'FAILED',
'StatusMessage': 'string',
'PercentDone': 'string',
'BackupSizeInBytes': 123,
'IamRoleArn': 'string',
'ExpectedCompletionTimeMinutes': 123,
'CreatedResourceArn': 'string',
'ResourceType': 'string',
'RecoveryPointCreationDate': datetime(2015, 1, 1),
'CreatedBy': {
'RestoreTestingPlanArn': 'string'
},
'ValidationStatus': 'FAILED'|'SUCCESSFUL'|'TIMED_OUT'|'VALIDATING',
'ValidationStatusMessage': 'string',
'DeletionStatus': 'DELETING'|'FAILED'|'SUCCESSFUL',
'DeletionStatusMessage': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RestoreJobs (list) --
An array of objects that contain detailed information about jobs to restore saved resources.
(dict) --
Contains metadata about a restore job.
AccountId (string) --
The account ID that owns the restore job.
RestoreJobId (string) --
Uniquely identifies the job that restores a recovery point.
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 .
CreationDate (datetime) --
The date and time a restore 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 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.
Status (string) --
A status code specifying the state of the job initiated by Backup to restore a recovery point.
StatusMessage (string) --
A detailed message explaining the status of the job to restore a recovery point.
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 the restored resource.
IamRoleArn (string) --
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access .
ExpectedCompletionTimeMinutes (integer) --
The amount of time in minutes that a job restoring a recovery point is expected to take.
CreatedResourceArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
ResourceType (string) --
The resource type of the listed restore jobs; 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.
RecoveryPointCreationDate (datetime) --
The date on which a recovery point was created.
CreatedBy (dict) --
Contains identifying information about the creation of a restore job.
RestoreTestingPlanArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
ValidationStatus (string) --
This is the status of validation run on the indicated restore job.
ValidationStatusMessage (string) --
This describes the status of validation run on the indicated restore job.
DeletionStatus (string) --
This notes the status of the data generated by the restore test. The status may be Deleting , Failed , or Successful .
DeletionStatusMessage (string) --
This describes the restore job deletion status.
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.
{'Lifecycle': {'OptInToArchiveForSupportedResources': 'boolean'}}
Starts an on-demand backup job for the specified resource.
See also: AWS API Documentation
Request Syntax
client.start_backup_job(
BackupVaultName='string',
ResourceArn='string',
IamRoleArn='string',
IdempotencyToken='string',
StartWindowMinutes=123,
CompleteWindowMinutes=123,
Lifecycle={
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False
},
RecoveryPointTags={
'string': 'string'
},
BackupOptions={
'string': '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. They consist of lowercase letters, numbers, and hyphens.
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.
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 are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of 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) --
Specifies the number of days after creation that a recovery point is moved to cold storage.
DeleteAfterDays (integer) --
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays .
OptInToArchiveForSupportedResources (boolean) --
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
dict
To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
(string) --
(string) --
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. The WindowsVSS option is not enabled by default.
(string) --
(string) --
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': {'OptInToArchiveForSupportedResources': 'boolean'}}
Starts a job to create a one-time copy of the specified resource.
Does not support continuous backups.
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
}
)
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. They consist of lowercase letters, numbers, and hyphens.
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: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.
dict
Contains an array of Transition objects specifying how long 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 cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
MoveToColdStorageAfterDays (integer) --
Specifies the number of days after creation that a recovery point is moved to cold storage.
DeleteAfterDays (integer) --
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays .
OptInToArchiveForSupportedResources (boolean) --
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
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': {'OptInToArchiveForSupportedResources': 'boolean'}},
'Lifecycle': {'OptInToArchiveForSupportedResources': 'boolean'}}}}
Updates an existing backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId .
See also: AWS API Documentation
Request Syntax
client.update_backup_plan(
BackupPlanId='string',
BackupPlan={
'BackupPlanName': 'string',
'Rules': [
{
'RuleName': 'string',
'TargetBackupVaultName': 'string',
'ScheduleExpression': 'string',
'StartWindowMinutes': 123,
'CompletionWindowMinutes': 123,
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False
},
'RecoveryPointTags': {
'string': 'string'
},
'CopyActions': [
{
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False
},
'DestinationBackupVaultArn': 'string'
},
],
'EnableContinuousBackup': True|False,
'ScheduleExpressionTimezone': 'string'
},
],
'AdvancedBackupSettings': [
{
'ResourceType': 'string',
'BackupOptions': {
'string': 'string'
}
},
]
}
)
string
[REQUIRED]
Uniquely identifies a backup plan.
dict
[REQUIRED]
Specifies 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. They consist of lowercase letters, numbers, and hyphens.
ScheduleExpression (string) --
A CRON expression in UTC specifying when Backup initiates a backup job.
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.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of 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) --
Specifies the number of days after creation that a recovery point is moved to cold storage.
DeleteAfterDays (integer) --
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays .
OptInToArchiveForSupportedResources (boolean) --
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
RecoveryPointTags (dict) --
To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
(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) --
Contains an array of Transition objects specifying how long 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 cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
MoveToColdStorageAfterDays (integer) --
Specifies the number of days after creation that a recovery point is moved to cold storage.
DeleteAfterDays (integer) --
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays .
OptInToArchiveForSupportedResources (boolean) --
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
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: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) --
This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
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) --
A list of backup options for each resource type.
ResourceType (string) --
Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide .
Valid values: EC2 .
BackupOptions (dict) --
Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
Valid values:
Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.
Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.
If you specify an invalid option, you get an InvalidParameterValueException exception.
For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.
(string) --
(string) --
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) --
A list of backup options for each resource type.
ResourceType (string) --
Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide .
Valid values: EC2 .
BackupOptions (dict) --
Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
Valid values:
Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.
Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.
If you specify an invalid option, you get an InvalidParameterValueException exception.
For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.
(string) --
(string) --
{'Lifecycle': {'OptInToArchiveForSupportedResources': 'boolean'}}
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.
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 are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
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
}
)
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. They consist of lowercase letters, numbers, and hyphens.
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) --
Specifies the number of days after creation that a recovery point is moved to cold storage.
DeleteAfterDays (integer) --
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays .
OptInToArchiveForSupportedResources (boolean) --
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
dict
Response Syntax
{
'BackupVaultArn': 'string',
'RecoveryPointArn': 'string',
'Lifecycle': {
'MoveToColdStorageAfterDays': 123,
'DeleteAfterDays': 123,
'OptInToArchiveForSupportedResources': True|False
},
'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: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 are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
MoveToColdStorageAfterDays (integer) --
Specifies the number of days after creation that a recovery point is moved to cold storage.
DeleteAfterDays (integer) --
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays .
OptInToArchiveForSupportedResources (boolean) --
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
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.