RedshiftServerless / Client / get_table_restore_status

get_table_restore_status

RedshiftServerless.Client.get_table_restore_status(**kwargs)

Returns information about a TableRestoreStatus object.

See also: AWS API Documentation

Request Syntax

response = client.get_table_restore_status(
    tableRestoreRequestId='string'
)

Parameters:

tableRestoreRequestId (string) –

[REQUIRED]

The ID of the RestoreTableFromSnapshot request to return status for.

Return type:

dict

Returns:

Response Syntax

{
    'tableRestoreStatus': {
        'message': 'string',
        'namespaceName': 'string',
        'newTableName': 'string',
        'progressInMegaBytes': 123,
        '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 returned TableRestoreStatus object that contains information about the status of your RestoreTableFromSnapshot request.

    • message (string) –

      A description of the status of the table restore request. Status values include SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS.

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

    • 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 include SUCCEEDED, FAILED, CANCELED, PENDING, 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

• RedshiftServerless.Client.exceptions.ResourceNotFoundException

• RedshiftServerless.Client.exceptions.ValidationException