ListRestoreJobs - AWS Backup

ListRestoreJobs

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

Request Syntax

GET /restore-jobs/?accountId=ByAccountId&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&nextToken=NextToken&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}$

ByCreatedAfter

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

ByCreatedBefore

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

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, "CreatedResourceArn": "string", "CreationDate": number, "ExpectedCompletionTimeMinutes": number, "IamRoleArn": "string", "PercentDone": "string", "RecoveryPointArn": "string", "ResourceType": "string", "RestoreJobId": "string", "Status": "string", "StatusMessage": "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

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.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: