Struct aws_sdk_pinpoint::model::SendUsersMessageRequest

#[non_exhaustive]
pub struct SendUsersMessageRequest {
    pub context: Option<HashMap<String, String>>,
    pub message_configuration: Option<DirectMessageConfiguration>,
    pub template_configuration: Option<TemplateConfiguration>,
    pub trace_id: Option<String>,
    pub users: Option<HashMap<String, EndpointSendConfiguration>>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

context: Option<HashMap<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.

message_configuration: Option<DirectMessageConfiguration>

The settings and content for the default message and any default messages that you defined for specific channels.

template_configuration: Option<TemplateConfiguration>

The message template to use for the message.

trace_id: Option<String>

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

users: Option<HashMap<String, 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.

Implementations

impl SendUsersMessageRequest

pub fn context(&self) -> Option<&HashMap<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.

pub fn message_configuration(&self) -> Option<&DirectMessageConfiguration>

The settings and content for the default message and any default messages that you defined for specific channels.

pub fn template_configuration(&self) -> Option<&TemplateConfiguration>

The message template to use for the message.

pub fn trace_id(&self) -> Option<&str>

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

pub fn users(&self) -> Option<&HashMap<String, 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.

impl SendUsersMessageRequest

pub fn builder() -> Builder

Creates a new builder-style object to manufacture SendUsersMessageRequest

Trait Implementations

impl Clone for SendUsersMessageRequest

fn clone(&self) -> SendUsersMessageRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SendUsersMessageRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<SendUsersMessageRequest> for SendUsersMessageRequest

fn eq(&self, other: &SendUsersMessageRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SendUsersMessageRequest) -> bool

This method tests for !=.

impl StructuralPartialEq for SendUsersMessageRequest