cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider.model/ListUsersRequest/Builder

Builder

Properties

A JSON array of user attribute names, for example given_name, that you want Amazon Cognito to include in the response for each user. When you don't provide an AttributesToGet parameter, Amazon Cognito returns all attributes for each user.

filter

var filter: String?

A filter string of the form "AttributeName**Filter-Type "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash (\) character. For example, "family_name = \"Reddy\"".

limit

var limit: Int?

Maximum number of users to be returned.

paginationToken

var paginationToken: String?

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

userPoolId

var userPoolId: String?

The user pool ID for the user pool on which the search should be performed.