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 |
Gets the specified user by user name in a user pool as an administrator. Works on any user.
- adminGetUser :: Text -> Text -> AdminGetUser
- data AdminGetUser
- aguUserPoolId :: Lens' AdminGetUser Text
- aguUsername :: Lens' AdminGetUser Text
- adminGetUserResponse :: Int -> Text -> AdminGetUserResponse
- data AdminGetUserResponse
- agursEnabled :: Lens' AdminGetUserResponse (Maybe Bool)
- agursUserStatus :: Lens' AdminGetUserResponse (Maybe UserStatusType)
- agursUserAttributes :: Lens' AdminGetUserResponse [AttributeType]
- agursUserCreateDate :: Lens' AdminGetUserResponse (Maybe UTCTime)
- agursMFAOptions :: Lens' AdminGetUserResponse [MFAOptionType]
- agursUserLastModifiedDate :: Lens' AdminGetUserResponse (Maybe UTCTime)
- agursResponseStatus :: Lens' AdminGetUserResponse Int
- agursUsername :: Lens' AdminGetUserResponse Text
Creating a Request
Creates a value of AdminGetUser
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data AdminGetUser Source #
Represents the request to get the specified user as an administrator.
See: adminGetUser
smart constructor.
Request Lenses
aguUserPoolId :: Lens' AdminGetUser Text Source #
The user pool ID for the user pool where you want to get information about the user.
aguUsername :: Lens' AdminGetUser Text Source #
The user name of the user you wish to retrieve.
Destructuring the Response
Creates a value of AdminGetUserResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data AdminGetUserResponse Source #
Represents the response from the server from the request to get the specified user as an administrator.
See: adminGetUserResponse
smart constructor.
Response Lenses
agursEnabled :: Lens' AdminGetUserResponse (Maybe Bool) Source #
Indicates that the status is enabled.
agursUserStatus :: Lens' AdminGetUserResponse (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.
agursUserAttributes :: Lens' AdminGetUserResponse [AttributeType] Source #
An array of name-value pairs representing user attributes.
agursUserCreateDate :: Lens' AdminGetUserResponse (Maybe UTCTime) Source #
The date the user was created.
agursMFAOptions :: Lens' AdminGetUserResponse [MFAOptionType] Source #
Specifies the options for MFA (e.g., email or phone number).
agursUserLastModifiedDate :: Lens' AdminGetUserResponse (Maybe UTCTime) Source #
The date the user was last modified.
agursResponseStatus :: Lens' AdminGetUserResponse Int Source #
The response status code.
agursUsername :: Lens' AdminGetUserResponse Text Source #
The user name of the user about whom you are receiving information.