Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Lists the users in the Amazon Cognito user pool.
- listUsers :: Text -> ListUsers
- data ListUsers
- luPaginationToken :: Lens' ListUsers (Maybe Text)
- luAttributesToGet :: Lens' ListUsers [Text]
- luUserStatus :: Lens' ListUsers (Maybe UserStatusType)
- luLimit :: Lens' ListUsers (Maybe Natural)
- 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:
Represents the request to list users.
See: listUsers
smart constructor.
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 #
The attributes to get from the request to list users.
luUserStatus :: Lens' ListUsers (Maybe UserStatusType) Source #
The user status. Can be one of the following:
- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
Destructuring the Response
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:
data ListUsersResponse Source #
The response from the request to list users.
See: listUsersResponse
smart constructor.
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.