PublishBatch
Publishes up to ten messages to the specified topic. This is a batch version of
Publish
. 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 5 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).
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.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- PublishBatchRequestEntries.member.N
-
A list of
PublishBatch
request entries to be sent to the SNS topic.Type: Array of PublishBatchRequestEntry objects
Required: Yes
- TopicArn
-
The Amazon resource name (ARN) of the topic you want to batch publish to.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- Failed.member.N
-
A list of failed
PublishBatch
responses.Type: Array of BatchResultErrorEntry objects
- Successful.member.N
-
A list of successful
PublishBatch
responses.Type: Array of PublishBatchResultEntry objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AuthorizationError
-
Indicates that the user has been denied access to the requested resource.
HTTP Status Code: 403
- BatchEntryIdsNotDistinct
-
Two or more batch entries in the request have the same
Id
.HTTP Status Code: 400
- BatchRequestTooLong
-
The length of all the batch messages put together is more than the limit.
HTTP Status Code: 400
- EmptyBatchRequest
-
The batch request doesn't contain any entries.
HTTP Status Code: 400
- EndpointDisabled
-
Exception error indicating endpoint disabled.
HTTP Status Code: 400
- InternalError
-
Indicates an internal service error.
HTTP Status Code: 500
- InvalidBatchEntryId
-
The
Id
of a batch entry in a batch request doesn't abide by the specification.HTTP Status Code: 400
- InvalidParameter
-
Indicates that a request parameter does not comply with the associated constraints.
HTTP Status Code: 400
- InvalidSecurity
-
The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
HTTP Status Code: 403
- KMSAccessDenied
-
The ciphertext references a key that doesn't exist or that you don't have access to.
HTTP Status Code: 400
- KMSDisabled
-
The request was rejected because the specified Amazon KMS key isn't enabled.
HTTP Status Code: 400
- KMSInvalidState
-
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 KMS keys in the Amazon Key Management Service Developer Guide.
HTTP Status Code: 400
- KMSNotFound
-
The request was rejected because the specified entity or resource can't be found.
HTTP Status Code: 400
- KMSOptInRequired
-
The Amazon access key ID needs a subscription for the service.
HTTP Status Code: 403
- KMSThrottling
-
The request was denied due to request throttling. For more information about throttling, see Limits in the Amazon Key Management Service Developer Guide.
HTTP Status Code: 400
- NotFound
-
Indicates that the requested resource does not exist.
HTTP Status Code: 404
- ParameterValueInvalid
-
Indicates that a request parameter does not comply with the associated constraints.
HTTP Status Code: 400
- PlatformApplicationDisabled
-
Exception error indicating platform application disabled.
HTTP Status Code: 400
- TooManyEntriesInBatchRequest
-
The batch request contains more entries than permissible.
HTTP Status Code: 400
- Validation
-
Indicates that a parameter in the request is invalid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: