Skip to content

DescribeGroupsRequest

Source code in docs_src/capo_workdocs/types/describe_groups_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class DescribeGroupsRequest(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>"""
    search_query: "capo_workdocs.types.search_query_type.SearchQueryType"
    """<p>A query to describe groups by group name.</p>"""
    organization_id: NotRequired["capo_workdocs.types.id_type.IdType"]
    """<p>The ID of the organization.</p>"""
    marker: NotRequired["capo_workdocs.types.marker_type.MarkerType"]
    """<p>The marker for the next set of results. (You received this marker from a previous call.)</p>"""
    limit: NotRequired["capo_workdocs.types.positive_integer_type.PositiveIntegerType"]
    """<p>The maximum number of items to return with this 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.

limit instance-attribute 

limit: NotRequired[PositiveIntegerType]

The maximum number of items to return with this call.

marker instance-attribute 

marker: NotRequired[MarkerType]

The marker for the next set of results. (You received this marker from a previous call.)

organization_id instance-attribute 

organization_id: NotRequired[IdType]

The ID of the organization.

search_query instance-attribute 

search_query: SearchQueryType

A query to describe groups by group name.