WorkDocs / Client / describe_document_versions

describe_document_versions#

WorkDocs.Client.describe_document_versions(**kwargs)#

Retrieves the document versions for the specified document.

By default, only active versions are returned.

Request Syntax

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

Parameters:

AuthenticationToken (string) – Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
DocumentId (string) –
[REQUIRED]

The ID of the document.
Marker (string) – The marker for the next set of results. (You received this marker from a previous call.)
Limit (integer) – The maximum number of versions to return with this call.
Include (string) – A comma-separated list of values. Specify “INITIALIZED” to include incomplete versions.
Fields (string) – Specify “SOURCE” to include initialized versions and a URL for the source document.

Return type:

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

WorkDocs.Client.exceptions.EntityNotExistsException
WorkDocs.Client.exceptions.UnauthorizedOperationException
WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
WorkDocs.Client.exceptions.InvalidArgumentException
WorkDocs.Client.exceptions.FailedDependencyException
WorkDocs.Client.exceptions.ServiceUnavailableException
WorkDocs.Client.exceptions.ProhibitedStateException
WorkDocs.Client.exceptions.InvalidPasswordException