2025/11/10 - AWS Backup - 3 updated api methods
Changes AWS Backup supports backups of Amazon EKS clusters, including Kubernetes cluster state and persistent storage attached to the EKS cluster via a persistent volume claim (EBS volumes, EFS file systems, and S3 buckets).
{'IsParent': 'boolean', 'ParentJobId': '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',
'SourceResourceArn': 'string',
'BackupVaultArn': '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',
'IsParent': True|False,
'ParentJobId': '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.
SourceResourceArn (string) --
The Amazon Resource Name (ARN) of the original resource that was backed up. This provides context about what resource is being restored.
BackupVaultArn (string) --
The Amazon Resource Name (ARN) of the backup vault containing the recovery point being restored. This helps identify vault access policies and permissions.
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) --
The Amazon Resource Name (ARN) of the resource that was created by the restore job.
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) --
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) --
The status of validation run on the indicated restore job.
ValidationStatusMessage (string) --
The status message.
DeletionStatus (string) --
The status of the data generated by the restore test.
DeletionStatusMessage (string) --
This describes the restore job deletion status.
IsParent (boolean) --
This is a boolean value indicating whether the restore job is a parent (composite) restore job.
ParentJobId (string) --
This is the unique identifier of the parent restore job for the selected restore job.
{'ByParentJobId': 'string'}
Response {'RestoreJobs': {'IsParent': 'boolean', 'ParentJobId': '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',
ByResourceType='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',
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
The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.
string
Include this parameter to return only restore jobs for the specified resources:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Redshift for Amazon Redshift
S3 for Amazon Simple Storage Service (Amazon S3)
SAP HANA on Amazon EC2 for SAP HANA databases on Amazon Elastic Compute Cloud instances
Storage Gateway for Storage Gateway
Timestream for Amazon Timestream
VirtualMachine for VMware virtual machines
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).
string
This is a filter to list child (nested) restore jobs based on parent restore job ID.
dict
Response Syntax
{
'RestoreJobs': [
{
'AccountId': 'string',
'RestoreJobId': 'string',
'RecoveryPointArn': 'string',
'SourceResourceArn': 'string',
'BackupVaultArn': '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),
'IsParent': True|False,
'ParentJobId': 'string',
'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.
SourceResourceArn (string) --
The Amazon Resource Name (ARN) of the original resource that was backed up. This provides context about what resource is being restored.
BackupVaultArn (string) --
The Amazon Resource Name (ARN) of the backup vault containing the recovery point being restored. This helps identify vault access policies and permissions.
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) --
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.
IsParent (boolean) --
This is a boolean value indicating whether the restore job is a parent (composite) restore job.
ParentJobId (string) --
This is the unique identifier of the parent restore job for the selected 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) --
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.
{'RestoreJobs': {'IsParent': 'boolean', 'ParentJobId': 'string'}}
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',
'SourceResourceArn': 'string',
'BackupVaultArn': '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),
'IsParent': True|False,
'ParentJobId': 'string',
'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.
SourceResourceArn (string) --
The Amazon Resource Name (ARN) of the original resource that was backed up. This provides context about what resource is being restored.
BackupVaultArn (string) --
The Amazon Resource Name (ARN) of the backup vault containing the recovery point being restored. This helps identify vault access policies and permissions.
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) --
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.
IsParent (boolean) --
This is a boolean value indicating whether the restore job is a parent (composite) restore job.
ParentJobId (string) --
This is the unique identifier of the parent restore job for the selected 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) --
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