/AWS1/CL_SNS=>PUBLISH()
¶
About Publish¶
Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone
number, or a message to a mobile platform endpoint (when you specify the
TargetArn
).
If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.
When a messageId
is returned, the message is saved and Amazon SNS immediately
delivers it to subscribers.
To use the Publish
action for publishing a message to a mobile endpoint,
such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for
the TargetArn parameter. The EndpointArn is returned when making a call with the
CreatePlatformEndpoint
action.
For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
You can publish messages only to topics and endpoints in the same Amazon Web Services Region.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_MESSAGE
TYPE /AWS1/SNSMESSAGE
/AWS1/SNSMESSAGE
¶
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 tojson
and use a JSON object for theMessage
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).
Optional arguments:¶
IV_TOPICARN
TYPE /AWS1/SNSTOPICARN
/AWS1/SNSTOPICARN
¶
The topic you want to publish to.
If you don't specify a value for the
TopicArn
parameter, you must specify a value for thePhoneNumber
orTargetArn
parameters.
IV_TARGETARN
TYPE /AWS1/SNSSTRING
/AWS1/SNSSTRING
¶
If you don't specify a value for the
TargetArn
parameter, you must specify a value for thePhoneNumber
orTopicArn
parameters.
IV_PHONENUMBER
TYPE /AWS1/SNSPHONENUMBER
/AWS1/SNSPHONENUMBER
¶
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 theTargetArn
orTopicArn
parameters.
IV_SUBJECT
TYPE /AWS1/SNSSUBJECT
/AWS1/SNSSUBJECT
¶
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.
IV_MESSAGESTRUCTURE
TYPE /AWS1/SNSMESSAGESTRUCTURE
/AWS1/SNSMESSAGESTRUCTURE
¶
Set
MessageStructure
tojson
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 setMessageStructure
tojson
, the value of theMessage
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
IT_MESSAGEATTRIBUTES
TYPE /AWS1/CL_SNSMESSAGEATTRVALUE=>TT_MESSAGEATTRIBUTEMAP
TT_MESSAGEATTRIBUTEMAP
¶
Message attributes for Publish action.
IV_MESSAGEDEDUPLICATIONID
TYPE /AWS1/SNSSTRING
/AWS1/SNSSTRING
¶
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 particularMessageDeduplicationId
is sent successfully, any message sent with the sameMessageDeduplicationId
during the 5-minute deduplication interval is treated as a duplicate.If the topic has
ContentBasedDeduplication
set, the system generates aMessageDeduplicationId
based on the contents of the message. YourMessageDeduplicationId
overrides the generated one.
IV_MESSAGEGROUPID
TYPE /AWS1/SNSSTRING
/AWS1/SNSSTRING
¶
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 aMessageGroupId
.