| Copyright | (c) 2013-2018 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 |
| Language | Haskell2010 |
Network.AWS.CognitoIdentityProvider.ListUsers
Description
Lists the users in the Amazon Cognito user pool.
Synopsis
- listUsers :: Text -> ListUsers
- data ListUsers
- luPaginationToken :: Lens' ListUsers (Maybe Text)
- luAttributesToGet :: Lens' ListUsers [Text]
- luLimit :: Lens' ListUsers (Maybe Natural)
- luFilter :: Lens' ListUsers (Maybe Text)
- luUserPoolId :: Lens' ListUsers Text
- listUsersResponse :: Int -> ListUsersResponse
- data ListUsersResponse
- lursPaginationToken :: Lens' ListUsersResponse (Maybe Text)
- lursUsers :: Lens' ListUsersResponse [UserType]
- lursResponseStatus :: Lens' ListUsersResponse Int
Creating a Request
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,ListUsersreturns 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) *subCustom 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.
Represents the request to list users.
See: listUsers smart constructor.
Instances
Request Lenses
luPaginationToken :: 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.
luAttributesToGet :: Lens' ListUsers [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.
luFilter :: 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 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 Source #
The user pool ID for the user pool on which the search should be performed.
Destructuring the Response
Arguments
| :: Int | |
| -> 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 Source #
The response from the request to list users.
See: listUsersResponse smart constructor.
Instances
Response Lenses
lursPaginationToken :: 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.
lursUsers :: Lens' ListUsersResponse [UserType] Source #
The users returned in the request to list users.
lursResponseStatus :: Lens' ListUsersResponse Int Source #
- - | The response status code.