SendMessageCommand

Suggest an Edit

Delivers a message to the specified queue.

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters .

#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF

Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.

Example Syntax

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

import { SQSClient, SendMessageCommand } from "@aws-sdk/client-sqs"; // ES Modules import
// const { SQSClient, SendMessageCommand } = require("@aws-sdk/client-sqs"); // CommonJS import
const client = new SQSClient(config);
const input = { // SendMessageRequest
  QueueUrl: "STRING_VALUE", // required
  MessageBody: "STRING_VALUE", // required
  DelaySeconds: Number("int"),
  MessageAttributes: { // MessageBodyAttributeMap
    "<keys>": { // MessageAttributeValue
      StringValue: "STRING_VALUE",
      BinaryValue: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
      StringListValues: [ // StringList
        "STRING_VALUE",
      ],
      BinaryListValues: [ // BinaryList
        new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
      ],
      DataType: "STRING_VALUE", // required
    },
  },
  MessageSystemAttributes: { // MessageBodySystemAttributeMap
    "<keys>": { // MessageSystemAttributeValue
      StringValue: "STRING_VALUE",
      BinaryValue: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
      StringListValues: [
        "STRING_VALUE",
      ],
      BinaryListValues: [
        new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
      ],
      DataType: "STRING_VALUE", // required
    },
  },
  MessageDeduplicationId: "STRING_VALUE",
  MessageGroupId: "STRING_VALUE",
};
const command = new SendMessageCommand(input);
const response = await client.send(command);
// { // SendMessageResult
//   MD5OfMessageBody: "STRING_VALUE",
//   MD5OfMessageAttributes: "STRING_VALUE",
//   MD5OfMessageSystemAttributes: "STRING_VALUE",
//   MessageId: "STRING_VALUE",
//   SequenceNumber: "STRING_VALUE",
// };

SendMessageCommand Input

See SendMessageCommandInput for more details

Parameter
Type
Description
MessageBody
Required
string | undefined

The message to send. The minimum size is one character. The maximum size is 256 KiB.

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters .

#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF

Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.

QueueUrl
Required
string | undefined

The URL of the Amazon SQS queue to which a message is sent.

Queue URLs and names are case-sensitive.

DelaySeconds
number | undefined

The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies.

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

MessageAttributes
Record<string, MessageAttributeValue> | undefined

Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes  in the Amazon SQS Developer Guide.

MessageDeduplicationId
string | undefined

This parameter applies only to FIFO (first-in-first-out) queues.

The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-once processing  in the Amazon SQS Developer Guide.

  • 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 queue, Amazon SQS 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 queue doesn't have ContentBasedDeduplication set, the action fails with an error.

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

  • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication 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 and only one copy of the message is delivered.

The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).

If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

The maximum length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;=?[]^_{|}~).

For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property  in the Amazon SQS Developer Guide.

MessageGroupId
string | undefined

This parameter applies only to FIFO (first-in-first-out) queues.

The 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). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion.

  • You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.

  • ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.

The maximum length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;=?[]^_{|}~).

For best practices of using MessageGroupId, see Using the MessageGroupId Property  in the Amazon SQS Developer Guide.

MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

MessageSystemAttributes
Partial<Record<MessageSystemAttributeNameForSends, MessageSystemAttributeValue> | undefined

The message system attribute to send. Each message system attribute consists of a Name, Type, and Value.

  • Currently, the only supported message system attribute is AWSTraceHeader. Its type must be String and its value must be a correctly formatted X-Ray trace header string.

  • The size of a message system attribute doesn't count towards the total size of a message.

SendMessageCommand Output

See SendMessageCommandOutput for details

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

An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321 .

MD5OfMessageBody
string | undefined

An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321 .

MD5OfMessageSystemAttributes
string | undefined

An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.

MessageId
string | undefined

An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers  in the Amazon SQS Developer Guide.

SequenceNumber
string | undefined

This parameter applies only to FIFO (first-in-first-out) queues.

The large, non-consecutive number that Amazon SQS assigns to each message.

The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.

Throws

Name
Fault
Details
InvalidAddress
client

The specified ID is invalid.

InvalidMessageContents
client

The message contains characters outside the allowed set.

InvalidSecurity
client

The request was not made over HTTPS or did not use SigV4 for signing.

KmsAccessDenied
client

The caller doesn't have the required KMS access.

KmsDisabled
client

The request was denied due to request throttling.

KmsInvalidKeyUsage
client

The request was rejected for one of the following reasons:

  • The KeyUsage value of the KMS key is incompatible with the API operation.

  • The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).

KmsInvalidState
client

The request was rejected because the state of the specified resource is not valid for this request.

KmsNotFound
client

The request was rejected because the specified entity or resource could not be found.

KmsOptInRequired
client

The request was rejected because the specified key policy isn't syntactically or semantically correct.

KmsThrottled
client

Amazon Web Services KMS throttles requests for the following conditions.

QueueDoesNotExist
client

Ensure that the QueueUrl is correct and that the queue has not been deleted.

RequestThrottled
client

The request was denied due to request throttling.

  • Exceeds the permitted request rate for the queue or for the recipient of the request.

  • Ensure that the request rate is within the Amazon SQS limits for sending messages. For more information, see Amazon SQS quotas  in the Amazon SQS Developer Guide.

UnsupportedOperation
client

Error code 400. Unsupported operation.

SQSServiceException
Base exception class for all service exceptions from SQS service.