Struct aws_sdk_pinpoint::model::SendOtpMessageRequestParameters

#[non_exhaustive]
pub struct SendOtpMessageRequestParameters {
    pub allowed_attempts: i32,
    pub brand_name: Option<String>,
    pub channel: Option<String>,
    pub code_length: i32,
    pub destination_identity: Option<String>,
    pub entity_id: Option<String>,
    pub language: Option<String>,
    pub origination_identity: Option<String>,
    pub reference_id: Option<String>,
    pub template_id: Option<String>,
    pub validity_period: i32,
}

Send OTP message request parameters.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

allowed_attempts: i32

The attempts allowed to validate an OTP.

brand_name: Option<String>

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

channel: Option<String>

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

code_length: i32

The number of characters in the generated OTP.

destination_identity: Option<String>

The destination identity to send OTP to.

entity_id: Option<String>

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

language: Option<String>

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

origination_identity: Option<String>

The origination identity used to send OTP from.

reference_id: Option<String>

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

template_id: Option<String>

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

validity_period: i32

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

Implementations

impl SendOtpMessageRequestParameters

pub fn allowed_attempts(&self) -> i32

The attempts allowed to validate an OTP.

pub fn brand_name(&self) -> Option<&str>

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

pub fn channel(&self) -> Option<&str>

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

pub fn code_length(&self) -> i32

The number of characters in the generated OTP.

pub fn destination_identity(&self) -> Option<&str>

The destination identity to send OTP to.

pub fn entity_id(&self) -> Option<&str>

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

pub fn language(&self) -> Option<&str>

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

pub fn origination_identity(&self) -> Option<&str>

The origination identity used to send OTP from.

pub fn reference_id(&self) -> Option<&str>

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

pub fn template_id(&self) -> Option<&str>

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

pub fn validity_period(&self) -> i32

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

impl SendOtpMessageRequestParameters

pub fn builder() -> Builder

Creates a new builder-style object to manufacture SendOtpMessageRequestParameters

Trait Implementations

impl Clone for SendOtpMessageRequestParameters

fn clone(&self) -> SendOtpMessageRequestParameters

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SendOtpMessageRequestParameters

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<SendOtpMessageRequestParameters> for SendOtpMessageRequestParameters

fn eq(&self, other: &SendOtpMessageRequestParameters) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SendOtpMessageRequestParameters) -> bool

This method tests for !=.

impl StructuralPartialEq for SendOtpMessageRequestParameters