delete_message_batch¶
Operation¶
async
¶
delete_message_batch(input: DeleteMessageBatchInput, plugins: list[Plugin] | None = None) -> DeleteMessageBatchOutput
Deletes up to ten messages from the specified queue. This is a batch
version of ``DeleteMessage``. The result of the action on each
message is reported individually in the response.
Warning
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DeleteMessageBatchInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DeleteMessageBatchOutput
|
An instance of |
Input¶
dataclass
¶
Attributes¶
class-attribute
instance-attribute
¶
entries: list[DeleteMessageBatchRequestEntry] | None = None
Lists the receipt handles for the messages to be deleted.
Output¶
dataclass
¶
For each message in the batch, the response contains a
``DeleteMessageBatchResultEntry`` tag if the message is deleted or a
``BatchResultErrorEntry`` tag if the message can't be deleted.
Attributes¶
instance-attribute
¶
failed: list[BatchResultErrorEntry]
A list of ``BatchResultErrorEntry`` items.
instance-attribute
¶
successful: list[DeleteMessageBatchResultEntry]
A list of ``DeleteMessageBatchResultEntry`` items.