:doc:`Redshift <../../redshift>` / Client / describe_table_restore_status

*****************************
describe_table_restore_status
*****************************



.. py:method:: Redshift.Client.describe_table_restore_status(**kwargs)

  

  Lists the status of one or more table restore requests made using the  RestoreTableFromClusterSnapshot API action. If you don't specify a value for the ``TableRestoreRequestId`` parameter, then ``DescribeTableRestoreStatus`` returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise ``DescribeTableRestoreStatus`` returns the status of the table specified by ``TableRestoreRequestId``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeTableRestoreStatus>`_  


  **Request Syntax**
  ::

    response = client.describe_table_restore_status(
        ClusterIdentifier='string',
        TableRestoreRequestId='string',
        MaxRecords=123,
        Marker='string'
    )
    
  :type ClusterIdentifier: string
  :param ClusterIdentifier: 

    The Amazon Redshift cluster that the table is being restored to.

    

  
  :type TableRestoreRequestId: string
  :param TableRestoreRequestId: 

    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.

    

  
  :type MaxRecords: integer
  :param MaxRecords: 

    The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    

  
  :type Marker: string
  :param Marker: 

    An optional pagination token provided by a previous ``DescribeTableRestoreStatus`` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the ``MaxRecords`` parameter.

    

  
  
  :rtype: 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'
              },
          ],
          'Marker': '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.

            
      
    
      

      - **Marker** *(string) --* 

        A pagination token that can be used in a subsequent  DescribeTableRestoreStatus request.

        
  
  **Exceptions**
  
  *   :py:class:`Redshift.Client.exceptions.TableRestoreNotFoundFault`

  
  *   :py:class:`Redshift.Client.exceptions.ClusterNotFoundFault`

  