:doc:`WorkDocs <../../workdocs>` / Client / describe_document_versions

**************************
describe_document_versions
**************************



.. py:method:: WorkDocs.Client.describe_document_versions(**kwargs)

  

  Retrieves the document versions for the specified document.

   

  By default, only active versions are returned.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeDocumentVersions>`_  


  **Request Syntax**
  ::

    response = client.describe_document_versions(
        AuthenticationToken='string',
        DocumentId='string',
        Marker='string',
        Limit=123,
        Include='string',
        Fields='string'
    )
    
  :type AuthenticationToken: string
  :param AuthenticationToken: 

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

    

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

    The ID of the document.

    

  
  :type Marker: string
  :param Marker: 

    The marker for the next set of results. (You received this marker from a previous call.)

    

  
  :type Limit: integer
  :param Limit: 

    The maximum number of versions to return with this call.

    

  
  :type Include: string
  :param Include: 

    A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.

    

  
  :type Fields: string
  :param Fields: 

    Specify "SOURCE" to include initialized versions and a URL for the source document.

    

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

    
    ::

      {
          'DocumentVersions': [
              {
                  'Id': 'string',
                  'Name': 'string',
                  'ContentType': 'string',
                  'Size': 123,
                  'Signature': 'string',
                  'Status': 'INITIALIZED'|'ACTIVE',
                  'CreatedTimestamp': datetime(2015, 1, 1),
                  'ModifiedTimestamp': datetime(2015, 1, 1),
                  'ContentCreatedTimestamp': datetime(2015, 1, 1),
                  'ContentModifiedTimestamp': datetime(2015, 1, 1),
                  'CreatorId': 'string',
                  'Thumbnail': {
                      'string': 'string'
                  },
                  'Source': {
                      'string': 'string'
                  }
              },
          ],
          'Marker': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **DocumentVersions** *(list) --* 

        The document versions.

        
        

        - *(dict) --* 

          Describes a version of a document.

          
          

          - **Id** *(string) --* 

            The ID of the version.

            
          

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

            The name of the version.

            
          

          - **ContentType** *(string) --* 

            The content type of the document.

            
          

          - **Size** *(integer) --* 

            The size of the document, in bytes.

            
          

          - **Signature** *(string) --* 

            The signature of the document.

            
          

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

            The status of the document.

            
          

          - **CreatedTimestamp** *(datetime) --* 

            The timestamp when the document was first uploaded.

            
          

          - **ModifiedTimestamp** *(datetime) --* 

            The timestamp when the document was last uploaded.

            
          

          - **ContentCreatedTimestamp** *(datetime) --* 

            The timestamp when the content of the document was originally created.

            
          

          - **ContentModifiedTimestamp** *(datetime) --* 

            The timestamp when the content of the document was modified.

            
          

          - **CreatorId** *(string) --* 

            The ID of the creator.

            
          

          - **Thumbnail** *(dict) --* 

            The thumbnail of the document.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
          

          - **Source** *(dict) --* 

            The source of the document.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
      
    
      

      - **Marker** *(string) --* 

        The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

        
  
  **Exceptions**
  
  *   :py:class:`WorkDocs.Client.exceptions.EntityNotExistsException`

  
  *   :py:class:`WorkDocs.Client.exceptions.UnauthorizedOperationException`

  
  *   :py:class:`WorkDocs.Client.exceptions.UnauthorizedResourceAccessException`

  
  *   :py:class:`WorkDocs.Client.exceptions.InvalidArgumentException`

  
  *   :py:class:`WorkDocs.Client.exceptions.FailedDependencyException`

  
  *   :py:class:`WorkDocs.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`WorkDocs.Client.exceptions.ProhibitedStateException`

  
  *   :py:class:`WorkDocs.Client.exceptions.InvalidPasswordException`

  