Skip to content

GetDocumentRequest

Source code in docs_src/capo_workdocs/types/get_document_request.py 
13
14
15
16
17
18
19
20
21
class GetDocumentRequest(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>"""
    include_custom_metadata: "capo_workdocs.types.boolean_type.BooleanType"
    """<p>Set this to <code>TRUE</code> to include custom metadata in the response.</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.

include_custom_metadata instance-attribute 

include_custom_metadata: BooleanType

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