| 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.DeleteMessageBatch
Description
Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage. The result of the delete action on 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.
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'
- deleteMessageBatch :: Text -> DeleteMessageBatch
- data DeleteMessageBatch
- dmbQueueURL :: Lens' DeleteMessageBatch Text
- dmbEntries :: Lens' DeleteMessageBatch [DeleteMessageBatchRequestEntry]
- deleteMessageBatchResponse :: Int -> DeleteMessageBatchResponse
- data DeleteMessageBatchResponse
- dmbrsResponseStatus :: Lens' DeleteMessageBatchResponse Int
- dmbrsSuccessful :: Lens' DeleteMessageBatchResponse [DeleteMessageBatchResultEntry]
- dmbrsFailed :: Lens' DeleteMessageBatchResponse [BatchResultErrorEntry]
Creating a Request
Arguments
| :: Text | |
| -> DeleteMessageBatch |
Creates a value of DeleteMessageBatch with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DeleteMessageBatch Source
See: deleteMessageBatch smart constructor.
Instances
Request Lenses
dmbQueueURL :: Lens' DeleteMessageBatch Text Source
The URL of the Amazon SQS queue to take action on.
dmbEntries :: Lens' DeleteMessageBatch [DeleteMessageBatchRequestEntry] Source
A list of receipt handles for the messages to be deleted.
Destructuring the Response
deleteMessageBatchResponse Source
Arguments
| :: Int | |
| -> DeleteMessageBatchResponse |
Creates a value of DeleteMessageBatchResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DeleteMessageBatchResponse Source
For each message in the batch, the response contains a DeleteMessageBatchResultEntry tag if the message is deleted or a BatchResultErrorEntry tag if the message cannot be deleted.
See: deleteMessageBatchResponse smart constructor.
Response Lenses
dmbrsResponseStatus :: Lens' DeleteMessageBatchResponse Int Source
The response status code.
dmbrsSuccessful :: Lens' DeleteMessageBatchResponse [DeleteMessageBatchResultEntry] Source
A list of DeleteMessageBatchResultEntry items.
dmbrsFailed :: Lens' DeleteMessageBatchResponse [BatchResultErrorEntry] Source
A list of BatchResultErrorEntry items.