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

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

Overview

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)


11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
# File 'lib/aws-sdk-pinpoint/types.rb', line 11510

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)


11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
# File 'lib/aws-sdk-pinpoint/types.rb', line 11510

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)


11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
# File 'lib/aws-sdk-pinpoint/types.rb', line 11510

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)


11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
# File 'lib/aws-sdk-pinpoint/types.rb', line 11510

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)


11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
# File 'lib/aws-sdk-pinpoint/types.rb', line 11510

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)


11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
# File 'lib/aws-sdk-pinpoint/types.rb', line 11510

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)


11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
# File 'lib/aws-sdk-pinpoint/types.rb', line 11510

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)


11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
# File 'lib/aws-sdk-pinpoint/types.rb', line 11510

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)


11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
# File 'lib/aws-sdk-pinpoint/types.rb', line 11510

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)


11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
# File 'lib/aws-sdk-pinpoint/types.rb', line 11510

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)


11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
# File 'lib/aws-sdk-pinpoint/types.rb', line 11510

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