RedshiftServerless / Client / list_table_restore_status

list_table_restore_status¶

RedshiftServerless.Client.list_table_restore_status(**kwargs)¶

Returns information about an array of TableRestoreStatus objects.

Request Syntax

response = client.list_table_restore_status(
    maxResults=123,
    namespaceName='string',
    nextToken='string',
    workgroupName='string'
)

Parameters:

maxResults (integer) – An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
namespaceName (string) – The namespace from which to list all of the statuses of RestoreTableFromSnapshot operations .
nextToken (string) – 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.
workgroupName (string) – The workgroup from which to list all of the statuses of RestoreTableFromSnapshot operations.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'tableRestoreStatuses': [
        {
            '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) –
- nextToken (string) –
  
  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.
- tableRestoreStatuses (list) –
  
  The array of returned TableRestoreStatus objects.
  - (dict) –
    
    Contains information about a table restore request.
    - 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

RedshiftServerless.Client.exceptions.ResourceNotFoundException
RedshiftServerless.Client.exceptions.InvalidPaginationException
RedshiftServerless.Client.exceptions.ValidationException