Class: Aws::Pinpoint::Types::SendUsersMessageRequest

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

Overview

Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#context ⇒ Hash<String,String>

A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.

Returns:

  • (Hash<String,String>) 


11576
11577
11578
11579
11580
11581
11582
11583
11584
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 11576

class SendUsersMessageRequest < Struct.new(
  :context,
  :message_configuration,
  :template_configuration,
  :trace_id,
  :users)
  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.

Returns:



11576
11577
11578
11579
11580
11581
11582
11583
11584
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 11576

class SendUsersMessageRequest < Struct.new(
  :context,
  :message_configuration,
  :template_configuration,
  :trace_id,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#template_configuration ⇒ Types::TemplateConfiguration

The message template to use for the message.

Returns:



11576
11577
11578
11579
11580
11581
11582
11583
11584
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 11576

class SendUsersMessageRequest < Struct.new(
  :context,
  :message_configuration,
  :template_configuration,
  :trace_id,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#trace_id ⇒ String

The unique identifier for tracing the message. This identifier is visible to message recipients.

Returns:

  • (String) 


11576
11577
11578
11579
11580
11581
11582
11583
11584
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 11576

class SendUsersMessageRequest < Struct.new(
  :context,
  :message_configuration,
  :template_configuration,
  :trace_id,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#users ⇒ Hash<String,Types::EndpointSendConfiguration>

A map that associates user IDs with [EndpointSendConfiguration] objects. You can use an [EndpointSendConfiguration] object to tailor the message for a user by specifying settings such as content overrides and message variables.

[1]: docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration

Returns:



11576
11577
11578
11579
11580
11581
11582
11583
11584
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 11576

class SendUsersMessageRequest < Struct.new(
  :context,
  :message_configuration,
  :template_configuration,
  :trace_id,
  :users)
  SENSITIVE = []
  include Aws::Structure
end