Backup / Client / list_restore_jobs

list_restore_jobs#

Backup.Client.list_restore_jobs(**kwargs)#

Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.

Request Syntax

response = 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'
)

Parameters:

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.
MaxResults (integer) – The maximum number of items to be returned.
ByAccountId (string) – The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.
ByResourceType (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
- Redshift for Amazon Redshift
- RDS for Amazon Relational Database Service
- SAP HANA on Amazon EC2 for SAP HANA databases
- Storage Gateway for Storage Gateway
- S3 for Amazon S3
- Timestream for Amazon Timestream
- VirtualMachine for virtual machines
ByCreatedBefore (datetime) – Returns only restore jobs that were created before the specified date.
ByCreatedAfter (datetime) – Returns only restore jobs that were created after the specified date.
ByStatus (string) – Returns only restore jobs associated with the specified job status.
ByCompleteBefore (datetime) – Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
ByCompleteAfter (datetime) – Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
ByRestoreTestingPlanArn (string) – This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).

Return type:

dict

Returns:

Response Syntax

{
    'RestoreJobs': [
        {
            'AccountId': 'string',
            'RestoreJobId': 'string',
            'RecoveryPointArn': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'CompletionDate': datetime(2015, 1, 1),
            'Status': 'PENDING'|'RUNNING'|'COMPLETED'|'ABORTED'|'FAILED',
            'StatusMessage': 'string',
            'PercentDone': 'string',
            'BackupSizeInBytes': 123,
            'IamRoleArn': 'string',
            'ExpectedCompletionTimeMinutes': 123,
            'CreatedResourceArn': 'string',
            'ResourceType': 'string',
            'RecoveryPointCreationDate': datetime(2015, 1, 1),
            'CreatedBy': {
                'RestoreTestingPlanArn': 'string'
            },
            'ValidationStatus': 'FAILED'|'SUCCESSFUL'|'TIMED_OUT'|'VALIDATING',
            'ValidationStatusMessage': 'string',
            'DeletionStatus': 'DELETING'|'FAILED'|'SUCCESSFUL',
            'DeletionStatusMessage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- RestoreJobs (list) –
  
  An array of objects that contain detailed information about jobs to restore saved resources.
  - (dict) –
    
    Contains metadata about a restore job.
    - AccountId (string) –
      
      The account ID that owns the restore job.
    - RestoreJobId (string) –
      
      Uniquely identifies the job that restores a recovery point.
    - RecoveryPointArn (string) –
      
      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    - CreationDate (datetime) –
      
      The date and time a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - CompletionDate (datetime) –
      
      The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - Status (string) –
      
      A status code specifying the state of the job initiated by Backup to restore a recovery point.
    - StatusMessage (string) –
      
      A detailed message explaining the status of the job to restore a recovery point.
    - PercentDone (string) –
      
      Contains an estimated percentage complete of a job at the time the job status was queried.
    - BackupSizeInBytes (integer) –
      
      The size, in bytes, of the restored resource.
    - IamRoleArn (string) –
      
      Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    - ExpectedCompletionTimeMinutes (integer) –
      
      The amount of time in minutes that a job restoring a recovery point is expected to take.
    - CreatedResourceArn (string) –
      
      An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
    - ResourceType (string) –
      
      The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
    - RecoveryPointCreationDate (datetime) –
      
      The date on which a recovery point was created.
    - CreatedBy (dict) –
      
      Contains identifying information about the creation of a restore job.
      - RestoreTestingPlanArn (string) –
        
        An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
    - ValidationStatus (string) –
      
      This is the status of validation run on the indicated restore job.
    - ValidationStatusMessage (string) –
      
      This describes the status of validation run on the indicated restore job.
    - DeletionStatus (string) –
      
      This notes the status of the data generated by the restore test. The status may be Deleting, Failed, or Successful.
    - DeletionStatusMessage (string) –
      
      This describes the restore job deletion status.
- NextToken (string) –
  
  The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Exceptions

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