@@ -28,26 +28,40 @@ export interface PublishBatchCommandInput extends PublishBatchInput {}
2828export interface PublishBatchCommandOutput extends PublishBatchResponse , __MetadataBearer { }
2929
3030/**
31- * <p>Publishes up to ten messages to the specified topic. This is a batch version of
32- * <code>Publish</code>. For FIFO topics, multiple messages within a single batch are
33- * published in the order they are sent, and messages are deduplicated within the batch and
34- * across batches for 5 minutes.</p>
31+ * <p>Publishes up to 10 messages to the specified topic in a single batch. This is a batch
32+ * version of the <code>Publish</code> API. If you try to send more than 10 messages in a
33+ * single batch request, you will receive a <code>TooManyEntriesInBatchRequest</code>
34+ * exception.</p>
35+ * <p>For FIFO topics, multiple messages within a single batch are published in the order
36+ * they are sent, and messages are deduplicated within the batch and across batches for
37+ * five minutes.</p>
3538 * <p>The result of publishing each message is reported individually in the response.
3639 * Because the batch request can result in a combination of successful and unsuccessful
3740 * actions, you should check for batch errors even when the call returns an HTTP status
38- * code of <code>200</code>.</p>
39- * <p>The maximum allowed individual message size and the maximum total payload size (the
40- * sum of the individual lengths of all of the batched messages) are both 256 KB (262,144
41- * bytes). </p>
41+ * code of 200.</p>
42+ * <p>The maximum allowed individual message size and the maximum total payload size (the sum
43+ * of the individual lengths of all of the batched messages) are both 256 KB (262,144
44+ * bytes).</p>
45+ * <important>
46+ * <p>The <code>PublishBatch</code> API can send up to 10 messages at a time. If you
47+ * attempt to send more than 10 messages in one request, you will encounter a
48+ * <code>TooManyEntriesInBatchRequest</code> exception. In such cases, split your
49+ * messages into multiple requests, each containing no more than 10 messages.</p>
50+ * </important>
4251 * <p>Some actions take lists of parameters. These lists are specified using the
4352 * <code>param.n</code> notation. Values of <code>n</code> are integers starting from
44- * 1. For example, a parameter list with two elements looks like this: </p>
45- * <p>&AttributeName.1=first</p>
46- * <p>&AttributeName.2=second</p>
53+ * <b>1</b>. For example, a parameter list with two elements
54+ * looks like this:</p>
55+ * <p>
56+ * <code>&AttributeName.1=first</code>
57+ * </p>
58+ * <p>
59+ * <code>&AttributeName.2=second</code>
60+ * </p>
4761 * <p>If you send a batch message to a topic, Amazon SNS publishes the batch message to each
4862 * endpoint that is subscribed to the topic. The format of the batch message depends on the
4963 * notification protocol for each subscribed endpoint.</p>
50- * <p>When a <code>messageId</code> is returned, the batch message is saved and Amazon SNS
64+ * <p>When a <code>messageId</code> is returned, the batch message is saved, and Amazon SNS
5165 * immediately delivers the message to subscribers.</p>
5266 * @example
5367 * Use a bare-bones client and the command you need to make an API call.
@@ -168,7 +182,7 @@ export interface PublishBatchCommandOutput extends PublishBatchResponse, __Metad
168182 * <p>Exception error indicating platform application disabled.</p>
169183 *
170184 * @throws {@link TooManyEntriesInBatchRequestException } (client fault)
171- * <p>The batch request contains more entries than permissible.</p>
185+ * <p> The batch request contains more entries than permissible (more than 10) .</p>
172186 *
173187 * @throws {@link ValidationException } (client fault)
174188 * <p>Indicates that a parameter in the request is invalid.</p>
0 commit comments