Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListRestoreJobs

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

Request Syntax


GET /restore-jobs/?accountId=ByAccountId&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&nextToken=NextToken&resourceType=ByResourceType&restoreTestingPlanArn=ByRestoreTestingPlanArn&status=ByStatus HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ByAccountId

The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.

Pattern: ^[0-9]{12}$

ByCompleteAfter

Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

ByCompleteBefore

Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

ByCreatedAfter

Returns only restore jobs that were created after the specified date.

ByCreatedBefore

Returns only restore jobs that were created before the specified date.

ByResourceType

Include this parameter to return only restore jobs for the specified resources:

Aurora for Amazon Aurora
CloudFormation for AWS 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 AWS Storage Gateway
Timestream for Amazon Timestream
VirtualMachine for VMware virtual machines

Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

ByRestoreTestingPlanArn

This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).

ByStatus

Returns only restore jobs associated with the specified job status.

Valid Values: PENDING | RUNNING | COMPLETED | ABORTED | FAILED

MaxResults

The maximum number of items to be returned.

Valid Range: Minimum value of 1. Maximum value of 1000.

NextToken

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.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RestoreJobs": [ 
      { 
         "AccountId": "string",
         "BackupSizeInBytes": number,
         "CompletionDate": number,
         "CreatedBy": { 
            "RestoreTestingPlanArn": "string"
         },
         "CreatedResourceArn": "string",
         "CreationDate": number,
         "DeletionStatus": "string",
         "DeletionStatusMessage": "string",
         "ExpectedCompletionTimeMinutes": number,
         "IamRoleArn": "string",
         "PercentDone": "string",
         "RecoveryPointArn": "string",
         "RecoveryPointCreationDate": number,
         "ResourceType": "string",
         "RestoreJobId": "string",
         "Status": "string",
         "StatusMessage": "string",
         "ValidationStatus": "string",
         "ValidationStatusMessage": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

Type: String

RestoreJobs

An array of objects that contain detailed information about jobs to restore saved resources.

Type: Array of RestoreJobsListMember objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterValueException

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

HTTP Status Code: 400

MissingParameterValueException

Indicates that a required parameter is missing.

HTTP Status Code: 400

ResourceNotFoundException

A resource that is required for the action doesn't exist.

HTTP Status Code: 400

ServiceUnavailableException

The request failed due to a temporary failure of the server.

HTTP Status Code: 500