v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1472262334.5 KB

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

get/restore-jobs/{restoreJobId}

Path parameters

restoreJobIdstring required

Uniquely identifies the job that restores a recovery point.

Response

Success

AccountIdstring

Returns the account ID that owns the restore job.

RestoreJobIdstring

Uniquely identifies the job that restores a recovery point.

RecoveryPointArnstring

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

CreationDatestring date-time

The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

CompletionDatestring date-time

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 <code>CompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Status'PENDING' | 'RUNNING' | 'COMPLETED' | 'ABORTED' | 'FAILED'

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

StatusMessagestring

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

PercentDonestring

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

BackupSizeInBytesinteger

The size, in bytes, of the restored resource.

IamRoleArnstring

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

ExpectedCompletionTimeMinutesinteger

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

CreatedResourceArnstring

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.

ResourceTypestring

Returns metadata associated with a restore job listed by resource type.