:doc:`RDS <../../rds>` / Paginator / DescribeDBClusterBacktracks

***************************
DescribeDBClusterBacktracks
***************************



.. py:class:: RDS.Paginator.DescribeDBClusterBacktracks

  ::

    
    paginator = client.get_paginator('describe_db_cluster_backtracks')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`RDS.Client.describe_db_cluster_backtracks`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusterBacktracks>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DBClusterIdentifier='string',
          BacktrackIdentifier='string',
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type DBClusterIdentifier: string
    :param DBClusterIdentifier: **[REQUIRED]** 

      The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.

       

      Constraints:

       

      
      * Must contain from 1 to 63 alphanumeric characters or hyphens.
       
      * First character must be a letter.
       
      * Can't end with a hyphen or contain two consecutive hyphens.
      

       

      Example: ``my-cluster1``

      

    
    :type BacktrackIdentifier: string
    :param BacktrackIdentifier: 

      If specified, this value is the backtrack identifier of the backtrack to be described.

       

      Constraints:

       

      
      * Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see `Universally unique identifier <https://en.wikipedia.org/wiki/Universally_unique_identifier>`__.
      

       

      Example: ``123e4567-e89b-12d3-a456-426655440000``

      

    
    :type Filters: list
    :param Filters: 

      A filter that specifies one or more DB clusters to describe. Supported filters include the following:

       

      
      * ``db-cluster-backtrack-id`` - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.
       
      * ``db-cluster-backtrack-status`` - Accepts any of the following backtrack status values: 

        
        * ``applying``
         
        * ``completed``
         
        * ``failed``
         
        * ``pending``
        

       

      The results list includes information about only the backtracks identified by these values.

      
      

      

    
      - *(dict) --* 

        A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

         

        .. note::

          

          Currently, wildcards are not supported in filters.

          

         

        The following actions can be filtered:

         

        
        * ``DescribeDBClusterBacktracks``
         
        * ``DescribeDBClusterEndpoints``
         
        * ``DescribeDBClusters``
         
        * ``DescribeDBInstances``
         
        * ``DescribeDBRecommendations``
         
        * ``DescribeDBShardGroups``
         
        * ``DescribePendingMaintenanceActions``
        

        

      
        - **Name** *(string) --* **[REQUIRED]** 

          The name of the filter. Filter names are case-sensitive.

          

        
        - **Values** *(list) --* **[REQUIRED]** 

          One or more filter values. Filter values are case-sensitive.

          

        
          - *(string) --* 

          
      
      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'DBClusterBacktracks': [
                {
                    'DBClusterIdentifier': 'string',
                    'BacktrackIdentifier': 'string',
                    'BacktrackTo': datetime(2015, 1, 1),
                    'BacktrackedFrom': datetime(2015, 1, 1),
                    'BacktrackRequestCreationTime': datetime(2015, 1, 1),
                    'Status': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Contains the result of a successful invocation of the ``DescribeDBClusterBacktracks`` action.

        
        

        - **DBClusterBacktracks** *(list) --* 

          Contains a list of backtracks for the user.

          
          

          - *(dict) --* 

            This data type is used as a response element in the ``DescribeDBClusterBacktracks`` action.

            
            

            - **DBClusterIdentifier** *(string) --* 

              Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

              
            

            - **BacktrackIdentifier** *(string) --* 

              Contains the backtrack identifier.

              
            

            - **BacktrackTo** *(datetime) --* 

              The timestamp of the time to which the DB cluster was backtracked.

              
            

            - **BacktrackedFrom** *(datetime) --* 

              The timestamp of the time from which the DB cluster was backtracked.

              
            

            - **BacktrackRequestCreationTime** *(datetime) --* 

              The timestamp of the time at which the backtrack was requested.

              
            

            - **Status** *(string) --* 

              The status of the backtrack. This property returns one of the following values:

               

              
              * ``applying`` - The backtrack is currently being applied to or rolled back from the DB cluster.
               
              * ``completed`` - The backtrack has successfully been applied to or rolled back from the DB cluster.
               
              * ``failed`` - An error occurred while the backtrack was applied to or rolled back from the DB cluster.
               
              * ``pending`` - The backtrack is currently pending application to or rollback from the DB cluster.
              

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    