You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::ListUsersRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass ListUsersRequest data as a hash:

{
  user_pool_id: "UserPoolIdType", # required
  attributes_to_get: ["AttributeNameType"],
  limit: 1,
  pagination_token: "SearchPaginationTokenType",
  filter: "UserFilterType",
}

Represents the request to list users.

Instance Attribute Summary collapse

Instance Attribute Details

#attributes_to_getArray<String>

An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is empty, all attributes are returned.

Returns:

  • (Array<String>)


4017
4018
4019
4020
4021
4022
4023
4024
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4017

class ListUsersRequest < Struct.new(
  :user_pool_id,
  :attributes_to_get,
  :limit,
  :pagination_token,
  :filter)
  include Aws::Structure
end

#filterString

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\"".

  • AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.

  • Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"".

  • AttributeValue: The attribute value that must be matched for each user.

If the filter string is empty, ListUsers returns all users in the user pool.

You can only search for the following standard attributes:

  • username (case-sensitive)

  • email

  • phone_number

  • name

  • given_name

  • family_name

  • preferred_username

  • cognito:user_status (called Enabled in the Console) (case-sensitive)

  • status (case-insensitive)

Custom attributes are not searchable.

For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.

Returns:

  • (String)


4017
4018
4019
4020
4021
4022
4023
4024
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4017

class ListUsersRequest < Struct.new(
  :user_pool_id,
  :attributes_to_get,
  :limit,
  :pagination_token,
  :filter)
  include Aws::Structure
end

#limitInteger

Maximum number of users to be returned.

Returns:

  • (Integer)


4017
4018
4019
4020
4021
4022
4023
4024
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4017

class ListUsersRequest < Struct.new(
  :user_pool_id,
  :attributes_to_get,
  :limit,
  :pagination_token,
  :filter)
  include Aws::Structure
end

#pagination_tokenString

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Returns:

  • (String)


4017
4018
4019
4020
4021
4022
4023
4024
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4017

class ListUsersRequest < Struct.new(
  :user_pool_id,
  :attributes_to_get,
  :limit,
  :pagination_token,
  :filter)
  include Aws::Structure
end

#user_pool_idString

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

Returns:

  • (String)


4017
4018
4019
4020
4021
4022
4023
4024
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4017

class ListUsersRequest < Struct.new(
  :user_pool_id,
  :attributes_to_get,
  :limit,
  :pagination_token,
  :filter)
  include Aws::Structure
end