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

ListUsersRequest

class ListUsersRequest

Represents the request to list users.

Types

Builder

class Builder

Companion

object Companion

Properties

attributesToGet

val attributesToGet: List<String>?

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

val 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

val limit: Int?

The maximum number of users that you want Amazon Cognito to return in the response.

paginationToken

val 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

val userPoolId: String?

The ID of the user pool where you want to display or search for users.

Functions

copy

inline fun copy(block: ListUsersRequest.Builder.() -> Unit = {}): ListUsersRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String