2022/11/28 - AWS Backup - 6 new 13 updated api methods
Changes AWS Backup introduces support for legal hold and application stack backups. AWS Backup Audit Manager introduces support for cross-Region, cross-account reports.
This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.
See also: AWS API Documentation
Request Syntax
client.get_legal_hold(
LegalHoldId='string'
)
string
[REQUIRED]
This is the ID required to use GetLegalHold . This unique ID is associated with a specific legal hold.
dict
Response Syntax
{
'Title': 'string',
'Status': 'CREATING'|'ACTIVE'|'CANCELING'|'CANCELED',
'Description': 'string',
'CancelDescription': 'string',
'LegalHoldId': 'string',
'LegalHoldArn': 'string',
'CreationDate': datetime(2015, 1, 1),
'CancellationDate': datetime(2015, 1, 1),
'RetainRecordUntil': datetime(2015, 1, 1),
'RecoveryPointSelection': {
'VaultNames': [
'string',
],
'ResourceIdentifiers': [
'string',
],
'DateRange': {
'FromDate': datetime(2015, 1, 1),
'ToDate': datetime(2015, 1, 1)
}
}
}
Response Structure
(dict) --
Title (string) --
This is the string title of the legal hold.
Status (string) --
This is the status of the legal hold. Statuses can be ACTIVE , CREATING , CANCELED , and CANCELING .
Description (string) --
This is the returned string description of the legal hold.
CancelDescription (string) --
String describing the reason for removing the legal hold.
LegalHoldId (string) --
This is the returned ID associated with a specified legal hold.
LegalHoldArn (string) --
This is the returned framework ARN for the specified legal hold. An Amazon Resource Name (ARN) uniquely identifies a resource. The format of the ARN depends on the resource type.
CreationDate (datetime) --
Time in number format when legal hold was created.
CancellationDate (datetime) --
Time in number when legal hold was cancelled.
RetainRecordUntil (datetime) --
This is the date and time until which the legal hold record will be retained.
RecoveryPointSelection (dict) --
This specifies criteria to assign a set of resources, such as resource types or backup vaults.
VaultNames (list) --
These are the names of the vaults in which the selected recovery points are contained.
(string) --
ResourceIdentifiers (list) --
These are the resources included in the resource selection (including type of resources and vaults).
(string) --
DateRange (dict) --
This is a resource filter containing FromDate: DateTime and ToDate: DateTime. Both values are required. Future DateTime values are not permitted.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds ((milliseconds are optional). For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
FromDate (datetime) --
This value is the beginning date, inclusive.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).
ToDate (datetime) --
This value is the end date, inclusive.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).
This action returns metadata about active and previous legal holds.
See also: AWS API Documentation
Request Syntax
client.list_legal_holds(
NextToken='string',
MaxResults=123
)
string
The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, 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 resource list items to be returned.
dict
Response Syntax
{
'NextToken': 'string',
'LegalHolds': [
{
'Title': 'string',
'Status': 'CREATING'|'ACTIVE'|'CANCELING'|'CANCELED',
'Description': 'string',
'LegalHoldId': 'string',
'LegalHoldArn': 'string',
'CreationDate': datetime(2015, 1, 1),
'CancellationDate': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
NextToken (string) --
The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
LegalHolds (list) --
This is an array of returned legal holds, both active and previous.
(dict) --
A legal hold is an administrative tool that helps prevent backups from being deleted while under a hold. While the hold is in place, backups under a hold cannot be deleted and lifecycle policies that would alter the backup status (such as transition to cold storage) are delayed until the legal hold is removed. A backup can have more than one legal hold. Legal holds are applied to one or more backups (also known as recovery points). These backups can be filtered by resource types and by resource IDs.
Title (string) --
This is the title of a legal hold.
Status (string) --
This is the status of the legal hold. Statuses can be ACTIVE , CREATING , CANCELED , and CANCELING .
Description (string) --
This is the description of a legal hold.
LegalHoldId (string) --
ID of specific legal hold on one or more recovery points.
LegalHoldArn (string) --
This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .
CreationDate (datetime) --
This is the time in number format when legal hold was created.
CancellationDate (datetime) --
This is the time in number format when legal hold was cancelled.
This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.
See also: AWS API Documentation
Request Syntax
client.disassociate_recovery_point_from_parent(
BackupVaultName='string',
RecoveryPointArn='string'
)
string
[REQUIRED]
This is the name of a logical container where the child (nested) recovery point is 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]
This is the Amazon Resource Name (ARN) that uniquely identifies the child (nested) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
None
This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.
See also: AWS API Documentation
Request Syntax
client.cancel_legal_hold(
LegalHoldId='string',
CancelDescription='string',
RetainRecordInDays=123
)
string
[REQUIRED]
Legal hold ID required to remove the specified legal hold on a recovery point.
string
[REQUIRED]
String describing the reason for removing the legal hold.
integer
The integer amount in days specifying amount of days after this API operation to remove legal hold.
dict
Response Syntax
{}
Response Structure
(dict) --
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
See also: AWS API Documentation
Request Syntax
client.list_recovery_points_by_legal_hold(
LegalHoldId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
This is the ID of the legal hold.
string
This is the next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
integer
This is the maximum number of resource list items to be returned.
dict
Response Syntax
{
'RecoveryPoints': [
{
'RecoveryPointArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RecoveryPoints (list) --
This is a list of the recovery points returned by ListRecoveryPointsByLegalHold .
(dict) --
This is a recovery point which is a child (nested) recovery point of a parent (composite) recovery point. These recovery points can be disassociated from their parent (composite) recovery point, in which case they will no longer be a member.
RecoveryPointArn (string) --
This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
NextToken (string) --
This return is the next item following a partial list of returned resources.
This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.
See also: AWS API Documentation
Request Syntax
client.create_legal_hold(
Title='string',
Description='string',
IdempotencyToken='string',
RecoveryPointSelection={
'VaultNames': [
'string',
],
'ResourceIdentifiers': [
'string',
],
'DateRange': {
'FromDate': datetime(2015, 1, 1),
'ToDate': datetime(2015, 1, 1)
}
},
Tags={
'string': 'string'
}
)
string
[REQUIRED]
This is the string title of the legal hold.
string
[REQUIRED]
This is the string description of the legal hold.
string
This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.
dict
This specifies criteria to assign a set of resources, such as resource types or backup vaults.
VaultNames (list) --
These are the names of the vaults in which the selected recovery points are contained.
(string) --
ResourceIdentifiers (list) --
These are the resources included in the resource selection (including type of resources and vaults).
(string) --
DateRange (dict) --
This is a resource filter containing FromDate: DateTime and ToDate: DateTime. Both values are required. Future DateTime values are not permitted.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds ((milliseconds are optional). For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
FromDate (datetime) -- [REQUIRED]
This value is the beginning date, inclusive.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).
ToDate (datetime) -- [REQUIRED]
This value is the end date, inclusive.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).
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
{
'Title': 'string',
'Status': 'CREATING'|'ACTIVE'|'CANCELING'|'CANCELED',
'Description': 'string',
'LegalHoldId': 'string',
'LegalHoldArn': 'string',
'CreationDate': datetime(2015, 1, 1),
'RecoveryPointSelection': {
'VaultNames': [
'string',
],
'ResourceIdentifiers': [
'string',
],
'DateRange': {
'FromDate': datetime(2015, 1, 1),
'ToDate': datetime(2015, 1, 1)
}
}
}
Response Structure
(dict) --
Title (string) --
This is the string title of the legal hold returned after creating the legal hold.
Status (string) --
This displays the status of the legal hold returned after creating the legal hold. Statuses can be ACTIVE , PENDING , CANCELED , CANCELING , or FAILED .
Description (string) --
This is the returned string description of the legal hold.
LegalHoldId (string) --
Legal hold ID returned for the specified legal hold on a recovery point.
LegalHoldArn (string) --
This is the ARN (Amazon Resource Number) of the created legal hold.
CreationDate (datetime) --
Time in number format when legal hold was created.
RecoveryPointSelection (dict) --
This specifies criteria to assign a set of resources, such as resource types or backup vaults.
VaultNames (list) --
These are the names of the vaults in which the selected recovery points are contained.
(string) --
ResourceIdentifiers (list) --
These are the resources included in the resource selection (including type of resources and vaults).
(string) --
DateRange (dict) --
This is a resource filter containing FromDate: DateTime and ToDate: DateTime. Both values are required. Future DateTime values are not permitted.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds ((milliseconds are optional). For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
FromDate (datetime) --
This value is the beginning date, inclusive.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).
ToDate (datetime) --
This value is the end date, inclusive.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).
{'ReportSetting': {'Accounts': ['string'],
'OrganizationUnits': ['string'],
'Regions': ['string']}}
Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it.
If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.
See also: AWS API Documentation
Request Syntax
client.create_report_plan(
ReportPlanName='string',
ReportPlanDescription='string',
ReportDeliveryChannel={
'S3BucketName': 'string',
'S3KeyPrefix': 'string',
'Formats': [
'string',
]
},
ReportSetting={
'ReportTemplate': 'string',
'FrameworkArns': [
'string',
],
'NumberOfFrameworks': 123,
'Accounts': [
'string',
],
'OrganizationUnits': [
'string',
],
'Regions': [
'string',
]
},
ReportPlanTags={
'string': 'string'
},
IdempotencyToken='string'
)
string
[REQUIRED]
The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
string
An optional description of the report plan with a maximum of 1,024 characters.
dict
[REQUIRED]
A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
S3BucketName (string) -- [REQUIRED]
The unique name of the S3 bucket that receives your reports.
S3KeyPrefix (string) --
The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix /Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
Formats (list) --
A list of the format of your reports: CSV , JSON , or both. If not specified, the default format is CSV .
(string) --
dict
[REQUIRED]
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT , this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
ReportTemplate (string) -- [REQUIRED]
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
FrameworkArns (list) --
The Amazon Resource Names (ARNs) of the frameworks a report covers.
(string) --
NumberOfFrameworks (integer) --
The number of frameworks a report covers.
Accounts (list) --
These are the accounts to be included in the report.
(string) --
OrganizationUnits (list) --
These are the Organizational Units to be included in the report.
(string) --
Regions (list) --
These are the Regions to be included in the report.
(string) --
dict
Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
(string) --
(string) --
string
A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput . Retrying a successful request with the same idempotency token results in a success message with no action taken.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ReportPlanName': 'string',
'ReportPlanArn': 'string',
'CreationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ReportPlanName (string) --
The unique name of the report plan.
ReportPlanArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
CreationTime (datetime) --
The date and time a backup vault is 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.
{'ChildJobsInState': {'CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL': 'long'},
'IsParent': 'boolean',
'NumberOfChildJobs': 'long',
'ParentJobId': 'string',
'State': {'PARTIAL'}}
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
}
}
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 resource recovery point.
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) --
{'CopyJob': {'ChildJobsInState': {'CREATED | RUNNING | COMPLETED | FAILED | PARTIAL': 'long'},
'CompositeMemberIdentifier': 'string',
'IsParent': 'boolean',
'NumberOfChildJobs': 'long',
'ParentJobId': 'string',
'State': {'PARTIAL'}}}
Returns metadata associated with creating a copy of a resource.
See also: AWS API Documentation
Request Syntax
client.describe_copy_job(
CopyJobId='string'
)
string
[REQUIRED]
Uniquely identifies a copy job.
dict
Response Syntax
{
'CopyJob': {
'AccountId': 'string',
'CopyJobId': 'string',
'SourceBackupVaultArn': 'string',
'SourceRecoveryPointArn': 'string',
'DestinationBackupVaultArn': 'string',
'DestinationRecoveryPointArn': 'string',
'ResourceArn': 'string',
'CreationDate': datetime(2015, 1, 1),
'CompletionDate': datetime(2015, 1, 1),
'State': 'CREATED'|'RUNNING'|'COMPLETED'|'FAILED'|'PARTIAL',
'StatusMessage': 'string',
'BackupSizeInBytes': 123,
'IamRoleArn': 'string',
'CreatedBy': {
'BackupPlanId': 'string',
'BackupPlanArn': 'string',
'BackupPlanVersion': 'string',
'BackupRuleId': 'string'
},
'ResourceType': 'string',
'ParentJobId': 'string',
'IsParent': True|False,
'CompositeMemberIdentifier': 'string',
'NumberOfChildJobs': 123,
'ChildJobsInState': {
'string': 123
}
}
}
Response Structure
(dict) --
CopyJob (dict) --
Contains detailed information about a copy job.
AccountId (string) --
The account ID that owns the copy job.
CopyJobId (string) --
Uniquely identifies a copy job.
SourceBackupVaultArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .
SourceRecoveryPointArn (string) --
An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .
DestinationBackupVaultArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .
DestinationRecoveryPointArn (string) --
An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .
ResourceArn (string) --
The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
CreationDate (datetime) --
The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
CompletionDate (datetime) --
The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
State (string) --
The current state of a copy job.
StatusMessage (string) --
A detailed message explaining the status of the job to copy a resource.
BackupSizeInBytes (integer) --
The size, in bytes, of a copy job.
IamRoleArn (string) --
Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access .
CreatedBy (dict) --
Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.
BackupPlanId (string) --
Uniquely identifies a backup plan.
BackupPlanArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 .
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 copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
ParentJobId (string) --
This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.
IsParent (boolean) --
This is a boolean value indicating this is a parent (composite) copy job.
CompositeMemberIdentifier (string) --
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.
NumberOfChildJobs (integer) --
This is the number of child (nested) copy jobs.
ChildJobsInState (dict) --
This returns the statistics of the included child (nested) copy jobs.
(string) --
(integer) --
{'CompositeMemberIdentifier': 'string',
'IsParent': 'boolean',
'ParentRecoveryPointArn': 'string'}
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'
)
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
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
},
'EncryptionKeyArn': 'string',
'IsEncrypted': True|False,
'StorageClass': 'WARM'|'COLD'|'DELETED',
'LastRestoreTime': datetime(2015, 1, 1),
'ParentRecoveryPointArn': 'string',
'CompositeMemberIdentifier': 'string',
'IsParent': True|False
}
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.
StatusMessage (string) --
A status message explaining the reason for the recovery point deletion failure.
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 .
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.
{'ReportPlan': {'ReportSetting': {'Accounts': ['string'],
'OrganizationUnits': ['string'],
'Regions': ['string']}}}
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.describe_report_plan(
ReportPlanName='string'
)
string
[REQUIRED]
The unique name of a report plan.
dict
Response Syntax
{
'ReportPlan': {
'ReportPlanArn': 'string',
'ReportPlanName': 'string',
'ReportPlanDescription': 'string',
'ReportSetting': {
'ReportTemplate': 'string',
'FrameworkArns': [
'string',
],
'NumberOfFrameworks': 123,
'Accounts': [
'string',
],
'OrganizationUnits': [
'string',
],
'Regions': [
'string',
]
},
'ReportDeliveryChannel': {
'S3BucketName': 'string',
'S3KeyPrefix': 'string',
'Formats': [
'string',
]
},
'DeploymentStatus': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastAttemptedExecutionTime': datetime(2015, 1, 1),
'LastSuccessfulExecutionTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
ReportPlan (dict) --
Returns details about the report plan that is specified by its name. These details include the report plan's Amazon Resource Name (ARN), description, settings, delivery channel, deployment status, creation time, and last attempted and successful run times.
ReportPlanArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
ReportPlanName (string) --
The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
ReportPlanDescription (string) --
An optional description of the report plan with a maximum 1,024 characters.
ReportSetting (dict) --
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT , this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
ReportTemplate (string) --
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
FrameworkArns (list) --
The Amazon Resource Names (ARNs) of the frameworks a report covers.
(string) --
NumberOfFrameworks (integer) --
The number of frameworks a report covers.
Accounts (list) --
These are the accounts to be included in the report.
(string) --
OrganizationUnits (list) --
These are the Organizational Units to be included in the report.
(string) --
Regions (list) --
These are the Regions to be included in the report.
(string) --
ReportDeliveryChannel (dict) --
Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
S3BucketName (string) --
The unique name of the S3 bucket that receives your reports.
S3KeyPrefix (string) --
The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix /Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
Formats (list) --
A list of the format of your reports: CSV , JSON , or both. If not specified, the default format is CSV .
(string) --
DeploymentStatus (string) --
The deployment status of a report plan. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
CreationTime (datetime) --
The date and time that a report plan is 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.
LastAttemptedExecutionTime (datetime) --
The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
LastSuccessfulExecutionTime (datetime) --
The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
{'ByParentJobId': 'string', 'ByState': {'PARTIAL'}}
Response {'BackupJobs': {'IsParent': 'boolean',
'ParentJobId': 'string',
'State': {'PARTIAL'}}}
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'
)
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.
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
},
],
'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 resource recovery point.
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.
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.
{'ByParentJobId': 'string', 'ByState': {'PARTIAL'}}
Response {'CopyJobs': {'ChildJobsInState': {'CREATED | RUNNING | COMPLETED | FAILED | PARTIAL': 'long'},
'CompositeMemberIdentifier': 'string',
'IsParent': 'boolean',
'NumberOfChildJobs': 'long',
'ParentJobId': 'string',
'State': {'PARTIAL'}}}
Returns metadata about your copy jobs.
See also: AWS API Documentation
Request Syntax
client.list_copy_jobs(
NextToken='string',
MaxResults=123,
ByResourceArn='string',
ByState='CREATED'|'RUNNING'|'COMPLETED'|'FAILED'|'PARTIAL',
ByCreatedBefore=datetime(2015, 1, 1),
ByCreatedAfter=datetime(2015, 1, 1),
ByResourceType='string',
ByDestinationVaultArn='string',
ByAccountId='string',
ByCompleteBefore=datetime(2015, 1, 1),
ByCompleteAfter=datetime(2015, 1, 1),
ByParentJobId='string'
)
string
The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
integer
The maximum number of items to be returned.
string
Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
string
Returns only copy jobs that are in the specified state.
datetime
Returns only copy jobs that were created before the specified date.
datetime
Returns only copy jobs that were created after the specified date.
string
Returns only backup jobs for the specified resources:
Aurora for Amazon Aurora
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
An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .
string
The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.
datetime
Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
datetime
Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
string
This is a filter to list child (nested) jobs based on parent job ID.
dict
Response Syntax
{
'CopyJobs': [
{
'AccountId': 'string',
'CopyJobId': 'string',
'SourceBackupVaultArn': 'string',
'SourceRecoveryPointArn': 'string',
'DestinationBackupVaultArn': 'string',
'DestinationRecoveryPointArn': 'string',
'ResourceArn': 'string',
'CreationDate': datetime(2015, 1, 1),
'CompletionDate': datetime(2015, 1, 1),
'State': 'CREATED'|'RUNNING'|'COMPLETED'|'FAILED'|'PARTIAL',
'StatusMessage': 'string',
'BackupSizeInBytes': 123,
'IamRoleArn': 'string',
'CreatedBy': {
'BackupPlanId': 'string',
'BackupPlanArn': 'string',
'BackupPlanVersion': 'string',
'BackupRuleId': 'string'
},
'ResourceType': 'string',
'ParentJobId': 'string',
'IsParent': True|False,
'CompositeMemberIdentifier': 'string',
'NumberOfChildJobs': 123,
'ChildJobsInState': {
'string': 123
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CopyJobs (list) --
An array of structures containing metadata about your copy jobs returned in JSON format.
(dict) --
Contains detailed information about a copy job.
AccountId (string) --
The account ID that owns the copy job.
CopyJobId (string) --
Uniquely identifies a copy job.
SourceBackupVaultArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .
SourceRecoveryPointArn (string) --
An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .
DestinationBackupVaultArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .
DestinationRecoveryPointArn (string) --
An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .
ResourceArn (string) --
The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
CreationDate (datetime) --
The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
CompletionDate (datetime) --
The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
State (string) --
The current state of a copy job.
StatusMessage (string) --
A detailed message explaining the status of the job to copy a resource.
BackupSizeInBytes (integer) --
The size, in bytes, of a copy job.
IamRoleArn (string) --
Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access .
CreatedBy (dict) --
Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.
BackupPlanId (string) --
Uniquely identifies a backup plan.
BackupPlanArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 .
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 copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
ParentJobId (string) --
This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.
IsParent (boolean) --
This is a boolean value indicating this is a parent (composite) copy job.
CompositeMemberIdentifier (string) --
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.
NumberOfChildJobs (integer) --
This is the number of child (nested) copy jobs.
ChildJobsInState (dict) --
This returns the statistics of the included child (nested) copy jobs.
(string) --
(integer) --
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.
{'ByParentRecoveryPointArn': 'string'}
Response {'RecoveryPoints': {'CompositeMemberIdentifier': 'string',
'IsParent': 'boolean',
'ParentRecoveryPointArn': 'string'}}
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',
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
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
},
'EncryptionKeyArn': 'string',
'IsEncrypted': True|False,
'LastRestoreTime': datetime(2015, 1, 1),
'ParentRecoveryPointArn': 'string',
'CompositeMemberIdentifier': 'string',
'IsParent': True|False
},
]
}
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 .
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.
{'RecoveryPoints': {'IsParent': 'boolean', 'ParentRecoveryPointArn': 'string'}}
Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).
Note
For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.
See also: AWS API Documentation
Request Syntax
client.list_recovery_points_by_resource(
ResourceArn='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
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.
Note
Amazon RDS requires a value of at least 20.
dict
Response Syntax
{
'NextToken': 'string',
'RecoveryPoints': [
{
'RecoveryPointArn': 'string',
'CreationDate': datetime(2015, 1, 1),
'Status': 'COMPLETED'|'PARTIAL'|'DELETING'|'EXPIRED',
'StatusMessage': 'string',
'EncryptionKeyArn': 'string',
'BackupSizeBytes': 123,
'BackupVaultName': 'string',
'IsParent': True|False,
'ParentRecoveryPointArn': '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 of the specified resource type.
Note
Only Amazon EFS and Amazon EC2 recovery points return BackupVaultName.
(dict) --
Contains detailed information about a saved recovery point.
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 .
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.
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.
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 .
BackupSizeBytes (integer) --
The size, in bytes, of a backup.
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.
IsParent (boolean) --
This is a boolean value indicating this is a parent (composite) recovery point.
ParentRecoveryPointArn (string) --
This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
{'ReportPlans': {'ReportSetting': {'Accounts': ['string'],
'OrganizationUnits': ['string'],
'Regions': ['string']}}}
Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan .
See also: AWS API Documentation
Request Syntax
client.list_report_plans(
MaxResults=123,
NextToken='string'
)
integer
The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
string
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
dict
Response Syntax
{
'ReportPlans': [
{
'ReportPlanArn': 'string',
'ReportPlanName': 'string',
'ReportPlanDescription': 'string',
'ReportSetting': {
'ReportTemplate': 'string',
'FrameworkArns': [
'string',
],
'NumberOfFrameworks': 123,
'Accounts': [
'string',
],
'OrganizationUnits': [
'string',
],
'Regions': [
'string',
]
},
'ReportDeliveryChannel': {
'S3BucketName': 'string',
'S3KeyPrefix': 'string',
'Formats': [
'string',
]
},
'DeploymentStatus': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastAttemptedExecutionTime': datetime(2015, 1, 1),
'LastSuccessfulExecutionTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ReportPlans (list) --
A list of your report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.
(dict) --
Contains detailed information about a report plan.
ReportPlanArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
ReportPlanName (string) --
The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
ReportPlanDescription (string) --
An optional description of the report plan with a maximum 1,024 characters.
ReportSetting (dict) --
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT , this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
ReportTemplate (string) --
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
FrameworkArns (list) --
The Amazon Resource Names (ARNs) of the frameworks a report covers.
(string) --
NumberOfFrameworks (integer) --
The number of frameworks a report covers.
Accounts (list) --
These are the accounts to be included in the report.
(string) --
OrganizationUnits (list) --
These are the Organizational Units to be included in the report.
(string) --
Regions (list) --
These are the Regions to be included in the report.
(string) --
ReportDeliveryChannel (dict) --
Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
S3BucketName (string) --
The unique name of the S3 bucket that receives your reports.
S3KeyPrefix (string) --
The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix /Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
Formats (list) --
A list of the format of your reports: CSV , JSON , or both. If not specified, the default format is CSV .
(string) --
DeploymentStatus (string) --
The deployment status of a report plan. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
CreationTime (datetime) --
The date and time that a report plan is 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.
LastAttemptedExecutionTime (datetime) --
The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
LastSuccessfulExecutionTime (datetime) --
The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
NextToken (string) --
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
{'IsParent': '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
},
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.
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.
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.
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 .
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) --
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.
{'IsParent': '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
}
)
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 .
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.
{'ReportSetting': {'Accounts': ['string'],
'OrganizationUnits': ['string'],
'Regions': ['string']}}
Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.
See also: AWS API Documentation
Request Syntax
client.update_report_plan(
ReportPlanName='string',
ReportPlanDescription='string',
ReportDeliveryChannel={
'S3BucketName': 'string',
'S3KeyPrefix': 'string',
'Formats': [
'string',
]
},
ReportSetting={
'ReportTemplate': 'string',
'FrameworkArns': [
'string',
],
'NumberOfFrameworks': 123,
'Accounts': [
'string',
],
'OrganizationUnits': [
'string',
],
'Regions': [
'string',
]
},
IdempotencyToken='string'
)
string
[REQUIRED]
The unique name of the report plan. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
string
An optional description of the report plan with a maximum 1,024 characters.
dict
A structure that contains information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
S3BucketName (string) -- [REQUIRED]
The unique name of the S3 bucket that receives your reports.
S3KeyPrefix (string) --
The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix /Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
Formats (list) --
A list of the format of your reports: CSV , JSON , or both. If not specified, the default format is CSV .
(string) --
dict
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT , this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
ReportTemplate (string) -- [REQUIRED]
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
FrameworkArns (list) --
The Amazon Resource Names (ARNs) of the frameworks a report covers.
(string) --
NumberOfFrameworks (integer) --
The number of frameworks a report covers.
Accounts (list) --
These are the accounts to be included in the report.
(string) --
OrganizationUnits (list) --
These are the Organizational Units to be included in the report.
(string) --
Regions (list) --
These are the Regions to be included in the report.
(string) --
string
A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateReportPlanInput . Retrying a successful request with the same idempotency token results in a success message with no action taken.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ReportPlanName': 'string',
'ReportPlanArn': 'string',
'CreationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ReportPlanName (string) --
The unique name of the report plan.
ReportPlanArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
CreationTime (datetime) --
The date and time that a report plan is 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.