Amazonka.CognitoIdentityProvider.Types.MFAOptionType

Documentation

data MFAOptionType

This data type is no longer supported. Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token MFA configurations.

See: newMFAOptionType smart constructor.

Constructors

MFAOptionType'

Fields

• attributeName :: Maybe Text

  The attribute name of the MFA option type. The only valid value is phone_number.

• deliveryMedium :: Maybe DeliveryMediumType

  The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

Instances

FromJSON MFAOptionType

Defined in Amazonka.CognitoIdentityProvider.Types.MFAOptionType

Methods

parseJSON :: Value -> Parser MFAOptionType

parseJSONList :: Value -> Parser [MFAOptionType]

ToJSON MFAOptionType

Defined in Amazonka.CognitoIdentityProvider.Types.MFAOptionType

Methods

toJSON :: MFAOptionType -> Value

toEncoding :: MFAOptionType -> Encoding

toJSONList :: [MFAOptionType] -> Value

toEncodingList :: [MFAOptionType] -> Encoding

Generic MFAOptionType

Defined in Amazonka.CognitoIdentityProvider.Types.MFAOptionType

Associated Types

type Rep MFAOptionType :: Type -> Type

Methods

from :: MFAOptionType -> Rep MFAOptionType x

to :: Rep MFAOptionType x -> MFAOptionType

Read MFAOptionType

Defined in Amazonka.CognitoIdentityProvider.Types.MFAOptionType

Methods

readsPrec :: Int -> ReadS MFAOptionType

readList :: ReadS [MFAOptionType]

readPrec :: ReadPrec MFAOptionType

readListPrec :: ReadPrec [MFAOptionType]

Show MFAOptionType

Defined in Amazonka.CognitoIdentityProvider.Types.MFAOptionType

Methods

showsPrec :: Int -> MFAOptionType -> ShowS

show :: MFAOptionType -> String

showList :: [MFAOptionType] -> ShowS

NFData MFAOptionType

Defined in Amazonka.CognitoIdentityProvider.Types.MFAOptionType

Methods

rnf :: MFAOptionType -> ()

Eq MFAOptionType

Defined in Amazonka.CognitoIdentityProvider.Types.MFAOptionType

Methods

(==) :: MFAOptionType -> MFAOptionType -> Bool

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

Hashable MFAOptionType

Defined in Amazonka.CognitoIdentityProvider.Types.MFAOptionType

Methods

hashWithSalt :: Int -> MFAOptionType -> Int

hash :: MFAOptionType -> Int

type Rep MFAOptionType

Defined in Amazonka.CognitoIdentityProvider.Types.MFAOptionType

type Rep MFAOptionType = D1 ('MetaData "MFAOptionType" "Amazonka.CognitoIdentityProvider.Types.MFAOptionType" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "MFAOptionType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deliveryMedium") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeliveryMediumType))))

newMFAOptionType :: MFAOptionType

Create a value of MFAOptionType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attributeName:MFAOptionType', mfaOptionType_attributeName - The attribute name of the MFA option type. The only valid value is phone_number.

$sel:deliveryMedium:MFAOptionType', mfaOptionType_deliveryMedium - The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

mfaOptionType_attributeName :: Lens' MFAOptionType (Maybe Text)

The attribute name of the MFA option type. The only valid value is phone_number.

mfaOptionType_deliveryMedium :: Lens' MFAOptionType (Maybe DeliveryMediumType)

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.