:doc:`Backup <../../backup>` / Client / describe_restore_job

********************
describe_restore_job
********************



.. py:method:: Backup.Client.describe_restore_job(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRestoreJob>`_  


  **Request Syntax**
  ::

    response = client.describe_restore_job(
        RestoreJobId='string'
    )
    
  :type RestoreJobId: string
  :param RestoreJobId: **[REQUIRED]** 

    Uniquely identifies the job that restores a recovery point.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'AccountId': 'string',
          'RestoreJobId': 'string',
          'RecoveryPointArn': 'string',
          'SourceResourceArn': 'string',
          'BackupVaultArn': 'string',
          'CreationDate': datetime(2015, 1, 1),
          'CompletionDate': datetime(2015, 1, 1),
          'Status': 'PENDING'|'RUNNING'|'COMPLETED'|'ABORTED'|'FAILED',
          'StatusMessage': 'string',
          'PercentDone': 'string',
          'BackupSizeInBytes': 123,
          'IamRoleArn': 'string',
          'ExpectedCompletionTimeMinutes': 123,
          'CreatedResourceArn': 'string',
          'ResourceType': 'string',
          'RecoveryPointCreationDate': datetime(2015, 1, 1),
          'CreatedBy': {
              'RestoreTestingPlanArn': 'string'
          },
          'ValidationStatus': 'FAILED'|'SUCCESSFUL'|'TIMED_OUT'|'VALIDATING',
          'ValidationStatusMessage': 'string',
          'DeletionStatus': 'DELETING'|'FAILED'|'SUCCESSFUL',
          'DeletionStatusMessage': 'string',
          'IsParent': True|False,
          'ParentJobId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **AccountId** *(string) --* 

        Returns the account ID that owns the restore job.

        
      

      - **RestoreJobId** *(string) --* 

        Uniquely identifies the job that restores a recovery point.

        
      

      - **RecoveryPointArn** *(string) --* 

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

        
      

      - **SourceResourceArn** *(string) --* 

        The Amazon Resource Name (ARN) of the original resource that was backed up. This provides context about what resource is being restored.

        
      

      - **BackupVaultArn** *(string) --* 

        The Amazon Resource Name (ARN) of the backup vault containing the recovery point being restored. This helps identify vault access policies and permissions.

        
      

      - **CreationDate** *(datetime) --* 

        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.

        
      

      - **CompletionDate** *(datetime) --* 

        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.

        
      

      - **Status** *(string) --* 

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

        
      

      - **StatusMessage** *(string) --* 

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

        
      

      - **PercentDone** *(string) --* 

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

        
      

      - **BackupSizeInBytes** *(integer) --* 

        The size, in bytes, of the restored resource.

        
      

      - **IamRoleArn** *(string) --* 

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

        
      

      - **ExpectedCompletionTimeMinutes** *(integer) --* 

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

        
      

      - **CreatedResourceArn** *(string) --* 

        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.

        
      

      - **ResourceType** *(string) --* 

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

        
      

      - **RecoveryPointCreationDate** *(datetime) --* 

        The creation date of the recovery point made by the specifed restore job.

        
      

      - **CreatedBy** *(dict) --* 

        Contains identifying information about the creation of a restore job.

        
        

        - **RestoreTestingPlanArn** *(string) --* 

          An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.

          
    
      

      - **ValidationStatus** *(string) --* 

        The status of validation run on the indicated restore job.

        
      

      - **ValidationStatusMessage** *(string) --* 

        The status message.

        
      

      - **DeletionStatus** *(string) --* 

        The status of the data generated by the restore test.

        
      

      - **DeletionStatusMessage** *(string) --* 

        This describes the restore job deletion status.

        
      

      - **IsParent** *(boolean) --* 

        This is a boolean value indicating whether the restore job is a parent (composite) restore job.

        
      

      - **ParentJobId** *(string) --* 

        This is the unique identifier of the parent restore job for the selected restore job.

        
  
  **Exceptions**
  
  *   :py:class:`Backup.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Backup.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`Backup.Client.exceptions.MissingParameterValueException`

  
  *   :py:class:`Backup.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`Backup.Client.exceptions.DependencyFailureException`

  