# DescribeRestoreJob
<a name="API_DescribeRestoreJob"></a>

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

## Request Syntax
<a name="API_DescribeRestoreJob_RequestSyntax"></a>

```
GET /restore-jobs/restoreJobId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeRestoreJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [restoreJobId](#API_DescribeRestoreJob_RequestSyntax) **   <a name="Backup-DescribeRestoreJob-request-uri-RestoreJobId"></a>
Uniquely identifies the job that restores a recovery point.  
Required: Yes

## Request Body
<a name="API_DescribeRestoreJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeRestoreJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AccountId": "string",
   "BackupSizeInBytes": number,
   "BackupVaultArn": "string",
   "CompletionDate": number,
   "CreatedBy": { 
      "RestoreTestingPlanArn": "string"
   },
   "CreatedResourceArn": "string",
   "CreationDate": number,
   "DeletionStatus": "string",
   "DeletionStatusMessage": "string",
   "ExpectedCompletionTimeMinutes": number,
   "IamRoleArn": "string",
   "IsParent": boolean,
   "ParentJobId": "string",
   "PercentDone": "string",
   "RecoveryPointArn": "string",
   "RecoveryPointCreationDate": number,
   "ResourceType": "string",
   "RestoreJobId": "string",
   "SourceResourceArn": "string",
   "Status": "string",
   "StatusMessage": "string",
   "ValidationStatus": "string",
   "ValidationStatusMessage": "string"
}
```

## Response Elements
<a name="API_DescribeRestoreJob_ResponseElements"></a>

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](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-AccountId"></a>
Returns the account ID that owns the restore job.  
Type: String  
Pattern: `^[0-9]{12}$` 

 ** [BackupSizeInBytes](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-BackupSizeInBytes"></a>
The size, in bytes, of the restored resource.  
Type: Long

 ** [BackupVaultArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-BackupVaultArn"></a>
The Amazon Resource Name (ARN) of the backup vault containing the recovery point being restored. This helps identify vault access policies and permissions.  
Type: String

 ** [CompletionDate](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-CompletionDate"></a>
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

 ** [CreatedBy](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-CreatedBy"></a>
Contains identifying information about the creation of a restore job.  
Type: [RestoreJobCreator](API_RestoreJobCreator.md) object

 ** [CreatedResourceArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-CreatedResourceArn"></a>
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](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-CreationDate"></a>
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

 ** [DeletionStatus](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-DeletionStatus"></a>
The status of the data generated by the restore test.  
Type: String  
Valid Values: `DELETING | FAILED | SUCCESSFUL` 

 ** [DeletionStatusMessage](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-DeletionStatusMessage"></a>
This describes the restore job deletion status.  
Type: String

 ** [ExpectedCompletionTimeMinutes](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ExpectedCompletionTimeMinutes"></a>
The amount of time in minutes that a job restoring a recovery point is expected to take.  
Type: Long

 ** [IamRoleArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-IamRoleArn"></a>
Specifies the IAM role ARN used to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.  
Type: String

 ** [IsParent](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-IsParent"></a>
This is a boolean value indicating whether the restore job is a parent (composite) restore job.  
Type: Boolean

 ** [ParentJobId](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ParentJobId"></a>
This is the unique identifier of the parent restore job for the selected restore job.  
Type: String

 ** [PercentDone](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-PercentDone"></a>
Contains an estimated percentage that is complete of a job at the time the job status was queried.  
Type: String

 ** [RecoveryPointArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-RecoveryPointArn"></a>
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](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-RecoveryPointCreationDate"></a>
The creation date of the recovery point made by the specifed restore job.  
Type: Timestamp

 ** [ResourceType](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ResourceType"></a>
Returns metadata associated with a restore job listed by resource type.  
Type: String  
Pattern: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [RestoreJobId](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-RestoreJobId"></a>
Uniquely identifies the job that restores a recovery point.  
Type: String

 ** [SourceResourceArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-SourceResourceArn"></a>
The Amazon Resource Name (ARN) of the original resource that was backed up. This provides context about what resource is being restored.  
Type: String

 ** [Status](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-Status"></a>
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](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-StatusMessage"></a>
A message showing the status of a job to restore a recovery point.  
Type: String

 ** [ValidationStatus](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ValidationStatus"></a>
The status of validation run on the indicated restore job.  
Type: String  
Valid Values: `FAILED | SUCCESSFUL | TIMED_OUT | VALIDATING` 

 ** [ValidationStatusMessage](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ValidationStatusMessage"></a>
The status message.  
Type: String

## Errors
<a name="API_DescribeRestoreJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

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

HTTP Status Code: 500

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

HTTP Status Code: 400

 ** MissingParameterValueException **   
Indicates that a required parameter is missing.    
 ** Context **   
  
 ** Type **   

HTTP Status Code: 400

 ** ResourceNotFoundException **   
A resource that is required for the action doesn't exist.    
 ** Context **   
  
 ** Type **   

HTTP Status Code: 400

 ** ServiceUnavailableException **   
The request failed due to a temporary failure of the server.    
 ** Context **   
  
 ** Type **   

HTTP Status Code: 500

## See Also
<a name="API_DescribeRestoreJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeRestoreJob)