DescribeTableRestoreStatus¶

class Redshift.Paginator.DescribeTableRestoreStatus¶

paginator = client.get_paginator('describe_table_restore_status')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Redshift.Client.describe_table_restore_status().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ClusterIdentifier='string',
    TableRestoreRequestId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

ClusterIdentifier (string) -- The Amazon Redshift cluster that the table is being restored to.
TableRestoreRequestId (string) -- The identifier of the table restore request to return status for. If you don't specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'TableRestoreStatusDetails': [
        {
            'TableRestoreRequestId': 'string',
            'Status': 'PENDING'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'CANCELED',
            'Message': 'string',
            'RequestTime': datetime(2015, 1, 1),
            'ProgressInMegaBytes': 123,
            'TotalDataInMegaBytes': 123,
            'ClusterIdentifier': 'string',
            'SnapshotIdentifier': 'string',
            'SourceDatabaseName': 'string',
            'SourceSchemaName': 'string',
            'SourceTableName': 'string',
            'TargetDatabaseName': 'string',
            'TargetSchemaName': 'string',
            'NewTableName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- TableRestoreStatusDetails (list) --
  
  A list of status details for one or more table restore requests.
  - (dict) --
    
    Describes the status of a RestoreTableFromClusterSnapshot operation.
    - TableRestoreRequestId (string) --
      
      The unique identifier for the table restore request.
    - Status (string) --
      
      A value that describes the current state of the table restore request.
      
      Valid Values: SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS
    - Message (string) --
      
      A description of the status of the table restore request. Status values include SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS .
    - RequestTime (datetime) --
      
      The time that the table restore request was made, in Universal Coordinated Time (UTC).
    - ProgressInMegaBytes (integer) --
      
      The amount of data restored to the new table so far, in megabytes (MB).
    - TotalDataInMegaBytes (integer) --
      
      The total amount of data to restore to the new table, in megabytes (MB).
    - ClusterIdentifier (string) --
      
      The identifier of the Amazon Redshift cluster that the table is being restored to.
    - SnapshotIdentifier (string) --
      
      The identifier of the snapshot that the table is being restored from.
    - SourceDatabaseName (string) --
      
      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) --
      
      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.
    - NewTableName (string) --
      
      The name of the table to create as a result of the table restore request.
- NextToken (string) --
  
  A token to resume pagination.

Table Of Contents

DescribeTableRestoreStatus¶