RedshiftServerless / Client / restore_table_from_snapshot

restore_table_from_snapshot#

RedshiftServerless.Client.restore_table_from_snapshot(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.restore_table_from_snapshot(
    activateCaseSensitiveIdentifier=True|False,
    namespaceName='string',
    newTableName='string',
    snapshotName='string',
    sourceDatabaseName='string',
    sourceSchemaName='string',
    sourceTableName='string',
    targetDatabaseName='string',
    targetSchemaName='string',
    workgroupName='string'
)
Parameters:

  • activateCaseSensitiveIdentifier (boolean) – 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.

  • namespaceName (string) –

    [REQUIRED]

    The namespace of the snapshot to restore from.

  • newTableName (string) –

    [REQUIRED]

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

  • snapshotName (string) –

    [REQUIRED]

    The name of the snapshot to restore the table from.

  • sourceDatabaseName (string) –

    [REQUIRED]

    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) –

    [REQUIRED]

    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.

  • workgroupName (string) –

    [REQUIRED]

    The workgroup to restore the table to.

Return type:

dict

Returns:

Response Syntax

{
    'tableRestoreStatus': {
        'message': 'string',
        'namespaceName': 'string',
        'newTableName': 'string',
        'progressInMegaBytes': 123,
        'recoveryPointId': 'string',
        'requestTime': datetime(2015, 1, 1),
        'snapshotName': 'string',
        'sourceDatabaseName': 'string',
        'sourceSchemaName': 'string',
        'sourceTableName': 'string',
        'status': 'string',
        'tableRestoreRequestId': 'string',
        'targetDatabaseName': 'string',
        'targetSchemaName': 'string',
        'totalDataInMegaBytes': 123,
        'workgroupName': 'string'
    }
}

Response Structure

  • (dict) –

    • tableRestoreStatus (dict) –

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

      • 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.

      • namespaceName (string) –

        The namespace of the table being restored from.

      • newTableName (string) –

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

      • progressInMegaBytes (integer) –

        The amount of data restored to the new table so far, in megabytes (MB).

      • recoveryPointId (string) –

        The ID of the recovery point being restored from.

      • requestTime (datetime) –

        The time that the table restore request was made, in Universal Coordinated Time (UTC).

      • snapshotName (string) –

        The name of the snapshot being restored from.

      • sourceDatabaseName (string) –

        The name of the source database being restored from.

      • sourceSchemaName (string) –

        The name of the source schema being restored from.

      • sourceTableName (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.

      • tableRestoreRequestId (string) –

        The ID of the RestoreTableFromSnapshot request.

      • targetDatabaseName (string) –

        The name of the database to restore to.

      • targetSchemaName (string) –

        The name of the schema to restore to.

      • totalDataInMegaBytes (integer) –

        The total amount of data to restore to the new table, in megabytes (MB).

      • workgroupName (string) –

        The name of the workgroup being restored from.

Exceptions