Skip to content

GetDocumentPathRequest

Source code in docs_src/capo_workdocs/types/get_document_path_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class GetDocumentPathRequest(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.id_type.IdType"
    """<p>The ID of the document.</p>"""
    limit: NotRequired["capo_workdocs.types.limit_type.LimitType"]
    """<p>The maximum number of levels in the hierarchy to return.</p>"""
    fields: NotRequired["capo_workdocs.types.field_names_type.FieldNamesType"]
    """<p>A comma-separated list of values. Specify <code>NAME</code> to include the names of the parent folders.</p>"""
    marker: NotRequired["capo_workdocs.types.page_marker_type.PageMarkerType"]
    """<p>This value is not supported.</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: IdType

The ID of the document.

fields instance-attribute 

fields: NotRequired[FieldNamesType]

A comma-separated list of values. Specify NAME to include the names of the parent folders.

limit instance-attribute 

limit: NotRequired[LimitType]

The maximum number of levels in the hierarchy to return.

marker instance-attribute 

marker: NotRequired[PageMarkerType]

This value is not supported.