Skip to content

DescribeDocumentVersionsRequest

Source code in docs_src/capo_workdocs/types/describe_document_versions_request.py
class DescribeDocumentVersionsRequest(TypedDict, closed=True):
    authentication_token: NotRequired[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ]
    """<p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>"""
    document_id: "capo_workdocs.types.resource_id_type.ResourceIdType"
    """<p>The ID of the document.</p>"""
    marker: NotRequired["capo_workdocs.types.page_marker_type.PageMarkerType"]
    """<p>The marker for the next set of results. (You received this marker from a previous call.)</p>"""
    limit: NotRequired["capo_workdocs.types.limit_type.LimitType"]
    """<p>The maximum number of versions to return with this call.</p>"""
    include: NotRequired["capo_workdocs.types.field_names_type.FieldNamesType"]
    """<p>A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.</p>"""
    fields: NotRequired["capo_workdocs.types.field_names_type.FieldNamesType"]
    """<p>Specify "SOURCE" to include initialized versions and a URL for the source document.</p>"""

authentication_token instance-attribute

authentication_token: NotRequired[AuthenticationHeaderType]

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

document_id instance-attribute

document_id: ResourceIdType

The ID of the document.

fields instance-attribute

fields: NotRequired[FieldNamesType]

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

include instance-attribute

include: NotRequired[FieldNamesType]

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

limit instance-attribute

limit: NotRequired[LimitType]

The maximum number of versions to return with this call.

marker instance-attribute

marker: NotRequired[PageMarkerType]

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