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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass SendOTPMessageRequestParameters data as a hash:

{
  allowed_attempts: 1,
  brand_name: "__string", # required
  channel: "__string", # required
  code_length: 1,
  destination_identity: "__string", # required
  entity_id: "__string",
  language: "__string",
  origination_identity: "__string", # required
  reference_id: "__string", # required
  template_id: "__string",
  validity_period: 1,
}

Send OTP message request parameters.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_attemptsInteger

The attempts allowed to validate an OTP.

Returns:

  • (Integer)


16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16223

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_nameString

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

Returns:

  • (String)


16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16223

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

#channelString

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

Returns:

  • (String)


16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16223

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_lengthInteger

The number of characters in the generated OTP.

Returns:

  • (Integer)


16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16223

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_identityString

The destination identity to send OTP to.

Returns:

  • (String)


16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16223

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_idString

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

Returns:

  • (String)


16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16223

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

#languageString

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

Returns:

  • (String)


16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16223

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_identityString

The origination identity used to send OTP from.

Returns:

  • (String)


16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16223

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_idString

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

Returns:

  • (String)


16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16223

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_idString

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

Returns:

  • (String)


16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16223

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_periodInteger

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

Returns:

  • (Integer)


16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 16223

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