Skip to content

ListUsersResponse

Source code in docs_src/capo_cognito_identity_provider/types/list_users_response.py 
12
13
14
15
16
17
18
19
20
class ListUsersResponse(TypedDict, closed=True):
    users: NotRequired[
        "capo_cognito_identity_provider.types.users_list_type.UsersListType"
    ]
    """<p>An array of user pool users who match your query, and their attributes. Between different requests, you might observe variations in the sequence that users in this response object are sorted into. The sort order of users isn't guaranteed to follow a single pattern, but the paginated list from a single chain of requests won't return duplicates.</p>"""
    pagination_token: NotRequired[
        "capo_cognito_identity_provider.types.search_pagination_token_type.SearchPaginationTokenType"
    ]
    """<p>The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.</p>"""

pagination_token instance-attribute 

pagination_token: NotRequired[SearchPaginationTokenType]

The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.

users instance-attribute 

users: NotRequired[UsersListType]

An array of user pool users who match your query, and their attributes. Between different requests, you might observe variations in the sequence that users in this response object are sorted into. The sort order of users isn't guaranteed to follow a single pattern, but the paginated list from a single chain of requests won't return duplicates.