SendMessage
Delivers a message to the specified queue.
Important
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.
Request Syntax
{
"DelaySeconds": number
,
"MessageAttributes": {
"string
" : {
"BinaryListValues": [ blob
],
"BinaryValue": blob
,
"DataType": "string
",
"StringListValues": [ "string
" ],
"StringValue": "string
"
}
},
"MessageBody": "string
",
"MessageDeduplicationId": "string
",
"MessageGroupId": "string
",
"MessageSystemAttributes": {
"string
" : {
"BinaryListValues": [ blob
],
"BinaryValue": blob
,
"DataType": "string
",
"StringListValues": [ "string
" ],
"StringValue": "string
"
}
},
"QueueUrl": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- DelaySeconds
-
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.Note
When you set
FifoQueue
, you can't setDelaySeconds
per message. You can set this parameter only on a queue level.Type: Integer
Required: No
- MessageAttributes
-
Each message attribute consists of a
Name
,Type
, andValue
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.Type: String to MessageAttributeValue object map
Required: No
- MessageBody
-
The message to send. The minimum size is one character. The maximum size is 256 KiB.
Important
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.Type: String
Required: Yes
- MessageDeduplicationId
-
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 sameMessageDeduplicationId
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 enableContentBasedDeduplication
for your queue, Amazon SQS uses a SHA-256 hash to generate theMessageDeduplicationId
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 haveContentBasedDeduplication
set, the action fails with an error. -
If the queue has
ContentBasedDeduplication
set, yourMessageDeduplicationId
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 aMessageDeduplicationId
that is the same as the one generated for the firstMessageDeduplicationId
, the two messages are treated as duplicates and only one copy of the message is delivered.
Note
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.Type: String
Required: No
-
- MessageGroupId
-
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 aMessageGroupId
, the action fails. -
ReceiveMessage
might return messages with multipleMessageGroupId
values. For eachMessageGroupId
, the messages are sorted by time sent. The caller can't specify aMessageGroupId
.
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.Important
MessageGroupId
is required for FIFO queues. You can't use it for Standard queues.Type: String
Required: No
-
- MessageSystemAttributes
-
The message system attribute to send. Each message system attribute consists of a
Name
,Type
, andValue
.Important
-
Currently, the only supported message system attribute is
AWSTraceHeader
. Its type must beString
and its value must be a correctly formatted Amazon X-Ray trace header string. -
The size of a message system attribute doesn't count towards the total size of a message.
Type: String to MessageSystemAttributeValue object map
Valid Keys:
AWSTraceHeader
Required: No
-
- QueueUrl
-
The URL of the Amazon SQS queue to which a message is sent.
Queue URLs and names are case-sensitive.
Type: String
Required: Yes
Response Syntax
{
"MD5OfMessageAttributes": "string",
"MD5OfMessageBody": "string",
"MD5OfMessageSystemAttributes": "string",
"MessageId": "string",
"SequenceNumber": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- MD5OfMessageAttributes
-
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
. Type: String
- MD5OfMessageBody
-
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
. Type: String
- MD5OfMessageSystemAttributes
-
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.
Type: String
- MessageId
-
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.Type: String
- SequenceNumber
-
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 particularMessageGroupId
.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidAddress
-
The specified ID is invalid.
HTTP Status Code: 400
- InvalidMessageContents
-
The message contains characters outside the allowed set.
HTTP Status Code: 400
- InvalidSecurity
-
The request was not made over HTTPS or did not use SigV4 for signing.
HTTP Status Code: 400
- KmsAccessDenied
-
The caller doesn't have the required KMS access.
HTTP Status Code: 400
- KmsDisabled
-
The request was denied due to request throttling.
HTTP Status Code: 400
- KmsInvalidKeyUsage
-
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).
HTTP Status Code: 400
-
- KmsInvalidState
-
The request was rejected because the state of the specified resource is not valid for this request.
HTTP Status Code: 400
- KmsNotFound
-
The request was rejected because the specified entity or resource could not be found.
HTTP Status Code: 400
- KmsOptInRequired
-
The request was rejected because the specified key policy isn't syntactically or semantically correct.
HTTP Status Code: 400
- KmsThrottled
-
Amazon KMS throttles requests for the following conditions.
HTTP Status Code: 400
- QueueDoesNotExist
-
Ensure that the
QueueUrl
is correct and that the queue has not been deleted.HTTP Status Code: 400
- RequestThrottled
-
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.
HTTP Status Code: 400
-
- UnsupportedOperation
-
Error code 400. Unsupported operation.
HTTP Status Code: 400
Examples
The following example SendMessage
request sends a message containing
This is a test message
to the queue. You must URL-encode the entire URL. However, in this example only the message body is URL-encoded to make the example easier to read.
The structure of AUTHPARAMS
depends on the signature of the API request.
For more information, see
Examples of Signed Signature Version 4 Requests in the
Amazon General Reference.
Example
Using Amazon JSON protocol (Default)
Sample Request
POST / HTTP/1.1
Host: sqs.us-east-1.amazonaws.com
X-Amz-Target: AmazonSQS.SendMessage
X-Amz-Date: <Date>
Content-Type: application/x-amz-json-1.0
Authorization: <AuthParams>
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
{
"QueueUrl": "https://sqs.us-east-1.amazonaws.com/177715257436/MyQueue/",
"MessageBody": "This is a test message",
"MessageAttributes": {
"my_attribute_name_1": {
"DataType": "String",
"StringValue": "my_attribute_value_1"
},
"my_attribute_name_2": {
"DataType": "String",
"StringValue": "my_attribute_value_2"
}
}
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <requestId>
Content-Length: <PayloadSizeBytes>
Date: <Date>
Content-Type: application/x-amz-json-1.0
{
"MD5OfMessageAttributes": "c48838208d2b4e14e3ca0093a8443f09",
"MD5OfMessageBody": "fafb00f5732ab283681e124bf8747ed1",
"MessageId": "219f8380-5770-4cc2-8c3e-5c715e145f5e"
}
Example
Using Amazon query protocol
Sample Request
POST /177715257436/MyQueue/ HTTP/1.1
Host: sqs.us-east-1.amazonaws.com
X-Amz-Date: <Date>
Content-Type: application/x-www-form-urlencoded
Authorization: <AuthParams>
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
Action=SendMessage
&MessageBody=This+is+a+test+message
&MessageAttribute.1.Name=my_attribute_name_1
&MessageAttribute.1.Value.StringValue=my_attribute_value_1
&MessageAttribute.1.Value.DataType=String
&MessageAttribute.2.Name=my_attribute_name_2
&MessageAttribute.2.Value.StringValue=my_attribute_value_2
&MessageAttribute.2.Value.DataType=String
Sample Response
HTTP/1.1 200 OK
<?xml version="1.0"?>
<SendMessageResponse xmlns="http://queue.amazonaws.com/doc/2012-11-05/">
<SendMessageResult>
<MessageId>374cec7b-d0c8-4a2e-ad0b-67be763cf97e</MessageId>
<MD5OfMessageBody>fafb00f5732ab283681e124bf8747ed1</MD5OfMessageBody>
<MD5OfMessageAttributes>c48838208d2b4e14e3ca0093a8443f09</MD5OfMessageAttributes>
</SendMessageResult>
<ResponseMetadata>
<RequestId>7fe4446e-b452-53f7-8f85-181e06f2dd99</RequestId>
</ResponseMetadata>
</SendMessageResponse>
Example
The following example creates a message
timer—applying a 45-second initial visibility delay to a
single message— by calling the SendMessage
action with the
DelaySeconds
parameter set to 45 seconds.
Note
Queue URLs and names are case-sensitive.
Using Amazon JSON protocol (Default)
Sample Request
POST / HTTP/1.1
Host: sqs.us-east-1.amazonaws.com
X-Amz-Target: AmazonSQS.SendMessage
X-Amz-Date: <Date>
Content-Type: application/x-amz-json-1.0
Authorization: <AuthParams>
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
{
"QueueUrl": "https://sqs.us-east-1.amazonaws.com/177715257436/MyQueue/",
"MessageBody": "This is a test message",
"DelaySeconds": 45
}
Example
Using Amazon query protocol
Sample Request
POST /177715257436/MyQueue/ HTTP/1.1
Host: sqs.us-east-1.amazonaws.com
X-Amz-Date: <Date>
Content-Type: application/x-www-form-urlencoded
Authorization: <AuthParams>
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
Action=SendMessage
&MessageBody=This+is+a+test+message
&DelaySeconds=45
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: