Network.AWS.CognitoIdentityProvider.VerifySoftwareToken

Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful,

Creating a Request

verifySoftwareToken

Arguments

:: Text

vstUserCode

-> VerifySoftwareToken

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

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

• vstAccessToken - The access token.
• vstFriendlyDeviceName - The friendly device name.
• vstSession - The session which should be passed both ways in challenge-response calls to the service.
• vstUserCode - The one time password computed using the secret code returned by

data VerifySoftwareToken

See: verifySoftwareToken smart constructor.

Instances

Eq VerifySoftwareToken

Methods

(==) :: VerifySoftwareToken -> VerifySoftwareToken -> Bool

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

Data VerifySoftwareToken

Methods

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

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

toConstr :: VerifySoftwareToken -> Constr

dataTypeOf :: VerifySoftwareToken -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> VerifySoftwareToken -> VerifySoftwareToken

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

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

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

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

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

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

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

Show VerifySoftwareToken

Methods

showsPrec :: Int -> VerifySoftwareToken -> ShowS

show :: VerifySoftwareToken -> String

showList :: [VerifySoftwareToken] -> ShowS

Generic VerifySoftwareToken

Associated Types

type Rep VerifySoftwareToken :: * -> *

Methods

from :: VerifySoftwareToken -> Rep VerifySoftwareToken x

to :: Rep VerifySoftwareToken x -> VerifySoftwareToken

Hashable VerifySoftwareToken

Methods

hashWithSalt :: Int -> VerifySoftwareToken -> Int

hash :: VerifySoftwareToken -> Int

ToJSON VerifySoftwareToken

Methods

toJSON :: VerifySoftwareToken -> Value

toEncoding :: VerifySoftwareToken -> Encoding

toJSONList :: [VerifySoftwareToken] -> Value

toEncodingList :: [VerifySoftwareToken] -> Encoding

NFData VerifySoftwareToken

Methods

rnf :: VerifySoftwareToken -> ()

AWSRequest VerifySoftwareToken

Associated Types

type Rs VerifySoftwareToken :: *

Methods

request :: VerifySoftwareToken -> Request VerifySoftwareToken

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

ToHeaders VerifySoftwareToken

Methods

toHeaders :: VerifySoftwareToken -> [Header]

ToPath VerifySoftwareToken

Methods

toPath :: VerifySoftwareToken -> ByteString

ToQuery VerifySoftwareToken

Methods

toQuery :: VerifySoftwareToken -> QueryString

type Rep VerifySoftwareToken

type Rep VerifySoftwareToken = D1 * (MetaData "VerifySoftwareToken" "Network.AWS.CognitoIdentityProvider.VerifySoftwareToken" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "VerifySoftwareToken'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_vstAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Sensitive Text)))) (S1 * (MetaSel (Just Symbol "_vstFriendlyDeviceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_vstSession") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_vstUserCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs VerifySoftwareToken

type Rs VerifySoftwareToken = VerifySoftwareTokenResponse

Request Lenses

vstAccessToken :: Lens' VerifySoftwareToken (Maybe Text)

The access token.

vstFriendlyDeviceName :: Lens' VerifySoftwareToken (Maybe Text)

The friendly device name.

vstSession :: Lens' VerifySoftwareToken (Maybe Text)

The session which should be passed both ways in challenge-response calls to the service.

vstUserCode :: Lens' VerifySoftwareToken Text

The one time password computed using the secret code returned by

Destructuring the Response

verifySoftwareTokenResponse

Arguments

:: Int

vstrsResponseStatus

-> VerifySoftwareTokenResponse

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

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

• vstrsStatus - The status of the verify software token.
• vstrsSession - The session which should be passed both ways in challenge-response calls to the service.
• vstrsResponseStatus - -- | The response status code.

data VerifySoftwareTokenResponse

See: verifySoftwareTokenResponse smart constructor.

Instances

Eq VerifySoftwareTokenResponse

Methods

(==) :: VerifySoftwareTokenResponse -> VerifySoftwareTokenResponse -> Bool

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

Data VerifySoftwareTokenResponse

Methods

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

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

toConstr :: VerifySoftwareTokenResponse -> Constr

dataTypeOf :: VerifySoftwareTokenResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> VerifySoftwareTokenResponse -> VerifySoftwareTokenResponse

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

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

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

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

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

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

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

Read VerifySoftwareTokenResponse

Methods

readsPrec :: Int -> ReadS VerifySoftwareTokenResponse

readList :: ReadS [VerifySoftwareTokenResponse]

readPrec :: ReadPrec VerifySoftwareTokenResponse

readListPrec :: ReadPrec [VerifySoftwareTokenResponse]

Show VerifySoftwareTokenResponse

Methods

showsPrec :: Int -> VerifySoftwareTokenResponse -> ShowS

show :: VerifySoftwareTokenResponse -> String

showList :: [VerifySoftwareTokenResponse] -> ShowS

Generic VerifySoftwareTokenResponse

Associated Types

type Rep VerifySoftwareTokenResponse :: * -> *

Methods

from :: VerifySoftwareTokenResponse -> Rep VerifySoftwareTokenResponse x

to :: Rep VerifySoftwareTokenResponse x -> VerifySoftwareTokenResponse

NFData VerifySoftwareTokenResponse

Methods

rnf :: VerifySoftwareTokenResponse -> ()

type Rep VerifySoftwareTokenResponse

type Rep VerifySoftwareTokenResponse = D1 * (MetaData "VerifySoftwareTokenResponse" "Network.AWS.CognitoIdentityProvider.VerifySoftwareToken" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "VerifySoftwareTokenResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_vstrsStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe VerifySoftwareTokenResponseType))) ((:*:) * (S1 * (MetaSel (Just Symbol "_vstrsSession") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_vstrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

vstrsStatus :: Lens' VerifySoftwareTokenResponse (Maybe VerifySoftwareTokenResponseType)

The status of the verify software token.

vstrsSession :: Lens' VerifySoftwareTokenResponse (Maybe Text)

The session which should be passed both ways in challenge-response calls to the service.

vstrsResponseStatus :: Lens' VerifySoftwareTokenResponse Int

• - | The response status code.