:doc:`DirectoryService <../../ds>` / Client / describe_snapshots

******************
describe_snapshots
******************



.. py:method:: DirectoryService.Client.describe_snapshots(**kwargs)

  

  Obtains information about the directory snapshots that belong to this account.

   

  This operation supports pagination with the use of the *NextToken* request and response parameters. If more results are available, the *DescribeSnapshots.NextToken* member contains a token that you pass in the next call to  DescribeSnapshots to retrieve the next set of items.

   

  You can also specify a maximum number of return results with the *Limit* parameter.

  

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


  **Request Syntax**
  ::

    response = client.describe_snapshots(
        DirectoryId='string',
        SnapshotIds=[
            'string',
        ],
        NextToken='string',
        Limit=123
    )
    
  :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 NextToken: string
  :param NextToken: 

    The *DescribeSnapshotsResult.NextToken* value from a previous call to  DescribeSnapshots. Pass null if this is the first call.

    

  
  :type Limit: integer
  :param Limit: 

    The maximum number of objects to return.

    

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

    
    ::

      {
          'Snapshots': [
              {
                  'DirectoryId': 'string',
                  'SnapshotId': 'string',
                  'Type': 'Auto'|'Manual',
                  'Name': 'string',
                  'Status': 'Creating'|'Completed'|'Failed',
                  'StartTime': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **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.

            
      
    
      

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

        If not null, more results are available. Pass this value in the *NextToken* member of a subsequent call to  DescribeSnapshots.

        
  
  **Exceptions**
  
  *   :py:class:`DirectoryService.Client.exceptions.EntityDoesNotExistException`

  
  *   :py:class:`DirectoryService.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`DirectoryService.Client.exceptions.InvalidNextTokenException`

  
  *   :py:class:`DirectoryService.Client.exceptions.ClientException`

  
  *   :py:class:`DirectoryService.Client.exceptions.ServiceException`

  