AWS Backup
Developer Guide

DescribeRestoreJob

Returns metadata associated with a restore job that is specified by a job ID.

Request Syntax

GET /restore-jobs/restoreJobId HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

RestoreJobId

Uniquely identifies the job that restores a recovery point.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "BackupSizeInBytes": number, "CompletionDate": number, "CreatedResourceArn": "string", "CreationDate": number, "ExpectedCompletionTimeMinutes": number, "IamRoleArn": "string", "PercentDone": "string", "RecoveryPointArn": "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.

BackupSizeInBytes

The size, in bytes, of the restored resource.

Type: Long

CompletionDate

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.

Type: Timestamp

CreatedResourceArn

An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.

Type: String

CreationDate

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.

Type: Timestamp

ExpectedCompletionTimeMinutes

The amount of time in minutes that a job restoring a recovery point is expected to take.

Type: Long

IamRoleArn

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Type: String

PercentDone

Contains an estimated percentage that is complete of a job at the time the job status was queried.

Type: String

RecoveryPointArn

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Type: String

RestoreJobId

Uniquely identifies the job that restores a recovery point.

Type: String

Status

Status code specifying the state of the job that is initiated by AWS Backup to restore a recovery point.

Type: String

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

StatusMessage

A detailed message explaining the status of a job to restore a recovery point.

Type: String

Errors

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

DependencyFailureException

A dependent AWS service or resource returned an error to the AWS Backup service, and the action cannot be completed.

HTTP Status Code: 500

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: