:doc:`DynamoDB <../../dynamodb>` / Paginator / ListBackups

***********
ListBackups
***********



.. py:class:: DynamoDB.Paginator.ListBackups

  ::

    
    paginator = client.get_paginator('list_backups')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`DynamoDB.Client.list_backups`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListBackups>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          TableName='string',
          TimeRangeLowerBound=datetime(2015, 1, 1),
          TimeRangeUpperBound=datetime(2015, 1, 1),
          BackupType='USER'|'SYSTEM'|'AWS_BACKUP'|'ALL',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type TableName: string
    :param TableName: 

      Lists the backups from the table specified in ``TableName``. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

      

    
    :type TimeRangeLowerBound: datetime
    :param TimeRangeLowerBound: 

      Only backups created after this time are listed. ``TimeRangeLowerBound`` is inclusive.

      

    
    :type TimeRangeUpperBound: datetime
    :param TimeRangeUpperBound: 

      Only backups created before this time are listed. ``TimeRangeUpperBound`` is exclusive.

      

    
    :type BackupType: string
    :param BackupType: 

      The backups from the table specified by ``BackupType`` are listed.

       

      Where ``BackupType`` can be:

       

      
      * ``USER`` - On-demand backup created by you. (The default setting if no other backup types are specified.)
       
      * ``SYSTEM`` - On-demand backup automatically created by DynamoDB.
       
      * ``ALL`` - All types of on-demand backups (USER and SYSTEM).
      

      

    
    :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**

      
      ::

        {
            'BackupSummaries': [
                {
                    'TableName': 'string',
                    'TableId': 'string',
                    'TableArn': 'string',
                    'BackupArn': 'string',
                    'BackupName': 'string',
                    'BackupCreationDateTime': datetime(2015, 1, 1),
                    'BackupExpiryDateTime': datetime(2015, 1, 1),
                    'BackupStatus': 'CREATING'|'DELETED'|'AVAILABLE',
                    'BackupType': 'USER'|'SYSTEM'|'AWS_BACKUP',
                    'BackupSizeBytes': 123
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **BackupSummaries** *(list) --* 

          List of ``BackupSummary`` objects.

          
          

          - *(dict) --* 

            Contains details for the backup.

            
            

            - **TableName** *(string) --* 

              Name of the table.

              
            

            - **TableId** *(string) --* 

              Unique identifier for the table.

              
            

            - **TableArn** *(string) --* 

              ARN associated with the table.

              
            

            - **BackupArn** *(string) --* 

              ARN associated with the backup.

              
            

            - **BackupName** *(string) --* 

              Name of the specified backup.

              
            

            - **BackupCreationDateTime** *(datetime) --* 

              Time at which the backup was created.

              
            

            - **BackupExpiryDateTime** *(datetime) --* 

              Time at which the automatic on-demand backup created by DynamoDB will expire. This ``SYSTEM`` on-demand backup expires automatically 35 days after its creation.

              
            

            - **BackupStatus** *(string) --* 

              Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

              
            

            - **BackupType** *(string) --* 

              BackupType:

               

              
              * ``USER`` - You create and manage these using the on-demand backup feature.
               
              * ``SYSTEM`` - If you delete a table with point-in-time recovery enabled, a ``SYSTEM`` backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.
               
              * ``AWS_BACKUP`` - On-demand backup created by you from Backup service.
              

              
            

            - **BackupSizeBytes** *(integer) --* 

              Size of the backup in bytes.

              
        
      
        

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

          A token to resume pagination.

          
    