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
.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-table-restore-status
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: TableRestoreStatusDetails
describe-table-restore-status
[--cluster-identifier <value>]
[--table-restore-request-id <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
--cluster-identifier
(string)
The Amazon Redshift cluster that the table is being restored to.
--table-restore-request-id
(string)
The identifier of the table restore request to return status for. If you don’t specify a
TableRestoreRequestId
value, thenDescribeTableRestoreStatus
returns the status of all in-progress table restore requests.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To describe status of table restore requests from a cluster snapshot
The following describe-table-restore-status
example displays details for table restore requests made for the specified cluster.
aws redshift describe-table-restore-status /
--cluster-identifier mycluster
Output:
{
"TableRestoreStatusDetails": [
{
"TableRestoreRequestId": "z1116630-0e80-46f4-ba86-bd9670411ebd",
"Status": "IN_PROGRESS",
"RequestTime": "2019-12-27T18:22:12.257Z",
"ClusterIdentifier": "mycluster",
"SnapshotIdentifier": "mysnapshotid",
"SourceDatabaseName": "dev",
"SourceSchemaName": "public",
"SourceTableName": "mytable",
"TargetDatabaseName": "dev",
"TargetSchemaName": "public",
"NewTableName": "mytable-clone"
}
]
}
For more information, see Restoring a Table from a Snapshot in the Amazon Redshift Cluster Management Guide.
TableRestoreStatusDetails -> (list)
A list of status details for one or more table restore requests.
(structure)
Describes the status of a RestoreTableFromClusterSnapshot operation.
TableRestoreRequestId -> (string)
The unique identifier for the table restore request.
Status -> (string)
A value that describes the current state of the table restore request.
Valid Values:
SUCCEEDED
,FAILED
,CANCELED
,PENDING
,IN_PROGRESS
Message -> (string)
A description of the status of the table restore request. Status values include
SUCCEEDED
,FAILED
,CANCELED
,PENDING
,IN_PROGRESS
.RequestTime -> (timestamp)
The time that the table restore request was made, in Universal Coordinated Time (UTC).
ProgressInMegaBytes -> (long)
The amount of data restored to the new table so far, in megabytes (MB).
TotalDataInMegaBytes -> (long)
The total amount of data to restore to the new table, in megabytes (MB).
ClusterIdentifier -> (string)
The identifier of the Amazon Redshift cluster that the table is being restored to.
SnapshotIdentifier -> (string)
The identifier of the snapshot that the table is being restored from.
SourceDatabaseName -> (string)
The name of the source database that contains the table being restored.
SourceSchemaName -> (string)
The name of the source schema that contains the table being restored.
SourceTableName -> (string)
The name of the source table being restored.
TargetDatabaseName -> (string)
The name of the database to restore the table to.
TargetSchemaName -> (string)
The name of the schema to restore the table to.
NewTableName -> (string)
The name of the table to create as a result of the table restore request.
Marker -> (string)
A pagination token that can be used in a subsequent DescribeTableRestoreStatus request.