Skip to content

DescribeCommentsRequest

Source code in docs_src/capo_workdocs/types/describe_comments_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class DescribeCommentsRequest(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>"""
    version_id: "capo_workdocs.types.document_version_id_type.DocumentVersionIdType"
    """<p>The ID of the document version.</p>"""
    limit: NotRequired["capo_workdocs.types.limit_type.LimitType"]
    """<p>The maximum number of items to return.</p>"""
    marker: NotRequired["capo_workdocs.types.marker_type.MarkerType"]
    """<p>The marker for the next set of results. This marker was received from a previous call.</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.

limit instance-attribute 

limit: NotRequired[LimitType]

The maximum number of items to return.

marker instance-attribute 

marker: NotRequired[MarkerType]

The marker for the next set of results. This marker was received from a previous call.

version_id instance-attribute 

version_id: DocumentVersionIdType

The ID of the document version.