Skip to content
AWS for Query.Farm

aws.redshift.describe_table_restore_status

Example SQL Queries

SELECT * FROM
aws.redshift.describe_table_restore_status;

Description

Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId.

Table Definition

Column NameColumn Data Type
cluster_identifier Input Column

The identifier of the Amazon Redshift cluster that the table is being restored to.

VARCHAR
table_restore_request_id Input Column

The unique identifier for the table restore request.

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
message

A description of the status of the table restore request. Status values include SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS.

VARCHAR
new_table_name

The name of the table to create as a result of the table restore request.

VARCHAR
progress_in_mega_bytes

The amount of data restored to the new table so far, in megabytes (MB).

BIGINT
request_time

The time that the table restore request was made, in Universal Coordinated Time (UTC).

TIMESTAMP_S
snapshot_identifier

The identifier of the snapshot that the table is being restored from.

VARCHAR
source_database_name

The name of the source database that contains the table being restored.

VARCHAR
source_schema_name

The name of the source schema that contains the table being restored.

VARCHAR
source_table_name

The name of the source table being restored.

VARCHAR
status

A value that describes the current state of the table restore request.

Valid Values: SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS 

VARCHAR
target_database_name

The name of the database to restore the table to.

VARCHAR
target_schema_name

The name of the schema to restore the table to.

VARCHAR
total_data_in_mega_bytes

The total amount of data to restore to the new table, in megabytes (MB).

BIGINT