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

********************
get_document_version
********************



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

  

  Retrieves version metadata for the specified document.

  

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


  **Request Syntax**
  ::

    response = client.get_document_version(
        AuthenticationToken='string',
        DocumentId='string',
        VersionId='string',
        Fields='string',
        IncludeCustomMetadata=True|False
    )
    
  :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 VersionId: string
  :param VersionId: **[REQUIRED]** 

    The version ID of the document.

    

  
  :type Fields: string
  :param Fields: 

    A comma-separated list of values. Specify "SOURCE" to include a URL for the source document.

    

  
  :type IncludeCustomMetadata: boolean
  :param IncludeCustomMetadata: 

    Set this to TRUE to include custom metadata in the response.

    

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

    
    ::

      {
          'Metadata': {
              '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'
              }
          },
          'CustomMetadata': {
              'string': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Metadata** *(dict) --* 

        The version metadata.

        
        

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

      - **CustomMetadata** *(dict) --* 

        The custom metadata on the document version.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
  
  **Exceptions**
  
  *   :py:class:`WorkDocs.Client.exceptions.EntityNotExistsException`

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

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

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

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

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

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

  