Publish - Amazon Simple Notification Service (original) (raw)

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 theTargetArn).

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 theCreatePlatformEndpoint action. The second example below shows a request and response for publishing to a mobile endpoint.

For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.

Important

You can publish messages only to topics and endpoints in the same AWS Region.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Message

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 theMessageStructure parameter to json and use a JSON object for the Message parameter. See the Examples section for the format of the JSON object.

Constraints:

JSON-specific constraints:

Type: String

Required: Yes

MessageAttributes

MessageAttributes.entry.N.Name (key)

MessageAttributes.entry.N.Value (value)

Message attributes for Publish action.

Type: String to MessageAttributeValue object map

Required: No

MessageDeduplicationId

Type: String

Required: No

MessageGroupId

This parameter applies only to FIFO (first-in-first-out) topics. TheMessageGroupId 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.

Type: String

Required: No

MessageStructure

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 theMessage parameter must:

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

Type: String

Required: No

PhoneNumber

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.

Type: String

Required: No

Subject

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.

Type: String

Required: No

TargetArn

If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.

Type: String

Required: No

TopicArn

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.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

MessageId

Unique identifier assigned to the published message.

Length Constraint: Maximum 100 characters

Type: String

SequenceNumber

This response element applies only to FIFO (first-in-first-out) topics.

The sequence number is a large, non-consecutive number that Amazon SNS assigns to each message. The length of SequenceNumber is 128 bits.SequenceNumber continues to increase for eachMessageGroupId.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AuthorizationError

Indicates that the user has been denied access to the requested resource.

HTTP Status Code: 403

EndpointDisabled

Exception error indicating endpoint disabled.

HTTP Status Code: 400

InternalError

Indicates an internal service error.

HTTP Status Code: 500

InvalidParameter

Indicates that a request parameter does not comply with the associated constraints.

HTTP Status Code: 400

InvalidSecurity

The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.

HTTP Status Code: 403

KMSAccessDenied

The ciphertext references a key that doesn't exist or that you don't have access to.

HTTP Status Code: 400

KMSDisabled

The request was rejected because the specified AWS KMS key isn't enabled.

HTTP Status Code: 400

KMSInvalidState

The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of AWS KMS keys in the AWS Key Management Service Developer Guide.

HTTP Status Code: 400

KMSNotFound

The request was rejected because the specified entity or resource can't be found.

HTTP Status Code: 400

KMSOptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403

KMSThrottling

The request was denied due to request throttling. For more information about throttling, see Limits in the AWS Key Management Service Developer Guide.

HTTP Status Code: 400

NotFound

Indicates that the requested resource does not exist.

HTTP Status Code: 404

ParameterValueInvalid

Indicates that a request parameter does not comply with the associated constraints.

HTTP Status Code: 400

PlatformApplicationDisabled

Exception error indicating platform application disabled.

HTTP Status Code: 400

Validation

Indicates that a parameter in the request is invalid.

HTTP Status Code: 400

Examples

The structure of AUTHPARAMS depends on the signature of the API request. For more information, see Examples of the complete Signature Version 4 signing process (Python) in the AWS General Reference.

Example

This example illustrates one usage of Publish.

Sample Request

https://sns.us-west-2.amazonaws.com/?Action=Publish
&TargetArn=arn%3Aaws%3Asns%3Aus-west-2%3A803981987763%3Aendpoint%2FAPNS_SANDBOX%2Fpushapp%2F98e9ced9-f136-3893-9d60-776547eafebb
&Message=%7B%22default%22%3A%22This+is+the+default+Message%22%2C%22APNS_SANDBOX%22%3A%22%7B+%5C%22aps%5C%22+%3A+%7B+%5C%22alert%5C%22+%3A+%5C%22You+have+got+email.%5C%22%2C+%5C%22badge%5C%22+%3A+9%2C%5C%22sound%5C%22+%3A%5C%22default%5C%22%7D%7D%22%7D
&Version=2010-03-31
&AUTHPARAMS

Sample Response

<PublishResponse xmlns="https://sns.amazonaws.com/doc/2010-03-31/">
    <PublishResult>
        <MessageId>567910cd-659e-55d4-8ccb-5aaf14679dc0</MessageId>
    </PublishResult>
    <ResponseMetadata>
        <RequestId>d74b8436-ae13-5ab4-a9ff-ce54dfea72a0</RequestId>
    </ResponseMetadata>
</PublishResponse>

Example

The following example publishes a different messages to each protocol:

The JSON format for Message is as follows:

{
    "default": "A message.",
    "email": "A message for email.",
    "email-json": "A message for email (JSON).",
    "http": "A message for HTTP.",
    "https": "A message for HTTPS.",
    "sqs": "A message for Amazon SQS."
}

Sample Request

https://sns.us-east-2.amazonaws.com/?Action=Publish
&TopicArn=arn%3Aaws%3Asns%3Aus-east-2%3A698519295917%3AMy-Topic
&Subject=My%20first%20message
&Message=Hello%20world%21 
&Version=2010-03-31
&AUTHPARAMS

Sample Response

<PublishResponse xmlns="https://sns.amazonaws.com/doc/2010-03-31/">
    <PublishResult>
        <MessageId>94f20ce6-13c5-43a0-9a9e-ca52d816e90b</MessageId>
    </PublishResult>
    <ResponseMetadata>
        <RequestId>f187a3c1-376f-11df-8963-01868b7c937a</RequestId>
    </ResponseMetadata>
</PublishResponse>

Example

The following example allows you to specify different message content for different transport protocols (SMS, email, and push notification):

The JSON format for MessageStructure is as follows:

  "default": "This is the default message",
  "email": "This is the email message",
  "sms": "This is the SMS message",
  "app1": "This is the message for app1",
  "app2": "This is the message for app2"
}
&Version=2010-03-31
&AUTHPARAMS

Sample Request

https://sns.us-east-2.amazonaws.com/?Action=Publish
&TopicArn=arn%3Aaws%3Asns%3Aus-east-2%3A698519295917%3AMy-Topic
&Subject=My%20first%20message
&Message=Hello%20world%21
&MessageStructure=json
&Message={
  "default": "This is the default message",
  "email": "This is the email message",
  "sms": "This is the SMS message",
  "app1": "This is the message for app1",
  "app2": "This is the message for app2"
}
&Version=2010-03-31
&AUTHPARAMS

Sample Response

<PublishResponse xmlns="https://sns.amazonaws.com/doc/2010-03-31/">
  <PublishResult>
    <MessageId>95df01b4-ee98-5cb9-9069-4b046b850ca6</MessageId>
  </PublishResult>
  <ResponseMetadata>
    <RequestId>c6101522-8f6a-5d59-8e6e-cb9bc1bf0c9f</RequestId>
  </ResponseMetadata>
</PublishResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: