PublishCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SNSClient, PublishCommand } from "@aws-sdk/client-sns"; // ES Modules import
// const { SNSClient, PublishCommand } = require("@aws-sdk/client-sns"); // CommonJS import
const client = new SNSClient(config);
const input = { // PublishInput
  TopicArn: "STRING_VALUE",
  TargetArn: "STRING_VALUE",
  PhoneNumber: "STRING_VALUE",
  Message: "STRING_VALUE", // required
  Subject: "STRING_VALUE",
  MessageStructure: "STRING_VALUE",
  MessageAttributes: { // MessageAttributeMap
    "<keys>": { // MessageAttributeValue
      DataType: "STRING_VALUE", // required
      StringValue: "STRING_VALUE",
      BinaryValue: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
    },
  },
  MessageDeduplicationId: "STRING_VALUE",
  MessageGroupId: "STRING_VALUE",
};
const command = new PublishCommand(input);
const response = await client.send(command);
// { // PublishResponse
//   MessageId: "STRING_VALUE",
//   SequenceNumber: "STRING_VALUE",
// };

PublishCommand Input

See PublishCommandInput for more details

Parameter
Type
Description
Message
Required
string | undefined

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

MessageAttributes
Record<string, MessageAttributeValue> | undefined

Message attributes for Publish action.

MessageDeduplicationId
string | undefined

  • 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 within the 5 minute minimum deduplication interval.

  • The scope of deduplication depends on the FifoThroughputScope attribute, when set to Topic the message deduplication scope is across the entire topic, when set to MessageGroup the message deduplication scope is within each individual message group.

  • If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages within the deduplication scope and interval, with the same MessageDeduplicationId, are accepted successfully but aren't delivered.

  • Every message must have a unique MessageDeduplicationId:

    • You may provide a MessageDeduplicationId explicitly.

    • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your topic, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

    • If you don't provide a MessageDeduplicationId and the topic doesn't have ContentBasedDeduplication set, the action fails with an error.

    • If the topic has a ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

  • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication scope and interval are treated as duplicates and only one copy of the message is delivered.

  • If you send one message with ContentBasedDeduplication enabled, and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates, within the deduplication scope and interval, and only one copy of the message is delivered.

MessageGroupId
string | undefined

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.

MessageStructure
string | undefined

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

PhoneNumber
string | undefined

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.

Subject
string | undefined

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.

TargetArn
string | undefined

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

TopicArn
string | undefined

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.

PublishCommand Output

See PublishCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
MessageId
string | undefined

Unique identifier assigned to the published message.

Length Constraint: Maximum 100 characters

SequenceNumber
string | undefined

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 each MessageGroupId.

Throws

Name
Fault
Details
AuthorizationErrorException
client

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

EndpointDisabledException
client

Exception error indicating endpoint disabled.

InternalErrorException
server

Indicates an internal service error.

InvalidParameterException
client

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

InvalidParameterValueException
client

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

InvalidSecurityException
client

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

KMSAccessDeniedException
client

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

KMSDisabledException
client

The request was rejected because the specified Amazon Web Services KMS key isn't enabled.

KMSInvalidStateException
client

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

KMSNotFoundException
client

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

KMSOptInRequired
client

The Amazon Web Services access key ID needs a subscription for the service.

KMSThrottlingException
client

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

NotFoundException
client

Indicates that the requested resource does not exist.

PlatformApplicationDisabledException
client

Exception error indicating platform application disabled.

ValidationException
client

Indicates that a parameter in the request is invalid.

SNSServiceException
Base exception class for all service exceptions from SNS service.