Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Deletes up to ten messages from the specified queue. This is a batch version of
The result of the action on each message is reported individually in the response.DeleteMessage
.
Important: 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
.
Synopsis
- 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
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:
dmbQueueURL
- The URL of the Amazon SQS queue from which messages are deleted. Queue URLs are case-sensitive.dmbEntries
- A list of receipt handles for the messages to be deleted.
data DeleteMessageBatch Source #
See: deleteMessageBatch
smart constructor.
Instances
Request Lenses
dmbQueueURL :: Lens' DeleteMessageBatch Text Source #
The URL of the Amazon SQS queue from which messages are deleted. Queue URLs are case-sensitive.
dmbEntries :: Lens' DeleteMessageBatch [DeleteMessageBatchRequestEntry] Source #
A list of receipt handles for the messages to be deleted.
Destructuring the Response
deleteMessageBatchResponse Source #
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:
dmbrsResponseStatus
- -- | The response status code.dmbrsSuccessful
- A list of
items.DeleteMessageBatchResultEntry
dmbrsFailed
- A list of
items.BatchResultErrorEntry
data DeleteMessageBatchResponse Source #
For each message in the batch, the response contains a
tag if the message is deleted or a DeleteMessageBatchResultEntry
tag if the message can't be deleted.BatchResultErrorEntry
See: deleteMessageBatchResponse
smart constructor.
Instances
Response Lenses
dmbrsResponseStatus :: Lens' DeleteMessageBatchResponse Int Source #
- - | The response status code.
dmbrsSuccessful :: Lens' DeleteMessageBatchResponse [DeleteMessageBatchResultEntry] Source #
A list of
items.DeleteMessageBatchResultEntry
dmbrsFailed :: Lens' DeleteMessageBatchResponse [BatchResultErrorEntry] Source #
A list of
items.BatchResultErrorEntry