Backup / Client / describe_restore_job

describe_restore_job

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

Request Syntax

response = client.describe_restore_job(
    RestoreJobId='string'
)

Parameters:

RestoreJobId (string) –

[REQUIRED]

Uniquely identifies the job that restores a recovery point.

Return type:

dict

Returns:

Response Syntax

{
    'AccountId': 'string',
    'RestoreJobId': 'string',
    'RecoveryPointArn': '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'
}

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.

  • 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) –

    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.

  • ResourceType (string) –

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

  • RecoveryPointCreationDate (datetime) –

    This is 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) –

    This is the status of validation run on the indicated restore job.

  • ValidationStatusMessage (string) –

    This describes the status of validation run on the indicated restore job.

  • DeletionStatus (string) –

    This notes the status of the data generated by the restore test. The status may be Deleting, Failed, or Successful.

  • DeletionStatusMessage (string) –

    This describes the restore job deletion status.

Exceptions

• Backup.Client.exceptions.ResourceNotFoundException

• Backup.Client.exceptions.InvalidParameterValueException

• Backup.Client.exceptions.MissingParameterValueException

• Backup.Client.exceptions.ServiceUnavailableException

• Backup.Client.exceptions.DependencyFailureException