Skip to content

DescribeRestoreJobOutput

Source code in docs_src/capo_backup/types/describe_restore_job_output.py
class DescribeRestoreJobOutput(TypedDict, closed=True):
    account_id: NotRequired["capo_backup.types.account_id.AccountId"]
    """<p>Returns the account ID that owns the restore job.</p>"""
    restore_job_id: NotRequired["capo_backup.types.string.string"]
    """<p>Uniquely identifies the job that restores a recovery point.</p>"""
    recovery_point_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>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>.</p>"""
    source_resource_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>The Amazon Resource Name (ARN) of the original resource that was backed up. This provides context about what resource is being restored.</p>"""
    backup_vault_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>The Amazon Resource Name (ARN) of the backup vault containing the recovery point being restored. This helps identify vault access policies and permissions.</p>"""
    creation_date: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>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.</p>"""
    completion_date: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>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.</p>"""
    status: NotRequired["capo_backup.types.restore_job_status.RestoreJobStatus"]
    """<p>Status code specifying the state of the job that is initiated by Backup to restore a recovery point.</p>"""
    status_message: NotRequired["capo_backup.types.string.string"]
    """<p>A message showing the status of a job to restore a recovery point.</p>"""
    percent_done: NotRequired["capo_backup.types.string.string"]
    """<p>Contains an estimated percentage that is complete of a job at the time the job status was queried.</p>"""
    backup_size_in_bytes: NotRequired["capo_backup.types.long.Long"]
    """<p>The size, in bytes, of the restored resource.</p>"""
    iam_role_arn: NotRequired["capo_backup.types.iam_role_arn.IAMRoleArn"]
    """<p>Specifies the IAM role ARN used to create the target recovery point; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>"""
    expected_completion_time_minutes: NotRequired["capo_backup.types.long.Long"]
    """<p>The amount of time in minutes that a job restoring a recovery point is expected to take.</p>"""
    created_resource_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>The Amazon Resource Name (ARN) of the resource that was created by the restore job.</p> <p>The format of the ARN depends on the resource type of the backed-up resource.</p>"""
    resource_type: NotRequired["capo_backup.types.resource_type.ResourceType"]
    """<p>Returns metadata associated with a restore job listed by resource type.</p>"""
    recovery_point_creation_date: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The creation date of the recovery point made by the specifed restore job.</p>"""
    created_by: NotRequired["capo_backup.types.restore_job_creator.RestoreJobCreator"]
    """<p>Contains identifying information about the creation of a restore job.</p>"""
    validation_status: NotRequired[
        "capo_backup.types.restore_validation_status.RestoreValidationStatus"
    ]
    """<p>The status of validation run on the indicated restore job.</p>"""
    validation_status_message: NotRequired["capo_backup.types.string.string"]
    """<p>The status message.</p>"""
    deletion_status: NotRequired[
        "capo_backup.types.restore_deletion_status.RestoreDeletionStatus"
    ]
    """<p>The status of the data generated by the restore test.</p>"""
    deletion_status_message: NotRequired["capo_backup.types.string.string"]
    """<p>This describes the restore job deletion status.</p>"""
    is_parent: "capo_backup.types.boolean2.Boolean2"
    """<p>This is a boolean value indicating whether the restore job is a parent (composite) restore job.</p>"""
    parent_job_id: NotRequired["capo_backup.types.string.string"]
    """<p>This is the unique identifier of the parent restore job for the selected restore job.</p>"""

account_id instance-attribute

account_id: NotRequired[AccountId]

Returns the account ID that owns the restore job.

backup_size_in_bytes instance-attribute

backup_size_in_bytes: NotRequired[Long]

The size, in bytes, of the restored resource.

backup_vault_arn instance-attribute

backup_vault_arn: NotRequired[ARN]

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

completion_date instance-attribute

completion_date: NotRequired[timestamp]

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.

created_by instance-attribute

created_by: NotRequired[RestoreJobCreator]

Contains identifying information about the creation of a restore job.

created_resource_arn instance-attribute

created_resource_arn: NotRequired[ARN]

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.

creation_date instance-attribute

creation_date: NotRequired[timestamp]

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.

deletion_status instance-attribute

deletion_status: NotRequired[RestoreDeletionStatus]

The status of the data generated by the restore test.

deletion_status_message instance-attribute

deletion_status_message: NotRequired[string]

This describes the restore job deletion status.

expected_completion_time_minutes instance-attribute

expected_completion_time_minutes: NotRequired[Long]

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

iam_role_arn instance-attribute

iam_role_arn: NotRequired[IAMRoleArn]

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

is_parent instance-attribute

is_parent: Boolean2

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

parent_job_id instance-attribute

parent_job_id: NotRequired[string]

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

percent_done instance-attribute

percent_done: NotRequired[string]

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

recovery_point_arn instance-attribute

recovery_point_arn: NotRequired[ARN]

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

recovery_point_creation_date instance-attribute

recovery_point_creation_date: NotRequired[timestamp]

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

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

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

restore_job_id instance-attribute

restore_job_id: NotRequired[string]

Uniquely identifies the job that restores a recovery point.

source_resource_arn instance-attribute

source_resource_arn: NotRequired[ARN]

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

status instance-attribute

status: NotRequired[RestoreJobStatus]

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

status_message instance-attribute

status_message: NotRequired[string]

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

validation_status instance-attribute

validation_status: NotRequired[RestoreValidationStatus]

The status of validation run on the indicated restore job.

validation_status_message instance-attribute

validation_status_message: NotRequired[string]

The status message.