Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages

Manual Reference Pages  -  PAWS::SNS::PUBLISH (3)

.ds Aq ’


Paws::SNS::Publish - Arguments for method Publish on Paws::SNS



This class represents the parameters used for calling the method Publish on the Amazon Simple Notification Service service. Use the attributes of this class as arguments to method Publish.

You shouln’t make instances of this class. Each attribute should be used as a named argument in the call to Publish.

As an example:

  $service_obj->Publish(Att1 => $value1, Att2 => $value2, ...);

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.


REQUIRED Message => Str

The message you want to send to the topic.

If 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. See the Examples section for the format of the JSON object.

Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters).

JSON-specific constraints:
o Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
o The values will be parsed (unescaped) before they are used in outgoing messages.
o Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
o Values have a minimum length of 0 (the empty string, "", is allowed).
o Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
o Non-string values will cause the key to be ignored.
o Keys that do not correspond to supported transport protocols are ignored.
o Duplicate keys are not allowed.
o Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).

    MessageAttributes => Paws::SNS::MessageAttributeMap

Message attributes for Publish action.

    MessageStructure => 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:
o be a syntactically valid JSON object; and
o 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).

For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.

Valid value: json

    Subject => 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 ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.

    TargetArn => Str

Either TopicArn or EndpointArn, but not both.

    TopicArn => Str

The topic you want to publish to.


This class forms part of Paws, documenting arguments for method Publish in Paws::SNS


The source code is located here:

Please report bugs to:

Search for    or go to Top of page |  Section 3 |  Main Index

perl v5.20.3 PAWS::SNS::PUBLISH (3) 2015-08-06

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.