Network.AWS.CognitoIdentityProvider.ListUsers

Lists the users in the Amazon Cognito user pool.

Creating a Request

listUsers

Arguments

:: Text

luUserPoolId

-> ListUsers

Creates a value of ListUsers with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• luPaginationToken - 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.
• luAttributesToGet - 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 null, all attributes are returned.
• luLimit - Maximum number of users to be returned.
• luFilter - 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) * sub 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 .
• luUserPoolId - The user pool ID for the user pool on which the search should be performed.

data ListUsers

Represents the request to list users.

See: listUsers smart constructor.

Instances

Eq ListUsers

Methods

(==) :: ListUsers -> ListUsers -> Bool

(/=) :: ListUsers -> ListUsers -> Bool

Data ListUsers

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListUsers -> c ListUsers

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListUsers

toConstr :: ListUsers -> Constr

dataTypeOf :: ListUsers -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListUsers)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListUsers)

gmapT :: (forall b. Data b => b -> b) -> ListUsers -> ListUsers

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListUsers -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListUsers -> r

gmapQ :: (forall d. Data d => d -> u) -> ListUsers -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListUsers -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListUsers -> m ListUsers

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListUsers -> m ListUsers

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListUsers -> m ListUsers

Read ListUsers

Methods

readsPrec :: Int -> ReadS ListUsers

readList :: ReadS [ListUsers]

readPrec :: ReadPrec ListUsers

readListPrec :: ReadPrec [ListUsers]

Show ListUsers

Methods

showsPrec :: Int -> ListUsers -> ShowS

show :: ListUsers -> String

showList :: [ListUsers] -> ShowS

Generic ListUsers

Associated Types

type Rep ListUsers :: * -> *

Methods

from :: ListUsers -> Rep ListUsers x

to :: Rep ListUsers x -> ListUsers

Hashable ListUsers

Methods

hashWithSalt :: Int -> ListUsers -> Int

hash :: ListUsers -> Int

ToJSON ListUsers

Methods

toJSON :: ListUsers -> Value

toEncoding :: ListUsers -> Encoding

toJSONList :: [ListUsers] -> Value

toEncodingList :: [ListUsers] -> Encoding

NFData ListUsers

Methods

rnf :: ListUsers -> ()

AWSRequest ListUsers

Associated Types

type Rs ListUsers :: *

Methods

request :: ListUsers -> Request ListUsers

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListUsers -> ClientResponse -> m (Response ListUsers)

ToHeaders ListUsers

Methods

toHeaders :: ListUsers -> [Header]

ToPath ListUsers

Methods

toPath :: ListUsers -> ByteString

ToQuery ListUsers

Methods

toQuery :: ListUsers -> QueryString

type Rep ListUsers

type Rep ListUsers = D1 * (MetaData "ListUsers" "Network.AWS.CognitoIdentityProvider.ListUsers" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "ListUsers'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_luPaginationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_luAttributesToGet") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_luLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) ((:*:) * (S1 * (MetaSel (Just Symbol "_luFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_luUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs ListUsers

type Rs ListUsers = ListUsersResponse

Request Lenses

luPaginationToken :: Lens' ListUsers (Maybe Text)

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.

luAttributesToGet :: Lens' ListUsers [Text]

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 null, all attributes are returned.

luLimit :: Lens' ListUsers (Maybe Natural)

Maximum number of users to be returned.

luFilter :: Lens' ListUsers (Maybe Text)

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) * sub 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 .

luUserPoolId :: Lens' ListUsers Text

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

Destructuring the Response

listUsersResponse

Arguments

:: Int

lursResponseStatus

-> ListUsersResponse

Creates a value of ListUsersResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lursPaginationToken - 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.
• lursUsers - The users returned in the request to list users.
• lursResponseStatus - -- | The response status code.

data ListUsersResponse

The response from the request to list users.

See: listUsersResponse smart constructor.

Instances

Eq ListUsersResponse

Methods

(==) :: ListUsersResponse -> ListUsersResponse -> Bool

(/=) :: ListUsersResponse -> ListUsersResponse -> Bool

Data ListUsersResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListUsersResponse -> c ListUsersResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListUsersResponse

toConstr :: ListUsersResponse -> Constr

dataTypeOf :: ListUsersResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListUsersResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListUsersResponse)

gmapT :: (forall b. Data b => b -> b) -> ListUsersResponse -> ListUsersResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListUsersResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListUsersResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListUsersResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListUsersResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListUsersResponse -> m ListUsersResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListUsersResponse -> m ListUsersResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListUsersResponse -> m ListUsersResponse

Show ListUsersResponse

Methods

showsPrec :: Int -> ListUsersResponse -> ShowS

show :: ListUsersResponse -> String

showList :: [ListUsersResponse] -> ShowS

Generic ListUsersResponse

Associated Types

type Rep ListUsersResponse :: * -> *

Methods

from :: ListUsersResponse -> Rep ListUsersResponse x

to :: Rep ListUsersResponse x -> ListUsersResponse

NFData ListUsersResponse

Methods

rnf :: ListUsersResponse -> ()

type Rep ListUsersResponse

type Rep ListUsersResponse = D1 * (MetaData "ListUsersResponse" "Network.AWS.CognitoIdentityProvider.ListUsers" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "ListUsersResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lursPaginationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lursUsers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [UserType]))) (S1 * (MetaSel (Just Symbol "_lursResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lursPaginationToken :: Lens' ListUsersResponse (Maybe Text)

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.

lursUsers :: Lens' ListUsersResponse [UserType]

The users returned in the request to list users.

lursResponseStatus :: Lens' ListUsersResponse Int

• - | The response status code.