Copyright	(c) 2013-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.CognitoIdentityProvider.InitiateAuth

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Initiates the authentication flow.

Creating a Request

initiateAuth Source #

Arguments

:: AuthFlowType	`iaAuthFlow`
-> Text	`iaClientId`
-> 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:

iaClientMetadata - The client app's metadata.
iaAuthParameters - The authentication parameters.
iaAuthFlow - The authentication flow.
iaClientId - The client ID.

data InitiateAuth Source #

Initiates the authentication request.

See: initiateAuth smart constructor.

Instances

Eq InitiateAuth Source #
Methods (==) :: InitiateAuth -> InitiateAuth -> Bool # (/=) :: InitiateAuth -> InitiateAuth -> Bool #
Data InitiateAuth Source #
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 Source #
Methods readsPrec :: Int -> ReadS InitiateAuth # readList :: ReadS [InitiateAuth] # readPrec :: ReadPrec InitiateAuth # readListPrec :: ReadPrec [InitiateAuth] #
Show InitiateAuth Source #
Methods showsPrec :: Int -> InitiateAuth -> ShowS # show :: InitiateAuth -> String # showList :: [InitiateAuth] -> ShowS #
Generic InitiateAuth Source #
Associated Types type Rep InitiateAuth :: * -> * # Methods from :: InitiateAuth -> Rep InitiateAuth x # to :: Rep InitiateAuth x -> InitiateAuth #
Hashable InitiateAuth Source #
Methods hashWithSalt :: Int -> InitiateAuth -> Int # hash :: InitiateAuth -> Int #
ToJSON InitiateAuth Source #
Methods toJSON :: InitiateAuth -> Value # toEncoding :: InitiateAuth -> Encoding # toJSONList :: [InitiateAuth] -> Value # toEncodingList :: [InitiateAuth] -> Encoding #
NFData InitiateAuth Source #
Methods rnf :: InitiateAuth -> () #
AWSRequest InitiateAuth Source #
Associated Types type Rs InitiateAuth :: * # Methods request :: InitiateAuth -> Request InitiateAuth # response :: MonadResource m => Logger -> Service -> Proxy * InitiateAuth -> ClientResponse -> m (Response InitiateAuth) #
ToPath InitiateAuth Source #
Methods toPath :: InitiateAuth -> ByteString #
ToHeaders InitiateAuth Source #
Methods toHeaders :: InitiateAuth -> [Header] #
ToQuery InitiateAuth Source #
Methods toQuery :: InitiateAuth -> QueryString #
type Rep InitiateAuth Source #
type Rep InitiateAuth = D1 (MetaData "InitiateAuth" "Network.AWS.CognitoIdentityProvider.InitiateAuth" "amazonka-cognito-idp-1.4.5-GXmpY7qnFXp3lLWwYVX1Gb" 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 Source #
type Rs InitiateAuth = InitiateAuthResponse

Request Lenses

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

The client app's metadata.

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

The authentication parameters.

iaAuthFlow :: Lens' InitiateAuth AuthFlowType Source #

The authentication flow.

iaClientId :: Lens' InitiateAuth Text Source #

The client ID.

Destructuring the Response

initiateAuthResponse Source #

Arguments

:: Int	`iarsResponseStatus`
-> 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:

iarsChallengeName - The name of the challenge.
iarsChallengeParameters - The challenge parameters.
iarsAuthenticationResult - The result returned by the server in response to the request to initiate authentication.
iarsSession - The session.
iarsResponseStatus - -- | The response status code.

data InitiateAuthResponse Source #

Initiates the authentication response.

See: initiateAuthResponse smart constructor.

Instances

Eq InitiateAuthResponse Source #
Methods (==) :: InitiateAuthResponse -> InitiateAuthResponse -> Bool # (/=) :: InitiateAuthResponse -> InitiateAuthResponse -> Bool #
Data InitiateAuthResponse Source #
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 Source #
Methods readsPrec :: Int -> ReadS InitiateAuthResponse # readList :: ReadS [InitiateAuthResponse] # readPrec :: ReadPrec InitiateAuthResponse # readListPrec :: ReadPrec [InitiateAuthResponse] #
Show InitiateAuthResponse Source #
Methods showsPrec :: Int -> InitiateAuthResponse -> ShowS # show :: InitiateAuthResponse -> String # showList :: [InitiateAuthResponse] -> ShowS #
Generic InitiateAuthResponse Source #
Associated Types type Rep InitiateAuthResponse :: * -> * # Methods from :: InitiateAuthResponse -> Rep InitiateAuthResponse x # to :: Rep InitiateAuthResponse x -> InitiateAuthResponse #
NFData InitiateAuthResponse Source #
Methods rnf :: InitiateAuthResponse -> () #
type Rep InitiateAuthResponse Source #
type Rep InitiateAuthResponse = D1 (MetaData "InitiateAuthResponse" "Network.AWS.CognitoIdentityProvider.InitiateAuth" "amazonka-cognito-idp-1.4.5-GXmpY7qnFXp3lLWwYVX1Gb" 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

iarsChallengeName :: Lens' InitiateAuthResponse (Maybe ChallengeNameType) Source #

The name of the challenge.

iarsChallengeParameters :: Lens' InitiateAuthResponse (HashMap Text Text) Source #

The challenge parameters.

iarsAuthenticationResult :: Lens' InitiateAuthResponse (Maybe AuthenticationResultType) Source #

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

iarsSession :: Lens' InitiateAuthResponse (Maybe Text) Source #

The session.

iarsResponseStatus :: Lens' InitiateAuthResponse Int Source #

- | The response status code.