Struct MessageRequest 

#[non_exhaustive]
pub struct MessageRequest {
    pub addresses: Option<HashMap<String, AddressConfiguration>>,
    pub context: Option<HashMap<String, String>>,
    pub endpoints: Option<HashMap<String, EndpointSendConfiguration>>,
    pub message_configuration: Option<DirectMessageConfiguration>,
    pub template_configuration: Option<TemplateConfiguration>,
    pub trace_id: Option<String>,
}

Specifies the configuration and other settings for a message.

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.

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

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

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

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.

Implementations

impl MessageRequest

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

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

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

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.

impl MessageRequest

pub fn builder() -> MessageRequestBuilder

Creates a new builder-style object to manufacture MessageRequest.

Trait Implementations

impl Clone for MessageRequest

fn clone(&self) -> MessageRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageRequest

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

Formats the value using the given formatter.

impl PartialEq for MessageRequest

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MessageRequest