Network.AWS.CognitoIdentityProvider.GetUser

Gets the user attributes and metadata for a user.

Creating a Request

getUser

Arguments

:: Text

guAccessToken

-> GetUser

Creates a value of GetUser with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• guAccessToken - The access token returned by the server response to get information about the user.

data GetUser

Represents the request to get information about the user.

See: getUser smart constructor.

Instances

Eq GetUser

Defined in Network.AWS.CognitoIdentityProvider.GetUser

Methods

(==) :: GetUser -> GetUser -> Bool

(/=) :: GetUser -> GetUser -> Bool

Data GetUser

Defined in Network.AWS.CognitoIdentityProvider.GetUser

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetUser -> c GetUser

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetUser

toConstr :: GetUser -> Constr

dataTypeOf :: GetUser -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetUser)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetUser)

gmapT :: (forall b. Data b => b -> b) -> GetUser -> GetUser

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetUser -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetUser -> r

gmapQ :: (forall d. Data d => d -> u) -> GetUser -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetUser -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetUser -> m GetUser

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetUser -> m GetUser

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetUser -> m GetUser

Show GetUser

Defined in Network.AWS.CognitoIdentityProvider.GetUser

Methods

showsPrec :: Int -> GetUser -> ShowS

show :: GetUser -> String

showList :: [GetUser] -> ShowS

Generic GetUser

Defined in Network.AWS.CognitoIdentityProvider.GetUser

Associated Types

type Rep GetUser :: Type -> Type

Methods

from :: GetUser -> Rep GetUser x

to :: Rep GetUser x -> GetUser

Hashable GetUser

Defined in Network.AWS.CognitoIdentityProvider.GetUser

Methods

hashWithSalt :: Int -> GetUser -> Int

hash :: GetUser -> Int

ToJSON GetUser

Defined in Network.AWS.CognitoIdentityProvider.GetUser

Methods

toJSON :: GetUser -> Value

toEncoding :: GetUser -> Encoding

toJSONList :: [GetUser] -> Value

toEncodingList :: [GetUser] -> Encoding

AWSRequest GetUser

Defined in Network.AWS.CognitoIdentityProvider.GetUser

Associated Types

type Rs GetUser :: Type

Methods

request :: GetUser -> Request GetUser

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetUser -> ClientResponse -> m (Response GetUser)

ToHeaders GetUser

Defined in Network.AWS.CognitoIdentityProvider.GetUser

Methods

toHeaders :: GetUser -> [Header]

ToPath GetUser

Defined in Network.AWS.CognitoIdentityProvider.GetUser

Methods

toPath :: GetUser -> ByteString

ToQuery GetUser

Defined in Network.AWS.CognitoIdentityProvider.GetUser

Methods

toQuery :: GetUser -> QueryString

NFData GetUser

Defined in Network.AWS.CognitoIdentityProvider.GetUser

Methods

rnf :: GetUser -> ()

type Rep GetUser

Defined in Network.AWS.CognitoIdentityProvider.GetUser

type Rep GetUser = D1 (MetaData "GetUser" "Network.AWS.CognitoIdentityProvider.GetUser" "amazonka-cognito-idp-1.6.1-IATNKTGZSOc4TejpW4Ifw7" True) (C1 (MetaCons "GetUser'" PrefixI True) (S1 (MetaSel (Just "_guAccessToken") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Sensitive Text))))

type Rs GetUser

Defined in Network.AWS.CognitoIdentityProvider.GetUser

type Rs GetUser = GetUserResponse

Request Lenses

guAccessToken :: Lens' GetUser Text

The access token returned by the server response to get information about the user.

Destructuring the Response

getUserResponse

Arguments

:: Int

gursResponseStatus

-> Text

gursUsername

-> GetUserResponse

Creates a value of GetUserResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gursUserMFASettingList - The list of the user's MFA settings.
• gursMFAOptions - Specifies the options for MFA (e.g., email or phone number).
• gursPreferredMFASetting - The user's preferred MFA setting.
• gursResponseStatus - -- | The response status code.
• gursUsername - The user name of the user you wish to retrieve from the get user request.
• gursUserAttributes - An array of name-value pairs representing user attributes. For custom attributes, you must prepend the custom: prefix to the attribute name.

data GetUserResponse

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

See: getUserResponse smart constructor.

Instances

Eq GetUserResponse

Defined in Network.AWS.CognitoIdentityProvider.GetUser

Methods

(==) :: GetUserResponse -> GetUserResponse -> Bool

(/=) :: GetUserResponse -> GetUserResponse -> Bool

Data GetUserResponse

Defined in Network.AWS.CognitoIdentityProvider.GetUser

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetUserResponse -> c GetUserResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetUserResponse

toConstr :: GetUserResponse -> Constr

dataTypeOf :: GetUserResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetUserResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetUserResponse)

gmapT :: (forall b. Data b => b -> b) -> GetUserResponse -> GetUserResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetUserResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetUserResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetUserResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetUserResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetUserResponse -> m GetUserResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetUserResponse -> m GetUserResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetUserResponse -> m GetUserResponse

Show GetUserResponse

Defined in Network.AWS.CognitoIdentityProvider.GetUser

Methods

showsPrec :: Int -> GetUserResponse -> ShowS

show :: GetUserResponse -> String

showList :: [GetUserResponse] -> ShowS

Generic GetUserResponse

Defined in Network.AWS.CognitoIdentityProvider.GetUser

Associated Types

type Rep GetUserResponse :: Type -> Type

Methods

from :: GetUserResponse -> Rep GetUserResponse x

to :: Rep GetUserResponse x -> GetUserResponse

NFData GetUserResponse

Defined in Network.AWS.CognitoIdentityProvider.GetUser

Methods

rnf :: GetUserResponse -> ()

type Rep GetUserResponse

Defined in Network.AWS.CognitoIdentityProvider.GetUser

type Rep GetUserResponse = D1 (MetaData "GetUserResponse" "Network.AWS.CognitoIdentityProvider.GetUser" "amazonka-cognito-idp-1.6.1-IATNKTGZSOc4TejpW4Ifw7" False) (C1 (MetaCons "GetUserResponse'" PrefixI True) ((S1 (MetaSel (Just "_gursUserMFASettingList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 (MetaSel (Just "_gursMFAOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [MFAOptionType])) :*: S1 (MetaSel (Just "_gursPreferredMFASetting") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_gursResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: (S1 (MetaSel (Just "_gursUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 (MetaSel (Just "_gursUserAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [AttributeType])))))

Response Lenses

gursUserMFASettingList :: Lens' GetUserResponse [Text]

The list of the user's MFA settings.

gursMFAOptions :: Lens' GetUserResponse [MFAOptionType]

Specifies the options for MFA (e.g., email or phone number).

gursPreferredMFASetting :: Lens' GetUserResponse (Maybe Text)

The user's preferred MFA setting.

gursResponseStatus :: Lens' GetUserResponse Int

• - | The response status code.

gursUsername :: Lens' GetUserResponse Text

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

gursUserAttributes :: Lens' GetUserResponse [AttributeType]

An array of name-value pairs representing user attributes. For custom attributes, you must prepend the custom: prefix to the attribute name.