Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CognitoIdentityProvider.ListUsers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the users in the Amazon Cognito user pool.

This operation returns paginated results.

Synopsis

data ListUsers = ListUsers' {
- paginationToken :: Maybe Text
- attributesToGet :: Maybe [Text]
- limit :: Maybe Natural
- filter' :: Maybe Text
- userPoolId :: Text
}
newListUsers :: Text -> ListUsers
listUsers_paginationToken :: Lens' ListUsers (Maybe Text)
listUsers_attributesToGet :: Lens' ListUsers (Maybe [Text])
listUsers_limit :: Lens' ListUsers (Maybe Natural)
listUsers_filter :: Lens' ListUsers (Maybe Text)
listUsers_userPoolId :: Lens' ListUsers Text
data ListUsersResponse = ListUsersResponse' {
- paginationToken :: Maybe Text
- users :: Maybe [UserType]
- httpStatus :: Int
}
newListUsersResponse :: Int -> ListUsersResponse
listUsersResponse_paginationToken :: Lens' ListUsersResponse (Maybe Text)
listUsersResponse_users :: Lens' ListUsersResponse (Maybe [UserType])
listUsersResponse_httpStatus :: Lens' ListUsersResponse Int

Creating a Request

data ListUsers Source #

Represents the request to list users.

See: newListUsers smart constructor.

Constructors

ListUsers'

Fields

paginationToken :: 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.
attributesToGet :: Maybe [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.
limit :: Maybe Natural
Maximum number of users to be returned.
filter' :: 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 Status in the Console) (case-insensitive)
- ```
status (called Enabled in the Console) (case-sensitive)
```
- ```
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.
userPoolId :: Text
The user pool ID for the user pool on which the search should be performed.

Instances

Instances details

Eq ListUsers Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers Methods (==) :: ListUsers -> ListUsers -> Bool # (/=) :: ListUsers -> ListUsers -> Bool #
Read ListUsers Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers Methods readsPrec :: Int -> ReadS ListUsers # readList :: ReadS [ListUsers] # readPrec :: ReadPrec ListUsers # readListPrec :: ReadPrec [ListUsers] #
Show ListUsers Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers Methods showsPrec :: Int -> ListUsers -> ShowS # show :: ListUsers -> String # showList :: [ListUsers] -> ShowS #
Generic ListUsers Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers Associated Types type Rep ListUsers :: Type -> Type # Methods from :: ListUsers -> Rep ListUsers x # to :: Rep ListUsers x -> ListUsers #
NFData ListUsers Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers Methods rnf :: ListUsers -> () #
Hashable ListUsers Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers Methods hashWithSalt :: Int -> ListUsers -> Int # hash :: ListUsers -> Int #
ToJSON ListUsers Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers Methods toJSON :: ListUsers -> Value # toEncoding :: ListUsers -> Encoding # toJSONList :: [ListUsers] -> Value # toEncodingList :: [ListUsers] -> Encoding #
AWSPager ListUsers Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers Methods page :: ListUsers -> AWSResponse ListUsers -> Maybe ListUsers #
AWSRequest ListUsers Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers Associated Types type AWSResponse ListUsers # Methods request :: ListUsers -> Request ListUsers # response :: MonadResource m => Logger -> Service -> Proxy ListUsers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListUsers))) #
ToHeaders ListUsers Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers Methods toHeaders :: ListUsers -> [Header] #
ToPath ListUsers Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers Methods toPath :: ListUsers -> ByteString #
ToQuery ListUsers Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers Methods toQuery :: ListUsers -> QueryString #
type Rep ListUsers Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers type Rep ListUsers = D1 ('MetaData "ListUsers" "Amazonka.CognitoIdentityProvider.ListUsers" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "ListUsers'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "paginationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "attributesToGet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ListUsers Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers type AWSResponse ListUsers = ListUsersResponse

newListUsers Source #

Arguments

:: Text	`$sel:userPoolId:ListUsers'`
-> ListUsers

Create a value of ListUsers with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:paginationToken:ListUsers', listUsers_paginationToken - 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.

$sel:attributesToGet:ListUsers', listUsers_attributesToGet - 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.

$sel:limit:ListUsers', listUsers_limit - Maximum number of users to be returned.

$sel:filter':ListUsers', listUsers_filter - 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 Status in the Console) (case-insensitive)

status (called Enabled in the Console) (case-sensitive)

```
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.

$sel:userPoolId:ListUsers', listUsers_userPoolId - The user pool ID for the user pool on which the search should be performed.

Request Lenses

listUsers_paginationToken :: Lens' ListUsers (Maybe Text) Source #

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.

listUsers_attributesToGet :: Lens' ListUsers (Maybe [Text]) Source #

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.

listUsers_limit :: Lens' ListUsers (Maybe Natural) Source #

Maximum number of users to be returned.

listUsers_filter :: Lens' ListUsers (Maybe Text) Source #

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 Status in the Console) (case-insensitive)

status (called Enabled in the Console) (case-sensitive)

```
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.

listUsers_userPoolId :: Lens' ListUsers Text Source #

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

Destructuring the Response

data ListUsersResponse Source #

The response from the request to list users.

See: newListUsersResponse smart constructor.

Constructors

ListUsersResponse'
Fields paginationToken :: 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. users :: Maybe [UserType] The users returned in the request to list users. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListUsersResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers Methods (==) :: ListUsersResponse -> ListUsersResponse -> Bool # (/=) :: ListUsersResponse -> ListUsersResponse -> Bool #
Show ListUsersResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers Methods showsPrec :: Int -> ListUsersResponse -> ShowS # show :: ListUsersResponse -> String # showList :: [ListUsersResponse] -> ShowS #
Generic ListUsersResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers Associated Types type Rep ListUsersResponse :: Type -> Type # Methods from :: ListUsersResponse -> Rep ListUsersResponse x # to :: Rep ListUsersResponse x -> ListUsersResponse #
NFData ListUsersResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers Methods rnf :: ListUsersResponse -> () #
type Rep ListUsersResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.ListUsers type Rep ListUsersResponse = D1 ('MetaData "ListUsersResponse" "Amazonka.CognitoIdentityProvider.ListUsers" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "ListUsersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "paginationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UserType])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListUsersResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListUsersResponse'`
-> ListUsersResponse

Create a value of ListUsersResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:paginationToken:ListUsers', listUsersResponse_paginationToken - 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.

$sel:users:ListUsersResponse', listUsersResponse_users - The users returned in the request to list users.

$sel:httpStatus:ListUsersResponse', listUsersResponse_httpStatus - The response's http status code.

Response Lenses

listUsersResponse_paginationToken :: Lens' ListUsersResponse (Maybe Text) Source #

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.

listUsersResponse_users :: Lens' ListUsersResponse (Maybe [UserType]) Source #

The users returned in the request to list users.

listUsersResponse_httpStatus :: Lens' ListUsersResponse Int Source #

The response's http status code.