Skip to content

DescribeFolderContentsRequest

Source code in docs_src/capo_workdocs/types/describe_folder_contents_request.py
class DescribeFolderContentsRequest(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>"""
    folder_id: "capo_workdocs.types.resource_id_type.ResourceIdType"
    """<p>The ID of the folder.</p>"""
    sort: NotRequired["capo_workdocs.types.resource_sort_type.ResourceSortType"]
    """<p>The sorting criteria.</p>"""
    order: NotRequired["capo_workdocs.types.order_type.OrderType"]
    """<p>The order for the contents of the folder.</p>"""
    limit: NotRequired["capo_workdocs.types.limit_type.LimitType"]
    """<p>The maximum number of items to return with this call.</p>"""
    marker: NotRequired["capo_workdocs.types.page_marker_type.PageMarkerType"]
    """<p>The marker for the next set of results. This marker was received from a previous call.</p>"""
    type: NotRequired["capo_workdocs.types.folder_content_type.FolderContentType"]
    """<p>The type of items.</p>"""
    include: NotRequired["capo_workdocs.types.field_names_type.FieldNamesType"]
    """<p>The contents to include. Specify "INITIALIZED" to include initialized documents.</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.

folder_id instance-attribute

folder_id: ResourceIdType

The ID of the folder.

include instance-attribute

include: NotRequired[FieldNamesType]

The contents to include. Specify "INITIALIZED" to include initialized documents.

limit instance-attribute

limit: NotRequired[LimitType]

The maximum number of items to return with this call.

marker instance-attribute

marker: NotRequired[PageMarkerType]

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

order instance-attribute

order: NotRequired[OrderType]

The order for the contents of the folder.

sort instance-attribute

sort: NotRequired[ResourceSortType]

The sorting criteria.

type instance-attribute

type: NotRequired[FolderContentType]

The type of items.