amazonka-cognito-idp-1.6.0: Amazon Cognito Identity Provider SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CognitoIdentityProvider.AdminGetUser

Contents

Description

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

Requires developer credentials.

Synopsis

Creating a Request

adminGetUser Source #

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:

  • aguUserPoolId - The user pool ID for the user pool where you want to get information about the user.
  • aguUsername - The user name of the user you wish to retrieve.

data AdminGetUser Source #

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

See: adminGetUser smart constructor.

Instances

Eq AdminGetUser Source # 
Data AdminGetUser Source # 

Methods

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

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

toConstr :: AdminGetUser -> Constr #

dataTypeOf :: AdminGetUser -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AdminGetUser) #

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

gmapT :: (forall b. Data b => b -> b) -> AdminGetUser -> AdminGetUser #

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

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

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

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

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

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

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

Show AdminGetUser Source # 
Generic AdminGetUser Source # 

Associated Types

type Rep AdminGetUser :: * -> * #

Hashable AdminGetUser Source # 
ToJSON AdminGetUser Source # 
NFData AdminGetUser Source # 

Methods

rnf :: AdminGetUser -> () #

AWSRequest AdminGetUser Source # 
ToHeaders AdminGetUser Source # 
ToPath AdminGetUser Source # 
ToQuery AdminGetUser Source # 
type Rep AdminGetUser Source # 
type Rep AdminGetUser = D1 * (MetaData "AdminGetUser" "Network.AWS.CognitoIdentityProvider.AdminGetUser" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "AdminGetUser'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_aguUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_aguUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Sensitive Text)))))
type Rs AdminGetUser Source # 

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

adminGetUserResponse Source #

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.

Instances

Eq AdminGetUserResponse Source # 
Data AdminGetUserResponse Source # 

Methods

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

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

toConstr :: AdminGetUserResponse -> Constr #

dataTypeOf :: AdminGetUserResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AdminGetUserResponse) #

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

gmapT :: (forall b. Data b => b -> b) -> AdminGetUserResponse -> AdminGetUserResponse #

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

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

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

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

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

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

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

Show AdminGetUserResponse Source # 
Generic AdminGetUserResponse Source # 
NFData AdminGetUserResponse Source # 

Methods

rnf :: AdminGetUserResponse -> () #

type Rep AdminGetUserResponse Source # 
type Rep AdminGetUserResponse = D1 * (MetaData "AdminGetUserResponse" "Network.AWS.CognitoIdentityProvider.AdminGetUser" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "AdminGetUserResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_agursEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_agursUserStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe UserStatusType)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_agursUserAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [AttributeType]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_agursUserCreateDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_agursUserMFASettingList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_agursMFAOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [MFAOptionType]))) (S1 * (MetaSel (Just Symbol "_agursUserLastModifiedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_agursPreferredMFASetting") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_agursResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_agursUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Sensitive Text))))))))

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.

agursUserMFASettingList :: Lens' AdminGetUserResponse [Text] Source #

The list of the user's MFA settings.

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.

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

The user's preferred MFA setting.

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.