| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.SQS.SendMessageBatch
Description
Delivers up to ten messages to the specified queue. This is a batch version of SendMessage. The result of the send action on each message is reported individually in the response. The maximum allowed individual message size is 256 KB (262,144 bytes).
The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes).
If the DelaySeconds parameter is not specified for an entry, the
default for the queue is used.
The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification. For more information, go to http://www.faqs.org/rfcs/rfc1321.html. If you send any characters that are not included in the list, your request will be rejected.
xA | x20 to xE000 to x10000 to #x10FFFF]
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.
Some API 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:
'&Attribute.1=this'
'&Attribute.2=that'
- sendMessageBatch :: Text -> SendMessageBatch
- data SendMessageBatch
- smbQueueURL :: Lens' SendMessageBatch Text
- smbEntries :: Lens' SendMessageBatch [SendMessageBatchRequestEntry]
- sendMessageBatchResponse :: Int -> SendMessageBatchResponse
- data SendMessageBatchResponse
- smbrsResponseStatus :: Lens' SendMessageBatchResponse Int
- smbrsSuccessful :: Lens' SendMessageBatchResponse [SendMessageBatchResultEntry]
- smbrsFailed :: Lens' SendMessageBatchResponse [BatchResultErrorEntry]
Creating a Request
Arguments
| :: Text | |
| -> SendMessageBatch |
Creates a value of SendMessageBatch with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data SendMessageBatch Source
See: sendMessageBatch smart constructor.
Instances
Request Lenses
smbQueueURL :: Lens' SendMessageBatch Text Source
The URL of the Amazon SQS queue to take action on.
smbEntries :: Lens' SendMessageBatch [SendMessageBatchRequestEntry] Source
A list of SendMessageBatchRequestEntry items.
Destructuring the Response
sendMessageBatchResponse Source
Arguments
| :: Int | |
| -> SendMessageBatchResponse |
Creates a value of SendMessageBatchResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data SendMessageBatchResponse Source
For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
See: sendMessageBatchResponse smart constructor.
Response Lenses
smbrsResponseStatus :: Lens' SendMessageBatchResponse Int Source
The response status code.
smbrsSuccessful :: Lens' SendMessageBatchResponse [SendMessageBatchResultEntry] Source
A list of SendMessageBatchResultEntry items.
smbrsFailed :: Lens' SendMessageBatchResponse [BatchResultErrorEntry] Source
A list of BatchResultErrorEntry items with the error detail about each message that could not be enqueued.