Network.AWS.CognitoIdentityProvider.AssociateSoftwareToken

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.

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

Methods

(==) :: AssociateSoftwareToken -> AssociateSoftwareToken -> Bool

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

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

Methods

showsPrec :: Int -> AssociateSoftwareToken -> ShowS

show :: AssociateSoftwareToken -> String

showList :: [AssociateSoftwareToken] -> ShowS

Generic AssociateSoftwareToken

Associated Types

type Rep AssociateSoftwareToken :: * -> *

Methods

from :: AssociateSoftwareToken -> Rep AssociateSoftwareToken x

to :: Rep AssociateSoftwareToken x -> AssociateSoftwareToken

Hashable AssociateSoftwareToken

Methods

hashWithSalt :: Int -> AssociateSoftwareToken -> Int

hash :: AssociateSoftwareToken -> Int

ToJSON AssociateSoftwareToken

Methods

toJSON :: AssociateSoftwareToken -> Value

toEncoding :: AssociateSoftwareToken -> Encoding

toJSONList :: [AssociateSoftwareToken] -> Value

toEncodingList :: [AssociateSoftwareToken] -> Encoding

NFData AssociateSoftwareToken

Methods

rnf :: AssociateSoftwareToken -> ()

AWSRequest AssociateSoftwareToken

Associated Types

type Rs AssociateSoftwareToken :: *

Methods

request :: AssociateSoftwareToken -> Request AssociateSoftwareToken

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

ToHeaders AssociateSoftwareToken

Methods

toHeaders :: AssociateSoftwareToken -> [Header]

ToPath AssociateSoftwareToken

Methods

toPath :: AssociateSoftwareToken -> ByteString

ToQuery AssociateSoftwareToken

Methods

toQuery :: AssociateSoftwareToken -> QueryString

type Rep AssociateSoftwareToken

type Rep AssociateSoftwareToken = D1 * (MetaData "AssociateSoftwareToken" "Network.AWS.CognitoIdentityProvider.AssociateSoftwareToken" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" 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

type Rs AssociateSoftwareToken = AssociateSoftwareTokenResponse

Request Lenses

astAccessToken :: Lens' AssociateSoftwareToken (Maybe Text)

The access token.

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

Arguments

:: Int

astrsResponseStatus

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

Methods

(==) :: AssociateSoftwareTokenResponse -> AssociateSoftwareTokenResponse -> Bool

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

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

Methods

showsPrec :: Int -> AssociateSoftwareTokenResponse -> ShowS

show :: AssociateSoftwareTokenResponse -> String

showList :: [AssociateSoftwareTokenResponse] -> ShowS

Generic AssociateSoftwareTokenResponse

Associated Types

type Rep AssociateSoftwareTokenResponse :: * -> *

Methods

from :: AssociateSoftwareTokenResponse -> Rep AssociateSoftwareTokenResponse x

to :: Rep AssociateSoftwareTokenResponse x -> AssociateSoftwareTokenResponse

NFData AssociateSoftwareTokenResponse

Methods

rnf :: AssociateSoftwareTokenResponse -> ()

type Rep AssociateSoftwareTokenResponse

type Rep AssociateSoftwareTokenResponse = D1 * (MetaData "AssociateSoftwareTokenResponse" "Network.AWS.CognitoIdentityProvider.AssociateSoftwareToken" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" 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.

astrsResponseStatus :: Lens' AssociateSoftwareTokenResponse Int

• - | The response status code.