:doc:`drs <../../drs>` / Paginator / DescribeRecoverySnapshots

*************************
DescribeRecoverySnapshots
*************************



.. py:class:: drs.Paginator.DescribeRecoverySnapshots

  ::

    
    paginator = client.get_paginator('describe_recovery_snapshots')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`drs.Client.describe_recovery_snapshots`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/DescribeRecoverySnapshots>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          filters={
              'fromDateTime': 'string',
              'toDateTime': 'string'
          },
          order='ASC'|'DESC',
          sourceServerID='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type filters: dict
    :param filters: 

      A set of filters by which to return Recovery Snapshots.

      

    
      - **fromDateTime** *(string) --* 

        The start date in a date range query.

        

      
      - **toDateTime** *(string) --* 

        The end date in a date range query.

        

      
    
    :type order: string
    :param order: 

      The sorted ordering by which to return Recovery Snapshots.

      

    
    :type sourceServerID: string
    :param sourceServerID: **[REQUIRED]** 

      Filter Recovery Snapshots by Source Server ID.

      

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

      
      ::

        {
            'items': [
                {
                    'ebsSnapshots': [
                        'string',
                    ],
                    'expectedTimestamp': 'string',
                    'snapshotID': 'string',
                    'sourceServerID': 'string',
                    'timestamp': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **items** *(list) --* 

          An array of Recovery Snapshots.

          
          

          - *(dict) --* 

            A snapshot of a Source Server used during recovery.

            
            

            - **ebsSnapshots** *(list) --* 

              A list of EBS snapshots.

              
              

              - *(string) --* 
          
            

            - **expectedTimestamp** *(string) --* 

              The timestamp of when we expect the snapshot to be taken.

              
            

            - **snapshotID** *(string) --* 

              The ID of the Recovery Snapshot.

              
            

            - **sourceServerID** *(string) --* 

              The ID of the Source Server that the snapshot was taken for.

              
            

            - **timestamp** *(string) --* 

              The actual timestamp that the snapshot was taken.

              
        
      
        

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

          A token to resume pagination.

          
    