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 uses the following URI parameters.
- restoreJobId
-
Uniquely identifies the job that restores a recovery point.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"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.
- AccountId
-
Returns the account ID that owns the restore job.
Type: String
Pattern:
^[0-9]{12}$ - 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
CompletionDateis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.Type: Timestamp
- CreatedBy
-
Contains identifying information about the creation of a restore job.
Type: RestoreJobCreator object
- CreatedResourceArn
-
The Amazon Resource Name (ARN) of the resource that was created by the restore job.
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
CreationDateis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.Type: Timestamp
- DeletionStatus
-
The status of the data generated by the restore test.
Type: String
Valid Values:
DELETING | FAILED | SUCCESSFUL - DeletionStatusMessage
-
This describes the restore job deletion status.
Type: String
- 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
- RecoveryPointCreationDate
-
The creation date of the recovery point made by the specifed restore job.
Type: Timestamp
- ResourceType
-
Returns metadata associated with a restore job listed by resource type.
Type: String
Pattern:
^[a-zA-Z0-9\-\_\.]{1,50}$ - 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 Amazon Backup to restore a recovery point.
Type: String
Valid Values:
PENDING | RUNNING | COMPLETED | ABORTED | FAILED - StatusMessage
-
A message showing the status of a job to restore a recovery point.
Type: String
- ValidationStatus
-
The status of validation run on the indicated restore job.
Type: String
Valid Values:
FAILED | SUCCESSFUL | TIMED_OUT | VALIDATING - ValidationStatusMessage
-
The status message.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- DependencyFailureException
-
A dependent Amazon service or resource returned an error to the Amazon 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 Amazon SDKs, see the following: