Class: Aws::Pinpoint::Types::MessageRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::MessageRequest
- Defined in:
- gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb
Overview
Specifies the configuration and other settings for a message.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#addresses ⇒ Hash<String,Types::AddressConfiguration>
A map of key-value pairs, where each key is an address and each value is an [AddressConfiguration][1] object.
-
#context ⇒ Hash<String,String>
A map of custom attributes to attach to the message.
-
#endpoints ⇒ Hash<String,Types::EndpointSendConfiguration>
A map of key-value pairs, where each key is an endpoint ID and each value is an [EndpointSendConfiguration][1] object.
-
#message_configuration ⇒ Types::DirectMessageConfiguration
The settings and content for the default message and any default messages that you defined for specific channels.
-
#template_configuration ⇒ Types::TemplateConfiguration
The message template to use for the message.
-
#trace_id ⇒ String
The unique identifier for tracing the message.
Instance Attribute Details
#addresses ⇒ Hash<String,Types::AddressConfiguration>
A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.
9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9428 class MessageRequest < Struct.new( :addresses, :context, :endpoints, :message_configuration, :template_configuration, :trace_id) SENSITIVE = [] include Aws::Structure end |
#context ⇒ Hash<String,String>
A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9428 class MessageRequest < Struct.new( :addresses, :context, :endpoints, :message_configuration, :template_configuration, :trace_id) SENSITIVE = [] include Aws::Structure end |
#endpoints ⇒ Hash<String,Types::EndpointSendConfiguration>
A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.
9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9428 class MessageRequest < Struct.new( :addresses, :context, :endpoints, :message_configuration, :template_configuration, :trace_id) SENSITIVE = [] include Aws::Structure end |
#message_configuration ⇒ Types::DirectMessageConfiguration
The settings and content for the default message and any default messages that you defined for specific channels.
9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9428 class MessageRequest < Struct.new( :addresses, :context, :endpoints, :message_configuration, :template_configuration, :trace_id) SENSITIVE = [] include Aws::Structure end |
#template_configuration ⇒ Types::TemplateConfiguration
The message template to use for the message.
9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9428 class MessageRequest < Struct.new( :addresses, :context, :endpoints, :message_configuration, :template_configuration, :trace_id) SENSITIVE = [] include Aws::Structure end |
#trace_id ⇒ String
The unique identifier for tracing the message. This identifier is visible to message recipients.
9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 9428 class MessageRequest < Struct.new( :addresses, :context, :endpoints, :message_configuration, :template_configuration, :trace_id) SENSITIVE = [] include Aws::Structure end |