RedshiftServerless / Paginator / ListTableRestoreStatus

ListTableRestoreStatus#

class RedshiftServerless.Paginator.ListTableRestoreStatus#
paginator = client.get_paginator('list_table_restore_status')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from RedshiftServerless.Client.list_table_restore_status().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    namespaceName='string',
    workgroupName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • namespaceName (string) – The namespace from which to list all of the statuses of RestoreTableFromSnapshot operations .

  • workgroupName (string) – The workgroup from which to list all of the statuses of RestoreTableFromSnapshot operations.

  • 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

{
    'tableRestoreStatuses': [
        {
            '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • tableRestoreStatuses (list) –

      The array of returned TableRestoreStatus objects.

      • (dict) –

        Contains information about a table restore 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.

    • NextToken (string) –

      A token to resume pagination.