WorkDocs / Client / get_document_version

get_document_version#

WorkDocs.Client.get_document_version(**kwargs)#

Retrieves version metadata for the specified document.

See also: AWS API Documentation

Request Syntax

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

  • VersionId (string) –

    [REQUIRED]

    The version ID of the document.

  • Fields (string) – A comma-separated list of values. Specify “SOURCE” to include a URL for the source document.

  • IncludeCustomMetadata (boolean) – Set this to TRUE to include custom metadata in the response.

Return type:

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