/AWS1/CL_CGPLISTUSERSRESPONSE¶
The response from the request to list users.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
it_users TYPE /AWS1/CL_CGPUSERTYPE=>TT_USERSLISTTYPE TT_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.
iv_paginationtoken TYPE /AWS1/CGPSRCHPAGINATIONTOKTYPE /AWS1/CGPSRCHPAGINATIONTOKTYPE¶
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.
Queryable Attributes¶
Users¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USERS() |
Getter for USERS, with configurable default |
ASK_USERS() |
Getter for USERS w/ exceptions if field has no value |
HAS_USERS() |
Determine if USERS has a value |
PaginationToken¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PAGINATIONTOKEN() |
Getter for PAGINATIONTOKEN, with configurable default |
ASK_PAGINATIONTOKEN() |
Getter for PAGINATIONTOKEN w/ exceptions if field has no val |
HAS_PAGINATIONTOKEN() |
Determine if PAGINATIONTOKEN has a value |