ListTableRestoreStatus - Amazon Redshift Serverless

ListTableRestoreStatus

Returns information about an array of TableRestoreStatus objects.

Request Syntax

{ "maxResults": number, "namespaceName": "string", "nextToken": "string", "workgroupName": "string" }

Request Parameters

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

The request accepts the following data in JSON format.

maxResults

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

namespaceName

The namespace from which to list all of the statuses of RestoreTableFromSnapshot operations .

Type: String

Required: No

nextToken

If your initial ListTableRestoreStatus operation returns a nextToken, you can include the returned nextToken in following ListTableRestoreStatus operations. This will return results on the next page.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 1024.

Required: No

workgroupName

The workgroup from which to list all of the statuses of RestoreTableFromSnapshot operations.

Type: String

Required: No

Response Syntax

{ "nextToken": "string", "tableRestoreStatuses": [ { "message": "string", "namespaceName": "string", "newTableName": "string", "progressInMegaBytes": number, "recoveryPointId": "string", "requestTime": number, "snapshotName": "string", "sourceDatabaseName": "string", "sourceSchemaName": "string", "sourceTableName": "string", "status": "string", "tableRestoreRequestId": "string", "targetDatabaseName": "string", "targetSchemaName": "string", "totalDataInMegaBytes": number, "workgroupName": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

If your initial ListTableRestoreStatus operation returns a nextToken, you can include the returned nextToken in following ListTableRestoreStatus operations. This will returns results on the next page.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 1024.

tableRestoreStatuses

The array of returned TableRestoreStatus objects.

Type: Array of TableRestoreStatus objects

Errors

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

InvalidPaginationException

The provided pagination token is invalid.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

ValidationException

The input failed to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

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