Skip to content
AWS for Query.Farm

aws.redshift_serverless.get_table_restore_status

Example SQL Queries

SELECT * FROM
aws.redshift_serverless.get_table_restore_status
WHERE
"table_restore_request_id" = 'VALUE';

Description

Returns information about a TableRestoreStatus object.

Table Definition

Column NameColumn Data Type
table_restore_request_id Required Input Column

The ID of the RestoreTableFromSnapshot request to return status for.

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
table_restore_status

The returned TableRestoreStatus object that contains information about the status of your RestoreTableFromSnapshot request.

STRUCT(
    "message" VARCHAR,
    "namespace_name" VARCHAR,
    "new_table_name" VARCHAR,
    "progress_in_mega_bytes" BIGINT,
    "recovery_point_id" VARCHAR,
    "request_time" TIMESTAMP_S,
    "snapshot_name" VARCHAR,
    "source_database_name" VARCHAR,
    "source_schema_name" VARCHAR,
    "source_table_name" VARCHAR,
    "status" VARCHAR,
    "table_restore_request_id" VARCHAR,
    "target_database_name" VARCHAR,
    "target_schema_name" VARCHAR,
    "total_data_in_mega_bytes" BIGINT,
    "workgroup_name" VARCHAR
)
Show child fields
table_restore_status.message

A message that explains the returned status. For example, if the status of the operation is FAILED, the message explains why the operation failed.

table_restore_status.namespace_name

The namespace of the table being restored from.

table_restore_status.new_table_name

The name of the table to create from the restore operation.

table_restore_status.progress_in_mega_bytes

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

table_restore_status.recovery_point_id

The ID of the recovery point being restored from.

table_restore_status.request_time

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

table_restore_status.snapshot_name

The name of the snapshot being restored from.

table_restore_status.source_database_name

The name of the source database being restored from.

table_restore_status.source_schema_name

The name of the source schema being restored from.

table_restore_status.source_table_name

The name of the source table being restored from.

table_restore_status.status

A value that describes the current state of the table restore request. Possible values are SUCCEEDED, FAILED, CANCELED, PENDING, and IN_PROGRESS.

table_restore_status.table_restore_request_id

The ID of the RestoreTableFromSnapshot request.

table_restore_status.target_database_name

The name of the database to restore to.

table_restore_status.target_schema_name

The name of the schema to restore to.

table_restore_status.total_data_in_mega_bytes

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

table_restore_status.workgroup_name

The name of the workgroup being restored from.