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

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

Network.AWS.CognitoIdentityProvider.InitiateAuth

Contents

Description

Initiates the authentication flow.

Synopsis

Creating a Request

initiateAuth #

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

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

data InitiateAuth #

Initiates the authentication request.

See: initiateAuth smart constructor.

Instances

Eq InitiateAuth # 
Data InitiateAuth # 

Methods

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

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

toConstr :: InitiateAuth -> Constr #

dataTypeOf :: InitiateAuth -> DataType #

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

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

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

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

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

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

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

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

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

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

Read InitiateAuth # 
Show InitiateAuth # 
Generic InitiateAuth # 

Associated Types

type Rep InitiateAuth :: * -> * #

Hashable InitiateAuth # 
ToJSON InitiateAuth # 
NFData InitiateAuth # 

Methods

rnf :: InitiateAuth -> () #

AWSRequest InitiateAuth # 
ToQuery InitiateAuth # 
ToPath InitiateAuth # 
ToHeaders InitiateAuth # 
type Rep InitiateAuth # 
type Rep InitiateAuth = D1 (MetaData "InitiateAuth" "Network.AWS.CognitoIdentityProvider.InitiateAuth" "amazonka-cognito-idp-1.4.5-FSH4ePU3ZIwKGfg2fnU2v3" False) (C1 (MetaCons "InitiateAuth'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_iaClientMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_iaAuthParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_iaAuthFlow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AuthFlowType)) (S1 (MetaSel (Just Symbol "_iaClientId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Text))))))
type Rs InitiateAuth # 

Request Lenses

iaClientMetadata :: Lens' InitiateAuth (HashMap Text Text) #

The client app's metadata.

iaAuthParameters :: Lens' InitiateAuth (HashMap Text Text) #

The authentication parameters.

iaAuthFlow :: Lens' InitiateAuth AuthFlowType #

The authentication flow.

Destructuring the Response

initiateAuthResponse #

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

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

data InitiateAuthResponse #

Initiates the authentication response.

See: initiateAuthResponse smart constructor.

Instances

Eq InitiateAuthResponse # 
Data InitiateAuthResponse # 

Methods

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

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

toConstr :: InitiateAuthResponse -> Constr #

dataTypeOf :: InitiateAuthResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read InitiateAuthResponse # 
Show InitiateAuthResponse # 
Generic InitiateAuthResponse # 
NFData InitiateAuthResponse # 

Methods

rnf :: InitiateAuthResponse -> () #

type Rep InitiateAuthResponse # 
type Rep InitiateAuthResponse = D1 (MetaData "InitiateAuthResponse" "Network.AWS.CognitoIdentityProvider.InitiateAuth" "amazonka-cognito-idp-1.4.5-FSH4ePU3ZIwKGfg2fnU2v3" False) (C1 (MetaCons "InitiateAuthResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_iarsChallengeName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ChallengeNameType))) (S1 (MetaSel (Just Symbol "_iarsChallengeParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_iarsAuthenticationResult") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AuthenticationResultType))) ((:*:) (S1 (MetaSel (Just Symbol "_iarsSession") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_iarsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))))

Response Lenses

iarsAuthenticationResult :: Lens' InitiateAuthResponse (Maybe AuthenticationResultType) #

The result returned by the server in response to the request to initiate authentication.

iarsResponseStatus :: Lens' InitiateAuthResponse Int #

  • - | The response status code.