Class: Aws::Pinpoint::Types::SendOTPMessageRequestParameters

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::SendOTPMessageRequestParameters

Defined in:

gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Send OTP message request parameters.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allowed_attempts ⇒ Integer

  The attempts allowed to validate an OTP.

• #brand_name ⇒ String

  The brand name that will be substituted into the OTP message body.

• #channel ⇒ String

  Channel type for the OTP message.

• #code_length ⇒ Integer

  The number of characters in the generated OTP.

• #destination_identity ⇒ String

  The destination identity to send OTP to.

• #entity_id ⇒ String

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

• #language ⇒ String

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

• #origination_identity ⇒ String

  The origination identity used to send OTP from.

• #reference_id ⇒ String

  Developer-specified reference identifier.

• #template_id ⇒ String

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

• #validity_period ⇒ Integer

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

Instance Attribute Details

#allowed_attempts ⇒ Integer

The attempts allowed to validate an OTP.

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11486

class SendOTPMessageRequestParameters < Struct.new(
  :allowed_attempts,
  :brand_name,
  :channel,
  :code_length,
  :destination_identity,
  :entity_id,
  :language,
  :origination_identity,
  :reference_id,
  :template_id,
  :validity_period)
  SENSITIVE = []
  include Aws::Structure
end

#brand_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11486

class SendOTPMessageRequestParameters < Struct.new(
  :allowed_attempts,
  :brand_name,
  :channel,
  :code_length,
  :destination_identity,
  :entity_id,
  :language,
  :origination_identity,
  :reference_id,
  :template_id,
  :validity_period)
  SENSITIVE = []
  include Aws::Structure
end

#channel ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11486

class SendOTPMessageRequestParameters < Struct.new(
  :allowed_attempts,
  :brand_name,
  :channel,
  :code_length,
  :destination_identity,
  :entity_id,
  :language,
  :origination_identity,
  :reference_id,
  :template_id,
  :validity_period)
  SENSITIVE = []
  include Aws::Structure
end

#code_length ⇒ Integer

The number of characters in the generated OTP.

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11486

class SendOTPMessageRequestParameters < Struct.new(
  :allowed_attempts,
  :brand_name,
  :channel,
  :code_length,
  :destination_identity,
  :entity_id,
  :language,
  :origination_identity,
  :reference_id,
  :template_id,
  :validity_period)
  SENSITIVE = []
  include Aws::Structure
end

#destination_identity ⇒ String

The destination identity to send OTP to.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11486

class SendOTPMessageRequestParameters < Struct.new(
  :allowed_attempts,
  :brand_name,
  :channel,
  :code_length,
  :destination_identity,
  :entity_id,
  :language,
  :origination_identity,
  :reference_id,
  :template_id,
  :validity_period)
  SENSITIVE = []
  include Aws::Structure
end

#entity_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11486

class SendOTPMessageRequestParameters < Struct.new(
  :allowed_attempts,
  :brand_name,
  :channel,
  :code_length,
  :destination_identity,
  :entity_id,
  :language,
  :origination_identity,
  :reference_id,
  :template_id,
  :validity_period)
  SENSITIVE = []
  include Aws::Structure
end

#language ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11486

class SendOTPMessageRequestParameters < Struct.new(
  :allowed_attempts,
  :brand_name,
  :channel,
  :code_length,
  :destination_identity,
  :entity_id,
  :language,
  :origination_identity,
  :reference_id,
  :template_id,
  :validity_period)
  SENSITIVE = []
  include Aws::Structure
end

#origination_identity ⇒ String

The origination identity used to send OTP from.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11486

class SendOTPMessageRequestParameters < Struct.new(
  :allowed_attempts,
  :brand_name,
  :channel,
  :code_length,
  :destination_identity,
  :entity_id,
  :language,
  :origination_identity,
  :reference_id,
  :template_id,
  :validity_period)
  SENSITIVE = []
  include Aws::Structure
end

#reference_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11486

class SendOTPMessageRequestParameters < Struct.new(
  :allowed_attempts,
  :brand_name,
  :channel,
  :code_length,
  :destination_identity,
  :entity_id,
  :language,
  :origination_identity,
  :reference_id,
  :template_id,
  :validity_period)
  SENSITIVE = []
  include Aws::Structure
end

#template_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11486

class SendOTPMessageRequestParameters < Struct.new(
  :allowed_attempts,
  :brand_name,
  :channel,
  :code_length,
  :destination_identity,
  :entity_id,
  :language,
  :origination_identity,
  :reference_id,
  :template_id,
  :validity_period)
  SENSITIVE = []
  include Aws::Structure
end

#validity_period ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 11486

class SendOTPMessageRequestParameters < Struct.new(
  :allowed_attempts,
  :brand_name,
  :channel,
  :code_length,
  :destination_identity,
  :entity_id,
  :language,
  :origination_identity,
  :reference_id,
  :template_id,
  :validity_period)
  SENSITIVE = []
  include Aws::Structure
end