The Publish action sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected.

Namespace: Amazon.SimpleNotificationService.Model
Assembly: AWSSDK (in AWSSDK.dll) Version: 1.4.10.0 (1.4.10.0)

Syntax

         
 C#  Visual Basic  Visual C++ 
public class PublishRequest
Public Class PublishRequest
public ref class PublishRequest

Members

            
 All Members  Constructors   Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
PublishRequest()()()()
Initializes a new instance of the PublishRequest class
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
IsSetMessage()()()()
Checks if Message property is set
IsSetMessageStructure()()()()
Checks if MessageStructure property is set
IsSetSubject()()()()
Checks if Subject property is set
IsSetTopicArn()()()()
Checks if TopicArn property is set
Message
Gets and sets the Message property. The message you want to send to the topic.
MessageStructure
Gets and sets the MessageStructure property. Optional parameter. It will have one valid value: "json".

If this option, Message is present and set to "json", the value of Message must: be a syntactically valid JSON object. It must contain at least a top level JSON key of "default" with a value that is a string. For any other top level key that matches one of our transport protocols (e.g. "http"), then the corresponding value (if it is a string) will be used for the message published for that protocol

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. Typically, outbound notifications are JSON encoded (meaning, the characters will be reescaped for sending). JSON strings are UTF-8. 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 will be 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
Gets and sets the Subject property. Optional parameter to be used as the "Subject" line of when the message is delivered to e-mail endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
TopicArn
Gets and sets the TopicArn property. The topic you want to publish to.
ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
WithMessage(String)
Sets the Message property
WithMessageStructure(String)
Sets the MessageStructure property Valid values: "json"
WithSubject(String)
Sets the Subject property
WithTopicArn(String)
Sets the TopicArn property

Inheritance Hierarchy

System..::..Object
  Amazon.SimpleNotificationService.Model..::..PublishRequest

See Also