:doc:`WorkDocs <../../workdocs>` / Paginator / DescribeDocumentVersions

************************
DescribeDocumentVersions
************************



.. py:class:: WorkDocs.Paginator.DescribeDocumentVersions

  ::

    
    paginator = client.get_paginator('describe_document_versions')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`WorkDocs.Client.describe_document_versions`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          AuthenticationToken='string',
          DocumentId='string',
          Include='string',
          Fields='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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 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.

      

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

      
      ::

        {
            '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'
                    }
                },
            ],
            'NextToken': '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) --* 
          
        
        
      
        

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

          A token to resume pagination.

          
    