Skip to content

GetResourcesRequest

Source code in docs_src/capo_workdocs/types/get_resources_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class GetResourcesRequest(TypedDict, closed=True):
    authentication_token: NotRequired[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ]
    """<p>The Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>"""
    user_id: NotRequired["capo_workdocs.types.id_type.IdType"]
    """<p>The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.</p>"""
    collection_type: NotRequired[
        "capo_workdocs.types.resource_collection_type.ResourceCollectionType"
    ]
    """<p>The collection type.</p>"""
    limit: NotRequired["capo_workdocs.types.limit_type.LimitType"]
    """<p>The maximum number of resources to return.</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>"""

authentication_token instance-attribute 

authentication_token: NotRequired[AuthenticationHeaderType]

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

collection_type instance-attribute 

collection_type: NotRequired[ResourceCollectionType]

The collection type.

limit instance-attribute 

limit: NotRequired[LimitType]

The maximum number of resources to return.

marker instance-attribute 

marker: NotRequired[PageMarkerType]

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

user_id instance-attribute 

user_id: NotRequired[IdType]

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.