Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CognitoIdentityProvider.GetUser

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the user attributes and metadata for a user.

Synopsis

Creating a Request

data GetUser Source #

Represents the request to get information about the user.

See: newGetUser smart constructor.

Constructors

GetUser'
Fields accessToken :: Sensitive Text A non-expired access token for the user whose information you want to query.

Instances

Instances details

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

newGetUser Source #

Arguments

:: Text	`GetUser`
-> GetUser

Create a value of GetUser 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:

GetUser, getUser_accessToken - A non-expired access token for the user whose information you want to query.

Request Lenses

getUser_accessToken :: Lens' GetUser Text Source #

A non-expired access token for the user whose information you want to query.

Destructuring the Response

data GetUserResponse Source #

Represents the response from the server from the request to get information about the user.

See: newGetUserResponse smart constructor.

Constructors

GetUserResponse'

Fields

mfaOptions :: Maybe [MFAOptionType]
This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
preferredMfaSetting :: Maybe Text
The user's preferred MFA setting.
userMFASettingList :: Maybe [Text]
The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.
httpStatus :: Int
The response's http status code.
username :: Sensitive Text
The user name of the user you want to retrieve from the get user request.
userAttributes :: [AttributeType]
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.

Instances

Instances details

Generic GetUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.GetUser Associated Types type Rep GetUserResponse :: Type -> Type # Methods from :: GetUserResponse -> Rep GetUserResponse x # to :: Rep GetUserResponse x -> GetUserResponse #
Show GetUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.GetUser Methods showsPrec :: Int -> GetUserResponse -> ShowS # show :: GetUserResponse -> String # showList :: [GetUserResponse] -> ShowS #
NFData GetUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.GetUser Methods rnf :: GetUserResponse -> () #
Eq GetUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.GetUser Methods (==) :: GetUserResponse -> GetUserResponse -> Bool # (/=) :: GetUserResponse -> GetUserResponse -> Bool #
type Rep GetUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.GetUser type Rep GetUserResponse = D1 ('MetaData "GetUserResponse" "Amazonka.CognitoIdentityProvider.GetUser" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "GetUserResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "mfaOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MFAOptionType])) :: (S1 ('MetaSel ('Just "preferredMfaSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "userMFASettingList") '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)) :*: S1 ('MetaSel ('Just "userAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AttributeType])))))

newGetUserResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetUserResponse'`
-> Text	`GetUserResponse`
-> GetUserResponse

Create a value of GetUserResponse 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:

GetUserResponse, getUserResponse_mfaOptions - This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

$sel:preferredMfaSetting:GetUserResponse', getUserResponse_preferredMfaSetting - The user's preferred MFA setting.

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

$sel:httpStatus:GetUserResponse', getUserResponse_httpStatus - The response's http status code.

GetUserResponse, getUserResponse_username - The user name of the user you want to retrieve from the get user request.

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

For custom attributes, you must prepend the custom: prefix to the attribute name.

Response Lenses

getUserResponse_mfaOptions :: Lens' GetUserResponse (Maybe [MFAOptionType]) Source #

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

getUserResponse_preferredMfaSetting :: Lens' GetUserResponse (Maybe Text) Source #

The user's preferred MFA setting.

getUserResponse_userMFASettingList :: Lens' GetUserResponse (Maybe [Text]) Source #

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

getUserResponse_httpStatus :: Lens' GetUserResponse Int Source #

The response's http status code.

getUserResponse_username :: Lens' GetUserResponse Text Source #

The user name of the user you want to retrieve from the get user request.

getUserResponse_userAttributes :: Lens' GetUserResponse [AttributeType] Source #

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.