DescribeTableRestoreStatus - Amazon Redshift


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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.


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

Type: String

Required: No


An optional pagination token provided by a previous DescribeTableRestoreStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Type: String

Required: No


The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Type: Integer

Required: No


The identifier of the table restore request to return status for. If you don't specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.

Type: String

Required: No

Response Elements

The following elements are returned by the service.


A pagination token that can be used in a subsequent DescribeTableRestoreStatus request.

Type: String


A list of status details for one or more table restore requests.

Type: Array of TableRestoreStatus objects


For information about the errors that are common to all actions, see Common Errors.


The ClusterIdentifier parameter does not refer to an existing cluster.

HTTP Status Code: 404


The specified TableRestoreRequestId value was not found.

HTTP Status Code: 400



This example illustrates one usage of DescribeTableRestoreStatus.

Sample Request ?Action=DescribeTableRestoreStatus &ClusterIdentifier=mycluster &SignatureMethod=HmacSHA256&SignatureVersion=4 &Version=2012-12-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20190817/us-east-2/redshift/aws4_request &X-Amz-Date=20190825T160000Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=0aa1234bb5cc678ddddd901ee2ff3aa45678b90c12d345e6ff789012345a6b7b

Sample Response

<DescribeTableRestoreStatusResponse xmlns=""> <DescribeTableRestoreStatusResult> <TableRestoreStatusDetails> <TableRestoreStatus> <NewTableName>mytable-clone</NewTableName> <ClusterIdentifier>mycluster</ClusterIdentifier> <SnapshotIdentifier>mysnapshotid</SnapshotIdentifier> <RequestTime>2019-12-27T18:22:12.257Z</RequestTime> <SourceTableName>mytable</SourceTableName> <SourceDatabaseName>dev</SourceDatabaseName> <TableRestoreRequestId>z1116630-0e80-46f4-ba86-bd9670411ebd</TableRestoreRequestId> <TargetDatabaseName>dev</TargetDatabaseName> <SourceSchemaName>public</SourceSchemaName> <TargetSchemaName>public</TargetSchemaName> <Status>IN_PROGRESS</Status> </TableRestoreStatus> </TableRestoreStatusDetails> </DescribeTableRestoreStatusResult> <ResponseMetadata> <RequestId>3a0cf005-28d6-11ea-9caa-c956bec1ce87</RequestId> </ResponseMetadata> </DescribeTableRestoreStatusResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: