:doc:`DirectoryService <../../ds>` / Paginator / DescribeSnapshots

*****************
DescribeSnapshots
*****************



.. py:class:: DirectoryService.Paginator.DescribeSnapshots

  ::

    
    paginator = client.get_paginator('describe_snapshots')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`DirectoryService.Client.describe_snapshots`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/DescribeSnapshots>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DirectoryId='string',
          SnapshotIds=[
              'string',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type DirectoryId: string
    :param DirectoryId: 

      The identifier of the directory for which to retrieve snapshot information.

      

    
    :type SnapshotIds: list
    :param SnapshotIds: 

      A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the *Limit* and *NextToken* members.

      

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

      
      ::

        {
            'Snapshots': [
                {
                    'DirectoryId': 'string',
                    'SnapshotId': 'string',
                    'Type': 'Auto'|'Manual',
                    'Name': 'string',
                    'Status': 'Creating'|'Completed'|'Failed',
                    'StartTime': datetime(2015, 1, 1)
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Contains the results of the  DescribeSnapshots operation.

        
        

        - **Snapshots** *(list) --* 

          The list of  Snapshot objects that were retrieved.

           

          It is possible that this list contains less than the number of items specified in the *Limit* member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

          
          

          - *(dict) --* 

            Describes a directory snapshot.

            
            

            - **DirectoryId** *(string) --* 

              The directory identifier.

              
            

            - **SnapshotId** *(string) --* 

              The snapshot identifier.

              
            

            - **Type** *(string) --* 

              The snapshot type.

              
            

            - **Name** *(string) --* 

              The descriptive name of the snapshot.

              
            

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

              The snapshot status.

              
            

            - **StartTime** *(datetime) --* 

              The date and time that the snapshot was taken.

              
        
      
    