Class: Aws::CognitoIdentityProvider::Types::ListUsersResponse

Inherits:

Struct

Object
Struct
Aws::CognitoIdentityProvider::Types::ListUsersResponse

show all

Defined in:: gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The response from the request to list users.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#pagination_token ⇒ String
The identifier that Amazon Cognito returned with the previous request to this operation.
#users ⇒ Array<Types::UserType>
A list of the user pool users, and their attributes, that match your query.

Instance Attribute Details

#pagination_token ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7836

class ListUsersResponse < Struct.new(
  :users,
  :pagination_token)
  SENSITIVE = []
  include Aws::Structure
end

#users ⇒ `Array<Types::UserType>`

A list of the user pool users, and their attributes, that match your query.

Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and the native user that you linked. You can identify IdP users in the Users object of this API response by the IdP prefix that Amazon Cognito appends to Username.