Struct aws_sdk_sns::operation::publish::PublishInput
source · #[non_exhaustive]pub struct PublishInput {
pub topic_arn: Option<String>,
pub target_arn: Option<String>,
pub phone_number: Option<String>,
pub message: Option<String>,
pub subject: Option<String>,
pub message_structure: Option<String>,
pub message_attributes: Option<HashMap<String, MessageAttributeValue>>,
pub message_deduplication_id: Option<String>,
pub message_group_id: Option<String>,
}
Expand description
Input for Publish action.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.topic_arn: Option<String>
The topic you want to publish to.
If you don't specify a value for the TopicArn
parameter, you must specify a value for the PhoneNumber
or TargetArn
parameters.
target_arn: Option<String>
If you don't specify a value for the TargetArn
parameter, you must specify a value for the PhoneNumber
or TopicArn
parameters.
phone_number: Option<String>
The phone number to which you want to deliver an SMS message. Use E.164 format.
If you don't specify a value for the PhoneNumber
parameter, you must specify a value for the TargetArn
or TopicArn
parameters.
message: Option<String>
The message you want to send.
If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure
parameter to json
and use a JSON object for the Message
parameter.
Constraints:
-
With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
-
For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
The total size limit for a single SMS
Publish
action is 1,600 characters.
JSON-specific constraints:
-
Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
-
The values will be parsed (unescaped) before they are used in outgoing messages.
-
Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
-
Values have a minimum length of 0 (the empty string, "", is allowed).
-
Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
-
Non-string values will cause the key to be ignored.
-
Keys that do not correspond to supported transport protocols are ignored.
-
Duplicate keys are not allowed.
-
Failure to parse or validate any key or value in the message will cause the
Publish
call to return an error (no partial delivery).
subject: Option<String>
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be UTF-8 text with no line breaks or control characters, and less than 100 characters long.
message_structure: Option<String>
Set MessageStructure
to json
if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure
to json
, the value of the Message
parameter must:
-
be a syntactically valid JSON object; and
-
contain at least a top-level JSON key of "default" with a value that is a string.
You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").
Valid value: json
message_attributes: Option<HashMap<String, MessageAttributeValue>>
Message attributes for Publish action.
message_deduplication_id: Option<String>
This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId
can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9)
and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
Every message must have a unique MessageDeduplicationId
, which is a token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId
is sent successfully, any message sent with the same MessageDeduplicationId
during the 5-minute deduplication interval is treated as a duplicate.
If the topic has ContentBasedDeduplication
set, the system generates a MessageDeduplicationId
based on the contents of the message. Your MessageDeduplicationId
overrides the generated one.
message_group_id: Option<String>
This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId
can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9)
and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
The MessageGroupId
is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a MessageGroupId
.
Implementations§
source§impl PublishInput
impl PublishInput
sourcepub fn topic_arn(&self) -> Option<&str>
pub fn topic_arn(&self) -> Option<&str>
The topic you want to publish to.
If you don't specify a value for the TopicArn
parameter, you must specify a value for the PhoneNumber
or TargetArn
parameters.
sourcepub fn target_arn(&self) -> Option<&str>
pub fn target_arn(&self) -> Option<&str>
If you don't specify a value for the TargetArn
parameter, you must specify a value for the PhoneNumber
or TopicArn
parameters.
sourcepub fn phone_number(&self) -> Option<&str>
pub fn phone_number(&self) -> Option<&str>
The phone number to which you want to deliver an SMS message. Use E.164 format.
If you don't specify a value for the PhoneNumber
parameter, you must specify a value for the TargetArn
or TopicArn
parameters.
sourcepub fn message(&self) -> Option<&str>
pub fn message(&self) -> Option<&str>
The message you want to send.
If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure
parameter to json
and use a JSON object for the Message
parameter.
Constraints:
-
With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
-
For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.
If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.
The total size limit for a single SMS
Publish
action is 1,600 characters.
JSON-specific constraints:
-
Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
-
The values will be parsed (unescaped) before they are used in outgoing messages.
-
Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
-
Values have a minimum length of 0 (the empty string, "", is allowed).
-
Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
-
Non-string values will cause the key to be ignored.
-
Keys that do not correspond to supported transport protocols are ignored.
-
Duplicate keys are not allowed.
-
Failure to parse or validate any key or value in the message will cause the
Publish
call to return an error (no partial delivery).
sourcepub fn subject(&self) -> Option<&str>
pub fn subject(&self) -> Option<&str>
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
Constraints: Subjects must be UTF-8 text with no line breaks or control characters, and less than 100 characters long.
sourcepub fn message_structure(&self) -> Option<&str>
pub fn message_structure(&self) -> Option<&str>
Set MessageStructure
to json
if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure
to json
, the value of the Message
parameter must:
-
be a syntactically valid JSON object; and
-
contain at least a top-level JSON key of "default" with a value that is a string.
You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").
Valid value: json
sourcepub fn message_attributes(
&self,
) -> Option<&HashMap<String, MessageAttributeValue>>
pub fn message_attributes( &self, ) -> Option<&HashMap<String, MessageAttributeValue>>
Message attributes for Publish action.
sourcepub fn message_deduplication_id(&self) -> Option<&str>
pub fn message_deduplication_id(&self) -> Option<&str>
This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId
can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9)
and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
Every message must have a unique MessageDeduplicationId
, which is a token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId
is sent successfully, any message sent with the same MessageDeduplicationId
during the 5-minute deduplication interval is treated as a duplicate.
If the topic has ContentBasedDeduplication
set, the system generates a MessageDeduplicationId
based on the contents of the message. Your MessageDeduplicationId
overrides the generated one.
sourcepub fn message_group_id(&self) -> Option<&str>
pub fn message_group_id(&self) -> Option<&str>
This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId
can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9)
and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
.
The MessageGroupId
is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a MessageGroupId
.
source§impl PublishInput
impl PublishInput
sourcepub fn builder() -> PublishInputBuilder
pub fn builder() -> PublishInputBuilder
Creates a new builder-style object to manufacture PublishInput
.
Trait Implementations§
source§impl Clone for PublishInput
impl Clone for PublishInput
source§fn clone(&self) -> PublishInput
fn clone(&self) -> PublishInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for PublishInput
impl Debug for PublishInput
source§impl PartialEq for PublishInput
impl PartialEq for PublishInput
source§fn eq(&self, other: &PublishInput) -> bool
fn eq(&self, other: &PublishInput) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for PublishInput
Auto Trait Implementations§
impl Freeze for PublishInput
impl RefUnwindSafe for PublishInput
impl Send for PublishInput
impl Sync for PublishInput
impl Unpin for PublishInput
impl UnwindSafe for PublishInput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more