RestoreTableFromSnapshot - Amazon Redshift Serverless

RestoreTableFromSnapshot

Restores a table from a snapshot to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.

Request Syntax

{ "activateCaseSensitiveIdentifier": boolean, "namespaceName": "string", "newTableName": "string", "snapshotName": "string", "sourceDatabaseName": "string", "sourceSchemaName": "string", "sourceTableName": "string", "targetDatabaseName": "string", "targetSchemaName": "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.

activateCaseSensitiveIdentifier

Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false, the names are not case sensitive. The default is false.

Type: Boolean

Required: No

namespaceName

The namespace of the snapshot to restore from.

Type: String

Required: Yes

newTableName

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

Type: String

Required: Yes

snapshotName

The name of the snapshot to restore the table from.

Type: String

Required: Yes

sourceDatabaseName

The name of the source database that contains the table being restored.

Type: String

Required: Yes

sourceSchemaName

The name of the source schema that contains the table being restored.

Type: String

Required: No

sourceTableName

The name of the source table being restored.

Type: String

Required: Yes

targetDatabaseName

The name of the database to restore the table to.

Type: String

Required: No

targetSchemaName

The name of the schema to restore the table to.

Type: String

Required: No

workgroupName

The workgroup to restore the table to.

Type: String

Required: Yes

Response Syntax

{ "tableRestoreStatus": { "message": "string", "namespaceName": "string", "newTableName": "string", "progressInMegaBytes": number, "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.

tableRestoreStatus

The TableRestoreStatus object that contains the status of the restore operation.

Type: TableRestoreStatus object

Errors

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

ConflictException

The submitted action has conflicts.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

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: