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 |
Synopsis
- data SendOTPMessageRequestParameters = SendOTPMessageRequestParameters' {}
- newSendOTPMessageRequestParameters :: Text -> Text -> Text -> Text -> Text -> SendOTPMessageRequestParameters
- sendOTPMessageRequestParameters_allowedAttempts :: Lens' SendOTPMessageRequestParameters (Maybe Int)
- sendOTPMessageRequestParameters_codeLength :: Lens' SendOTPMessageRequestParameters (Maybe Int)
- sendOTPMessageRequestParameters_entityId :: Lens' SendOTPMessageRequestParameters (Maybe Text)
- sendOTPMessageRequestParameters_language :: Lens' SendOTPMessageRequestParameters (Maybe Text)
- sendOTPMessageRequestParameters_templateId :: Lens' SendOTPMessageRequestParameters (Maybe Text)
- sendOTPMessageRequestParameters_validityPeriod :: Lens' SendOTPMessageRequestParameters (Maybe Int)
- sendOTPMessageRequestParameters_brandName :: Lens' SendOTPMessageRequestParameters Text
- sendOTPMessageRequestParameters_referenceId :: Lens' SendOTPMessageRequestParameters Text
- sendOTPMessageRequestParameters_channel :: Lens' SendOTPMessageRequestParameters Text
- sendOTPMessageRequestParameters_destinationIdentity :: Lens' SendOTPMessageRequestParameters Text
- sendOTPMessageRequestParameters_originationIdentity :: Lens' SendOTPMessageRequestParameters Text
Documentation
data SendOTPMessageRequestParameters Source #
Send OTP message request parameters.
See: newSendOTPMessageRequestParameters
smart constructor.
SendOTPMessageRequestParameters' | |
|
Instances
newSendOTPMessageRequestParameters Source #
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.