table_restore_status

Creates, updates, deletes, gets or lists a table_restore_status resource.

Overview

Name	table_restore_status
Type	Resource
Id	aws.redshift_serverless.table_restore_status

Fields

The following fields are returned by SELECT queries:

get_table_restore_status

Name	Datatype	Description
message	string	A message that explains the returned status. For example, if the status of the operation is FAILED, the message explains why the operation failed.
namespace_name	string	The namespace of the table being restored from.
new_table_name	string	The name of the table to create from the restore operation.
progress_in_mega_bytes	integer (int64)	The amount of data restored to the new table so far, in megabytes (MB).
recovery_point_id	string	The ID of the recovery point being restored from.
request_time	string (date-time)	The time that the table restore request was made, in Universal Coordinated Time (UTC).
snapshot_name	string	The name of the snapshot being restored from.
source_database_name	string	The name of the source database being restored from.
source_schema_name	string	The name of the source schema being restored from.
source_table_name	string	The name of the source table being restored from.
status	string	A value that describes the current state of the table restore request. Possible values are SUCCEEDED, FAILED, CANCELED, PENDING, and IN_PROGRESS.
table_restore_request_id	string	The ID of the RestoreTableFromSnapshot request.
target_database_name	string	The name of the database to restore to.
target_schema_name	string	The name of the schema to restore to.
total_data_in_mega_bytes	integer (int64)	The total amount of data to restore to the new table, in megabytes (MB).
workgroup_name	string	The name of the workgroup being restored from.

list_table_restore_status

Name	Datatype	Description
message	string	A message that explains the returned status. For example, if the status of the operation is FAILED, the message explains why the operation failed.
namespace_name	string	The namespace of the table being restored from.
new_table_name	string	The name of the table to create from the restore operation.
progress_in_mega_bytes	integer (int64)	The amount of data restored to the new table so far, in megabytes (MB).
recovery_point_id	string	The ID of the recovery point being restored from.
request_time	string (date-time)	The time that the table restore request was made, in Universal Coordinated Time (UTC).
snapshot_name	string	The name of the snapshot being restored from.
source_database_name	string	The name of the source database being restored from.
source_schema_name	string	The name of the source schema being restored from.
source_table_name	string	The name of the source table being restored from.
status	string	A value that describes the current state of the table restore request. Possible values are SUCCEEDED, FAILED, CANCELED, PENDING, and IN_PROGRESS.
table_restore_request_id	string	The ID of the RestoreTableFromSnapshot request.
target_database_name	string	The name of the database to restore to.
target_schema_name	string	The name of the schema to restore to.
total_data_in_mega_bytes	integer (int64)	The total amount of data to restore to the new table, in megabytes (MB).
workgroup_name	string	The name of the workgroup being restored from.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_table_restore_status	select	region		Returns information about a TableRestoreStatus object.
list_table_restore_status	select	region		Returns information about an array of TableRestoreStatus objects.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_table_restore_status

Returns information about a TableRestoreStatus object.

SELECT
message,
namespace_name,
new_table_name,
progress_in_mega_bytes,
recovery_point_id,
request_time,
snapshot_name,
source_database_name,
source_schema_name,
source_table_name,
status,
table_restore_request_id,
target_database_name,
target_schema_name,
total_data_in_mega_bytes,
workgroup_name
FROM aws.redshift_serverless.table_restore_status
WHERE region = '{{ region }}' -- required
;

list_table_restore_status

Returns information about an array of TableRestoreStatus objects.

SELECT
message,
namespace_name,
new_table_name,
progress_in_mega_bytes,
recovery_point_id,
request_time,
snapshot_name,
source_database_name,
source_schema_name,
source_table_name,
status,
table_restore_request_id,
target_database_name,
target_schema_name,
total_data_in_mega_bytes,
workgroup_name
FROM aws.redshift_serverless.table_restore_status
WHERE region = '{{ region }}' -- required
;