Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Pinpoint.Types.SendOTPMessageRequestParameters

Description

Synopsis

Documentation

data SendOTPMessageRequestParameters Source #

Send OTP message request parameters.

See: newSendOTPMessageRequestParameters smart constructor.

Constructors

SendOTPMessageRequestParameters'

Fields

allowedAttempts :: Maybe Int
The attempts allowed to validate an OTP.
codeLength :: Maybe Int
The number of characters in the generated OTP.
entityId :: Maybe Text
A unique Entity ID received from DLT after entity registration is approved.
language :: Maybe Text
The language to be used for the outgoing message body containing the OTP.
templateId :: Maybe Text
A unique Template ID received from DLT after entity registration is approved.
validityPeriod :: Maybe Int
The time in minutes before the OTP is no longer valid.
brandName :: Text
The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.
referenceId :: Text
Developer-specified reference identifier. Required to match during OTP verification.
channel :: Text
Channel type for the OTP message. Supported values: [SMS].
destinationIdentity :: Text
The destination identity to send OTP to.
originationIdentity :: Text
The origination identity used to send OTP from.

Instances

Instances details

ToJSON SendOTPMessageRequestParameters Source #
Instance details Defined in Amazonka.Pinpoint.Types.SendOTPMessageRequestParameters Methods toJSON :: SendOTPMessageRequestParameters -> Value # toEncoding :: SendOTPMessageRequestParameters -> Encoding # toJSONList :: [SendOTPMessageRequestParameters] -> Value # toEncodingList :: [SendOTPMessageRequestParameters] -> Encoding #
Generic SendOTPMessageRequestParameters Source #
Instance details Defined in Amazonka.Pinpoint.Types.SendOTPMessageRequestParameters Associated Types type Rep SendOTPMessageRequestParameters :: Type -> Type # Methods from :: SendOTPMessageRequestParameters -> Rep SendOTPMessageRequestParameters x # to :: Rep SendOTPMessageRequestParameters x -> SendOTPMessageRequestParameters #
Read SendOTPMessageRequestParameters Source #
Instance details Defined in Amazonka.Pinpoint.Types.SendOTPMessageRequestParameters Methods readsPrec :: Int -> ReadS SendOTPMessageRequestParameters # readList :: ReadS [SendOTPMessageRequestParameters] # readPrec :: ReadPrec SendOTPMessageRequestParameters # readListPrec :: ReadPrec [SendOTPMessageRequestParameters] #
Show SendOTPMessageRequestParameters Source #
Instance details Defined in Amazonka.Pinpoint.Types.SendOTPMessageRequestParameters Methods showsPrec :: Int -> SendOTPMessageRequestParameters -> ShowS # show :: SendOTPMessageRequestParameters -> String # showList :: [SendOTPMessageRequestParameters] -> ShowS #
NFData SendOTPMessageRequestParameters Source #
Instance details Defined in Amazonka.Pinpoint.Types.SendOTPMessageRequestParameters Methods rnf :: SendOTPMessageRequestParameters -> () #
Eq SendOTPMessageRequestParameters Source #
Instance details Defined in Amazonka.Pinpoint.Types.SendOTPMessageRequestParameters Methods (==) :: SendOTPMessageRequestParameters -> SendOTPMessageRequestParameters -> Bool # (/=) :: SendOTPMessageRequestParameters -> SendOTPMessageRequestParameters -> Bool #
Hashable SendOTPMessageRequestParameters Source #
Instance details Defined in Amazonka.Pinpoint.Types.SendOTPMessageRequestParameters Methods hashWithSalt :: Int -> SendOTPMessageRequestParameters -> Int # hash :: SendOTPMessageRequestParameters -> Int #
type Rep SendOTPMessageRequestParameters Source #
Instance details Defined in Amazonka.Pinpoint.Types.SendOTPMessageRequestParameters type Rep SendOTPMessageRequestParameters = D1 ('MetaData "SendOTPMessageRequestParameters" "Amazonka.Pinpoint.Types.SendOTPMessageRequestParameters" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "SendOTPMessageRequestParameters'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "allowedAttempts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "codeLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "language") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "templateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "validityPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "brandName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "referenceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "channel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "destinationIdentity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "originationIdentity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newSendOTPMessageRequestParameters Source #

Arguments

:: Text	`$sel:brandName:SendOTPMessageRequestParameters'`
-> Text	`$sel:referenceId:SendOTPMessageRequestParameters'`
-> Text	`$sel:channel:SendOTPMessageRequestParameters'`
-> Text	`$sel:destinationIdentity:SendOTPMessageRequestParameters'`
-> Text	`$sel:originationIdentity:SendOTPMessageRequestParameters'`
-> SendOTPMessageRequestParameters

Create a value of SendOTPMessageRequestParameters 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:allowedAttempts:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_allowedAttempts - The attempts allowed to validate an OTP.

$sel:codeLength:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_codeLength - The number of characters in the generated OTP.

$sel:entityId:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_entityId - A unique Entity ID received from DLT after entity registration is approved.

$sel:language:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_language - The language to be used for the outgoing message body containing the OTP.

$sel:templateId:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_templateId - A unique Template ID received from DLT after entity registration is approved.

$sel:validityPeriod:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_validityPeriod - The time in minutes before the OTP is no longer valid.

$sel:brandName:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_brandName - The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.

$sel:referenceId:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_referenceId - Developer-specified reference identifier. Required to match during OTP verification.

$sel:channel:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_channel - Channel type for the OTP message. Supported values: [SMS].

$sel:destinationIdentity:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_destinationIdentity - The destination identity to send OTP to.

$sel:originationIdentity:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_originationIdentity - The origination identity used to send OTP from.

sendOTPMessageRequestParameters_allowedAttempts :: Lens' SendOTPMessageRequestParameters (Maybe Int) Source #

The attempts allowed to validate an OTP.

sendOTPMessageRequestParameters_codeLength :: Lens' SendOTPMessageRequestParameters (Maybe Int) Source #

The number of characters in the generated OTP.

sendOTPMessageRequestParameters_entityId :: Lens' SendOTPMessageRequestParameters (Maybe Text) Source #

A unique Entity ID received from DLT after entity registration is approved.

sendOTPMessageRequestParameters_language :: Lens' SendOTPMessageRequestParameters (Maybe Text) Source #

The language to be used for the outgoing message body containing the OTP.

sendOTPMessageRequestParameters_templateId :: Lens' SendOTPMessageRequestParameters (Maybe Text) Source #

A unique Template ID received from DLT after entity registration is approved.

sendOTPMessageRequestParameters_validityPeriod :: Lens' SendOTPMessageRequestParameters (Maybe Int) Source #

The time in minutes before the OTP is no longer valid.

sendOTPMessageRequestParameters_brandName :: Lens' SendOTPMessageRequestParameters Text Source #

The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.

sendOTPMessageRequestParameters_referenceId :: Lens' SendOTPMessageRequestParameters Text Source #

Developer-specified reference identifier. Required to match during OTP verification.

sendOTPMessageRequestParameters_channel :: Lens' SendOTPMessageRequestParameters Text Source #

Channel type for the OTP message. Supported values: [SMS].

sendOTPMessageRequestParameters_destinationIdentity :: Lens' SendOTPMessageRequestParameters Text Source #

The destination identity to send OTP to.

sendOTPMessageRequestParameters_originationIdentity :: Lens' SendOTPMessageRequestParameters Text Source #

The origination identity used to send OTP from.