Skip to content

delete_message_batch

Operation

delete_message_batch

delete_message_batch(request: DeleteMessageBatchInput | DeleteMessageBatchInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteMessageBatchInputDict]) -> 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
request DeleteMessageBatchInput | DeleteMessageBatchInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DeleteMessageBatchInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteMessageBatchOutput

An instance of DeleteMessageBatchOutput.

delete_message_batch async

delete_message_batch(request: DeleteMessageBatchInput | DeleteMessageBatchInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteMessageBatchInputDict]) -> 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
request DeleteMessageBatchInput | DeleteMessageBatchInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DeleteMessageBatchInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteMessageBatchOutput

An instance of DeleteMessageBatchOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DeleteMessageBatchInputDict

Bases: TypedDict

Dictionary form of DeleteMessageBatchInput.

Attributes

entries instance-attribute

Lists the receipt handles for the messages to be deleted.

queue_url instance-attribute
queue_url: Required[str]

The URL of the Amazon SQS queue from which messages are deleted.

Queue URLs and names are case-sensitive.

DeleteMessageBatchInput dataclass

Bases: _SerdeShape

Attributes

entries class-attribute instance-attribute
entries: list[DeleteMessageBatchRequestEntry] | None = ...

Lists the receipt handles for the messages to be deleted.

queue_url class-attribute instance-attribute
queue_url: str | None = ...

The URL of the Amazon SQS queue from which messages are deleted.

Queue URLs and names are case-sensitive.

Output

DeleteMessageBatchOutput dataclass

Bases: _SerdeShape

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

failed instance-attribute

A list of ``BatchResultErrorEntry`` items.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

successful instance-attribute

A list of ``DeleteMessageBatchResultEntry`` items.