Skip to content

Commit 4ff9d67

Browse files
author
awstools
committed
docs(client-sqs): Update invalid character handling documentation for SQS SendMessage API
1 parent 9ab54a2 commit 4ff9d67

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

clients/client-sqs/src/commands/SendMessageBatchCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
4444
* <p>
4545
* <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code>
4646
* </p>
47-
* <p>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.</p>
47+
* <p>If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exception.</p>
4848
* </important>
4949
* <p>If you don't specify the <code>DelaySeconds</code> parameter for an entry, Amazon SQS uses
5050
* the default value for the queue.</p>

clients/client-sqs/src/commands/SendMessageCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB
3535
* <p>
3636
* <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code>
3737
* </p>
38-
* <p>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.</p>
38+
* <p>If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exception.</p>
3939
* </important>
4040
* @example
4141
* Use a bare-bones client and the command you need to make an API call.

clients/client-sqs/src/models/models_0.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2410,7 +2410,7 @@ export interface SendMessageRequest {
24102410
* <p>
24112411
* <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code>
24122412
* </p>
2413-
* <p>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.</p>
2413+
* <p>If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exception.</p>
24142414
* </important>
24152415
* @public
24162416
*/

codegen/sdk-codegen/aws-models/sqs.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3499,7 +3499,7 @@
34993499
}
35003500
],
35013501
"traits": {
3502-
"smithy.api#documentation": "<p>Delivers a message to the specified queue.</p>\n <important>\n <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the <a href=\"http://www.w3.org/TR/REC-xml/#charsets\">W3C specification for characters</a>.</p>\n <p>\n <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code>\n </p>\n <p>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.</p>\n </important>"
3502+
"smithy.api#documentation": "<p>Delivers a message to the specified queue.</p>\n <important>\n <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the <a href=\"http://www.w3.org/TR/REC-xml/#charsets\">W3C specification for characters</a>.</p>\n <p>\n <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code>\n </p>\n <p>If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exception.</p>\n </important>"
35033503
}
35043504
},
35053505
"com.amazonaws.sqs#SendMessageBatch": {
@@ -3564,7 +3564,7 @@
35643564
}
35653565
],
35663566
"traits": {
3567-
"smithy.api#documentation": "<p>You can use <code>SendMessageBatch</code> to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of <code>\n <a>SendMessage</a>.</code> For a FIFO queue, multiple messages within a single batch are enqueued\n in the order they are sent.</p>\n <p>The result of sending each message is reported individually in the response.\n Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of <code>200</code>.</p>\n <p>The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 1 MiB \n 1,048,576 bytes.</p>\n <important>\n <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the <a href=\"http://www.w3.org/TR/REC-xml/#charsets\">W3C specification for characters</a>.</p>\n <p>\n <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code>\n </p>\n <p>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.</p>\n </important>\n <p>If you don't specify the <code>DelaySeconds</code> parameter for an entry, Amazon SQS uses\n the default value for the queue.</p>"
3567+
"smithy.api#documentation": "<p>You can use <code>SendMessageBatch</code> to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of <code>\n <a>SendMessage</a>.</code> For a FIFO queue, multiple messages within a single batch are enqueued\n in the order they are sent.</p>\n <p>The result of sending each message is reported individually in the response.\n Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of <code>200</code>.</p>\n <p>The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 1 MiB \n 1,048,576 bytes.</p>\n <important>\n <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the <a href=\"http://www.w3.org/TR/REC-xml/#charsets\">W3C specification for characters</a>.</p>\n <p>\n <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code>\n </p>\n <p>If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exception.</p>\n </important>\n <p>If you don't specify the <code>DelaySeconds</code> parameter for an entry, Amazon SQS uses\n the default value for the queue.</p>"
35683568
}
35693569
},
35703570
"com.amazonaws.sqs#SendMessageBatchRequest": {
@@ -3747,7 +3747,7 @@
37473747
"MessageBody": {
37483748
"target": "com.amazonaws.sqs#String",
37493749
"traits": {
3750-
"smithy.api#documentation": "<p>The message to send. The minimum size is one character. The maximum size is \n 1 MiB or 1,048,576 bytes</p>\n <important>\n <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the <a href=\"http://www.w3.org/TR/REC-xml/#charsets\">W3C specification for characters</a>.</p>\n <p>\n <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code>\n </p>\n <p>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.</p>\n </important>",
3750+
"smithy.api#documentation": "<p>The message to send. The minimum size is one character. The maximum size is \n 1 MiB or 1,048,576 bytes</p>\n <important>\n <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the <a href=\"http://www.w3.org/TR/REC-xml/#charsets\">W3C specification for characters</a>.</p>\n <p>\n <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code>\n </p>\n <p>If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exception.</p>\n </important>",
37513751
"smithy.api#required": {}
37523752
}
37533753
},

0 commit comments

Comments
 (0)