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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the specified user by user name in a user pool as an administrator. Works on any user.

Calling this action requires developer credentials.

Synopsis

data AdminGetUser = AdminGetUser' {
- userPoolId :: Text
- username :: Sensitive Text
}
newAdminGetUser :: Text -> Text -> AdminGetUser
adminGetUser_userPoolId :: Lens' AdminGetUser Text
adminGetUser_username :: Lens' AdminGetUser Text
data AdminGetUserResponse = AdminGetUserResponse' {
- enabled :: Maybe Bool
- userStatus :: Maybe UserStatusType
- userAttributes :: Maybe [AttributeType]
- userCreateDate :: Maybe POSIX
- userMFASettingList :: Maybe [Text]
- mfaOptions :: Maybe [MFAOptionType]
- userLastModifiedDate :: Maybe POSIX
- preferredMfaSetting :: Maybe Text
- httpStatus :: Int
- username :: Sensitive Text
}
newAdminGetUserResponse :: Int -> Text -> AdminGetUserResponse
adminGetUserResponse_enabled :: Lens' AdminGetUserResponse (Maybe Bool)
adminGetUserResponse_userStatus :: Lens' AdminGetUserResponse (Maybe UserStatusType)
adminGetUserResponse_userAttributes :: Lens' AdminGetUserResponse (Maybe [AttributeType])
adminGetUserResponse_userCreateDate :: Lens' AdminGetUserResponse (Maybe UTCTime)
adminGetUserResponse_userMFASettingList :: Lens' AdminGetUserResponse (Maybe [Text])
adminGetUserResponse_mfaOptions :: Lens' AdminGetUserResponse (Maybe [MFAOptionType])
adminGetUserResponse_userLastModifiedDate :: Lens' AdminGetUserResponse (Maybe UTCTime)
adminGetUserResponse_preferredMfaSetting :: Lens' AdminGetUserResponse (Maybe Text)
adminGetUserResponse_httpStatus :: Lens' AdminGetUserResponse Int
adminGetUserResponse_username :: Lens' AdminGetUserResponse Text

Creating a Request

data AdminGetUser Source #

Represents the request to get the specified user as an administrator.

See: newAdminGetUser smart constructor.

Constructors

AdminGetUser'
Fields userPoolId :: Text The user pool ID for the user pool where you want to get information about the user. username :: Sensitive Text The user name of the user you wish to retrieve.

Instances

Instances details

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

newAdminGetUser Source #

Arguments

:: Text	`$sel:userPoolId:AdminGetUser'`
-> Text	`$sel:username:AdminGetUser'`
-> AdminGetUser

Create a value of AdminGetUser 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:userPoolId:AdminGetUser', adminGetUser_userPoolId - The user pool ID for the user pool where you want to get information about the user.

$sel:username:AdminGetUser', adminGetUser_username - The user name of the user you wish to retrieve.

Request Lenses

adminGetUser_userPoolId :: Lens' AdminGetUser Text Source #

The user pool ID for the user pool where you want to get information about the user.

adminGetUser_username :: Lens' AdminGetUser Text Source #

The user name of the user you wish to retrieve.

Destructuring the Response

data AdminGetUserResponse Source #

Represents the response from the server from the request to get the specified user as an administrator.

See: newAdminGetUserResponse smart constructor.

Constructors

AdminGetUserResponse'

Fields

enabled :: Maybe Bool
Indicates that the status is enabled.
userStatus :: Maybe UserStatusType
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.
- RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.
- FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.
userAttributes :: Maybe [AttributeType]
An array of name-value pairs representing user attributes.
userCreateDate :: Maybe POSIX
The date the user was created.
userMFASettingList :: Maybe [Text]
The MFA options that are enabled for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.
mfaOptions :: Maybe [MFAOptionType]
This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about TOTP software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
userLastModifiedDate :: Maybe POSIX
The date the user was last modified.
preferredMfaSetting :: Maybe Text
The user's preferred MFA setting.
httpStatus :: Int
The response's http status code.
username :: Sensitive Text
The user name of the user about whom you are receiving information.

Instances

Instances details

Eq AdminGetUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminGetUser Methods (==) :: AdminGetUserResponse -> AdminGetUserResponse -> Bool # (/=) :: AdminGetUserResponse -> AdminGetUserResponse -> Bool #
Show AdminGetUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminGetUser Methods showsPrec :: Int -> AdminGetUserResponse -> ShowS # show :: AdminGetUserResponse -> String # showList :: [AdminGetUserResponse] -> ShowS #
Generic AdminGetUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminGetUser Associated Types type Rep AdminGetUserResponse :: Type -> Type # Methods from :: AdminGetUserResponse -> Rep AdminGetUserResponse x # to :: Rep AdminGetUserResponse x -> AdminGetUserResponse #
NFData AdminGetUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminGetUser Methods rnf :: AdminGetUserResponse -> () #
type Rep AdminGetUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminGetUser type Rep AdminGetUserResponse = D1 ('MetaData "AdminGetUserResponse" "Amazonka.CognitoIdentityProvider.AdminGetUser" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "AdminGetUserResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "userStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserStatusType))) :: (S1 ('MetaSel ('Just "userAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttributeType])) :: (S1 ('MetaSel ('Just "userCreateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "userMFASettingList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: ((S1 ('MetaSel ('Just "mfaOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MFAOptionType])) :: S1 ('MetaSel ('Just "userLastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "preferredMfaSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))))

newAdminGetUserResponse Source #

Arguments

:: Int	`$sel:httpStatus:AdminGetUserResponse'`
-> Text	`$sel:username:AdminGetUser'`
-> AdminGetUserResponse

Create a value of AdminGetUserResponse 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:enabled:AdminGetUserResponse', adminGetUserResponse_enabled - Indicates that the status is enabled.

$sel:userStatus:AdminGetUserResponse', adminGetUserResponse_userStatus - 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.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

$sel:userAttributes:AdminGetUserResponse', adminGetUserResponse_userAttributes - An array of name-value pairs representing user attributes.

$sel:userCreateDate:AdminGetUserResponse', adminGetUserResponse_userCreateDate - The date the user was created.

$sel:userMFASettingList:AdminGetUserResponse', adminGetUserResponse_userMFASettingList - The MFA options that are enabled for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

$sel:mfaOptions:AdminGetUserResponse', adminGetUserResponse_mfaOptions - This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about TOTP software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

$sel:userLastModifiedDate:AdminGetUserResponse', adminGetUserResponse_userLastModifiedDate - The date the user was last modified.

$sel:preferredMfaSetting:AdminGetUserResponse', adminGetUserResponse_preferredMfaSetting - The user's preferred MFA setting.

$sel:httpStatus:AdminGetUserResponse', adminGetUserResponse_httpStatus - The response's http status code.

$sel:username:AdminGetUser', adminGetUserResponse_username - The user name of the user about whom you are receiving information.

Response Lenses

adminGetUserResponse_enabled :: Lens' AdminGetUserResponse (Maybe Bool) Source #

Indicates that the status is enabled.

adminGetUserResponse_userStatus :: 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.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

adminGetUserResponse_userAttributes :: Lens' AdminGetUserResponse (Maybe [AttributeType]) Source #

An array of name-value pairs representing user attributes.

adminGetUserResponse_userCreateDate :: Lens' AdminGetUserResponse (Maybe UTCTime) Source #

The date the user was created.

adminGetUserResponse_userMFASettingList :: Lens' AdminGetUserResponse (Maybe [Text]) Source #

The MFA options that are enabled for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

adminGetUserResponse_mfaOptions :: Lens' AdminGetUserResponse (Maybe [MFAOptionType]) Source #

This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about TOTP software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

adminGetUserResponse_userLastModifiedDate :: Lens' AdminGetUserResponse (Maybe UTCTime) Source #

The date the user was last modified.

adminGetUserResponse_preferredMfaSetting :: Lens' AdminGetUserResponse (Maybe Text) Source #

The user's preferred MFA setting.

adminGetUserResponse_httpStatus :: Lens' AdminGetUserResponse Int Source #

The response's http status code.

adminGetUserResponse_username :: Lens' AdminGetUserResponse Text Source #

The user name of the user about whom you are receiving information.