Class: Aws::EndUserMessaging::Types::SendNotifyCodeVerificationInput

Inherits:

Struct

• Object
• Struct
• Aws::EndUserMessaging::Types::SendNotifyCodeVerificationInput

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:destination_identity, :context]

Instance Attribute Summary

• #channel ⇒ String

  The channel used to deliver the one-time passcode to the recipient.

• #configuration_set_name ⇒ String

  The name of the configuration set used to control how delivery events for the message are handled.

• #context ⇒ Hash<String,String>

  A map of custom key and value pairs that are propagated to the delivery events for this verification.

• #destination_identity ⇒ String

  The recipient identifier.

• #notify_code_configuration ⇒ String

  The identifier or Amazon Resource Name (ARN) of the notify code configuration that supplies the passcode policy and template defaults.

• #origination_identity ⇒ String

  The identity used to send the message, such as a phone number, sender ID, or pool that is owned by your account.

• #override_channel_parameters ⇒ Types::ChannelParameters

  The channel-specific parameters used to render and deliver the one-time passcode for this request.

• #override_code_configuration_parameters ⇒ Types::CodeConfigurationParameters

  The per-send overrides for the passcode policy parameters, including the code type, length, validity period, and maximum number of attempts.

• #reference_id ⇒ String

  A caller-supplied reference identifier that binds a send request to a later validate request.

Instance Attribute Details

#channel ⇒ String

The channel used to deliver the one-time passcode to the recipient.

Returns:

• (String)

# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1454

class SendNotifyCodeVerificationInput < Struct.new(
  :channel,
  :destination_identity,
  :origination_identity,
  :notify_code_configuration,
  :override_channel_parameters,
  :override_code_configuration_parameters,
  :configuration_set_name,
  :context,
  :reference_id)
  SENSITIVE = [:destination_identity, :context]
  include Aws::Structure
end

#configuration_set_name ⇒ String

The name of the configuration set used to control how delivery events for the message are handled.

Returns:

• (String)

# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1454

class SendNotifyCodeVerificationInput < Struct.new(
  :channel,
  :destination_identity,
  :origination_identity,
  :notify_code_configuration,
  :override_channel_parameters,
  :override_code_configuration_parameters,
  :configuration_set_name,
  :context,
  :reference_id)
  SENSITIVE = [:destination_identity, :context]
  include Aws::Structure
end

#context ⇒ Hash<String,String>

A map of custom key and value pairs that are propagated to the delivery events for this verification.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1454

class SendNotifyCodeVerificationInput < Struct.new(
  :channel,
  :destination_identity,
  :origination_identity,
  :notify_code_configuration,
  :override_channel_parameters,
  :override_code_configuration_parameters,
  :configuration_set_name,
  :context,
  :reference_id)
  SENSITIVE = [:destination_identity, :context]
  include Aws::Structure
end

#destination_identity ⇒ String

The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.

Returns:

• (String)

# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1454

class SendNotifyCodeVerificationInput < Struct.new(
  :channel,
  :destination_identity,
  :origination_identity,
  :notify_code_configuration,
  :override_channel_parameters,
  :override_code_configuration_parameters,
  :configuration_set_name,
  :context,
  :reference_id)
  SENSITIVE = [:destination_identity, :context]
  include Aws::Structure
end

#notify_code_configuration ⇒ String

The identifier or Amazon Resource Name (ARN) of the notify code configuration that supplies the passcode policy and template defaults. When you do not specify a configuration, you must supply the template in the request.

Returns:

• (String)

# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1454

class SendNotifyCodeVerificationInput < Struct.new(
  :channel,
  :destination_identity,
  :origination_identity,
  :notify_code_configuration,
  :override_channel_parameters,
  :override_code_configuration_parameters,
  :configuration_set_name,
  :context,
  :reference_id)
  SENSITIVE = [:destination_identity, :context]
  include Aws::Structure
end

#origination_identity ⇒ String

The identity used to send the message, such as a phone number, sender ID, or pool that is owned by your account.

Returns:

• (String)

# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1454

class SendNotifyCodeVerificationInput < Struct.new(
  :channel,
  :destination_identity,
  :origination_identity,
  :notify_code_configuration,
  :override_channel_parameters,
  :override_code_configuration_parameters,
  :configuration_set_name,
  :context,
  :reference_id)
  SENSITIVE = [:destination_identity, :context]
  include Aws::Structure
end

#override_channel_parameters ⇒ Types::ChannelParameters

The channel-specific parameters used to render and deliver the one-time passcode for this request. The route that is derived from the channel and the origination identity selects the matching channel. When you do not specify channel parameters, the service uses the parameters from the referenced notify code configuration.

Returns:

• (Types::ChannelParameters)

# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1454

class SendNotifyCodeVerificationInput < Struct.new(
  :channel,
  :destination_identity,
  :origination_identity,
  :notify_code_configuration,
  :override_channel_parameters,
  :override_code_configuration_parameters,
  :configuration_set_name,
  :context,
  :reference_id)
  SENSITIVE = [:destination_identity, :context]
  include Aws::Structure
end

#override_code_configuration_parameters ⇒ Types::CodeConfigurationParameters

The per-send overrides for the passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. These values override the values from the referenced notify code configuration. When you do not specify a value, the value from the configuration is used, and if neither is set, the service default applies.

Returns:

• (Types::CodeConfigurationParameters)

# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1454

class SendNotifyCodeVerificationInput < Struct.new(
  :channel,
  :destination_identity,
  :origination_identity,
  :notify_code_configuration,
  :override_channel_parameters,
  :override_code_configuration_parameters,
  :configuration_set_name,
  :context,
  :reference_id)
  SENSITIVE = [:destination_identity, :context]
  include Aws::Structure
end

#reference_id ⇒ String

A caller-supplied reference identifier that binds a send request to a later validate request. Specify the same value in both requests.

Returns:

• (String)

# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1454

class SendNotifyCodeVerificationInput < Struct.new(
  :channel,
  :destination_identity,
  :origination_identity,
  :notify_code_configuration,
  :override_channel_parameters,
  :override_code_configuration_parameters,
  :configuration_set_name,
  :context,
  :reference_id)
  SENSITIVE = [:destination_identity, :context]
  include Aws::Structure
end