Skip to content
AWS for Query.Farm

aws.backup.describe_restore_job

Example SQL Queries

SELECT * FROM
aws.backup.describe_restore_job
WHERE
"restore_job_id" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
restore_job_id Required Input Column

Uniquely identifies the job that restores a recovery point.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
account_id

Returns the account ID that owns the restore job.

VARCHAR
backup_size_in_bytes

The size, in bytes, of the restored resource.

BIGINT
completion_date

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.

TIMESTAMP_S
created_by

Contains identifying information about the creation of a restore job.

STRUCT(
    "restore_testing_plan_arn" VARCHAR
)
Show child fields
created_by.restore_testing_plan_arn

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

created_resource_arn

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.

VARCHAR
creation_date

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.

TIMESTAMP_S
deletion_status

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

VARCHAR
deletion_status_message

This describes the restore job deletion status.

VARCHAR
expected_completion_time_minutes

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

BIGINT
iam_role_arn

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

VARCHAR
percent_done

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

VARCHAR
recovery_point_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.

VARCHAR
recovery_point_creation_date

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

TIMESTAMP_S
resource_type

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

VARCHAR
status

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

VARCHAR
status_message

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

VARCHAR
validation_status

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

VARCHAR
validation_status_message

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

VARCHAR