Skip to content

ListUsersRequest

Source code in docs_src/capo_chime/types/list_users_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class ListUsersRequest(TypedDict, closed=True):
    account_id: "capo_chime.types.non_empty_string.NonEmptyString"
    """<p>The Amazon Chime account ID.</p>"""
    user_email: NotRequired["capo_chime.types.email_address.EmailAddress"]
    """<p>Optional. The user email address used to filter results. Maximum 1.</p>"""
    user_type: NotRequired["capo_chime.types.user_type.UserType"]
    """<p>The user type.</p>"""
    max_results: NotRequired[
        "capo_chime.types.profile_service_max_results.ProfileServiceMaxResults"
    ]
    """<p>The maximum number of results to return in a single call. Defaults to 100.</p>"""
    next_token: NotRequired["capo_chime.types.string.String"]
    """<p>The token to use to retrieve the next page of results.</p>"""

account_id instance-attribute 

account_id: NonEmptyString

The Amazon Chime account ID.

max_results instance-attribute 

max_results: NotRequired[ProfileServiceMaxResults]

The maximum number of results to return in a single call. Defaults to 100.

next_token instance-attribute 

next_token: NotRequired[String]

The token to use to retrieve the next page of results.

user_email instance-attribute 

user_email: NotRequired[EmailAddress]

Optional. The user email address used to filter results. Maximum 1.

user_type instance-attribute 

user_type: NotRequired[UserType]

The user type.