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.AssociateSoftwareToken

Contents

Description

Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.

Synopsis

Creating a Request

associateSoftwareToken :: AssociateSoftwareToken #

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

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

  • astAccessToken - The access token.
  • astSession - The session which should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.

data AssociateSoftwareToken #

See: associateSoftwareToken smart constructor.

Instances

Eq AssociateSoftwareToken # 
Data AssociateSoftwareToken # 

Methods

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

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

toConstr :: AssociateSoftwareToken -> Constr #

dataTypeOf :: AssociateSoftwareToken -> DataType #

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

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

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

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

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

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

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

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

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

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

Show AssociateSoftwareToken # 
Generic AssociateSoftwareToken # 
Hashable AssociateSoftwareToken # 
ToJSON AssociateSoftwareToken # 
NFData AssociateSoftwareToken # 

Methods

rnf :: AssociateSoftwareToken -> () #

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

Request Lenses

astSession :: Lens' AssociateSoftwareToken (Maybe Text) #

The session which should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.

Destructuring the Response

associateSoftwareTokenResponse #

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

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

  • astrsSecretCode - A unique generated shared secret code that is used in the TOTP algorithm to generate a one time code.
  • astrsSession - The session which should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.
  • astrsResponseStatus - -- | The response status code.

data AssociateSoftwareTokenResponse #

See: associateSoftwareTokenResponse smart constructor.

Instances

Eq AssociateSoftwareTokenResponse # 
Data AssociateSoftwareTokenResponse # 

Methods

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

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

toConstr :: AssociateSoftwareTokenResponse -> Constr #

dataTypeOf :: AssociateSoftwareTokenResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Show AssociateSoftwareTokenResponse # 
Generic AssociateSoftwareTokenResponse # 
NFData AssociateSoftwareTokenResponse # 
type Rep AssociateSoftwareTokenResponse # 
type Rep AssociateSoftwareTokenResponse = D1 * (MetaData "AssociateSoftwareTokenResponse" "Network.AWS.CognitoIdentityProvider.AssociateSoftwareToken" "amazonka-cognito-idp-1.6.0-HX2vHucaSbyYp7rG4n6Wk" False) (C1 * (MetaCons "AssociateSoftwareTokenResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_astrsSecretCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Sensitive Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_astrsSession") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_astrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

astrsSecretCode :: Lens' AssociateSoftwareTokenResponse (Maybe Text) #

A unique generated shared secret code that is used in the TOTP algorithm to generate a one time code.

astrsSession :: Lens' AssociateSoftwareTokenResponse (Maybe Text) #

The session which should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.