AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Publishes up to 10 messages to the specified topic in a single batch. This is a batch
version of the Publish API. If you try to send more than 10 messages in a single
batch request, you will receive a TooManyEntriesInBatchRequest exception.
For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for five minutes.
The result of publishing each message is reported individually in the response. 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 200.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).
The PublishBatch API can send up to 10 messages at a time. If you attempt to
send more than 10 messages in one request, you will encounter a TooManyEntriesInBatchRequest
exception. In such cases, split your messages into multiple requests, each containing
no more than 10 messages.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values of n are integers starting from 1. For example, a parameter
list with two elements looks like this:
&AttributeName.1=first
&AttributeName.2=second
If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint.
When a messageId is returned, the batch message is saved, and Amazon SNS immediately
delivers the message to subscribers.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginPublishBatch and EndPublishBatch.
Namespace: Amazon.SimpleNotificationService
Assembly: AWSSDK.SimpleNotificationService.dll
Version: 3.x.y.z
public virtual Task<PublishBatchResponse> PublishBatchAsync( PublishBatchRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the PublishBatch service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| AuthorizationErrorException | Indicates that the user has been denied access to the requested resource. |
| BatchEntryIdsNotDistinctException | Two or more batch entries in the request have the same Id. |
| BatchRequestTooLongException | The length of all the batch messages put together is more than the limit. |
| EmptyBatchRequestException | The batch request doesn't contain any entries. |
| EndpointDisabledException | Exception error indicating endpoint disabled. |
| InternalErrorException | Indicates an internal service error. |
| InvalidBatchEntryIdException | The Id of a batch entry in a batch request doesn't abide by the specification. |
| InvalidParameterException | Indicates that a request parameter does not comply with the associated constraints. |
| InvalidParameterValueException | Indicates that a request parameter does not comply with the associated constraints. |
| InvalidSecurityException | The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. |
| KMSAccessDeniedException | The ciphertext references a key that doesn't exist or that you don't have access to. |
| KMSDisabledException | The request was rejected because the specified Amazon Web Services KMS key isn't enabled. |
| KMSInvalidStateException | 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 | The request was rejected because the specified entity or resource can't be found. |
| KMSOptInRequiredException | The Amazon Web Services access key ID needs a subscription for the service. |
| KMSThrottlingException | The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. |
| NotFoundException | Indicates that the requested resource does not exist. |
| PlatformApplicationDisabledException | Exception error indicating platform application disabled. |
| TooManyEntriesInBatchRequestException | The batch request contains more entries than permissible (more than 10). |
| ValidationException | Indicates that a parameter in the request is invalid. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer