Skip to content

change_message_visibility_batch

Operation

change_message_visibility_batch

change_message_visibility_batch(request: ChangeMessageVisibilityBatchInput | ChangeMessageVisibilityBatchInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ChangeMessageVisibilityBatchInputDict]) -> ChangeMessageVisibilityBatchOutput

Changes the visibility timeout of multiple messages. This is a batch version of ``ChangeMessageVisibility``. The result of the action on each message is reported individually in the response. You can send up to 10 ``ChangeMessageVisibility`` requests with each ChangeMessageVisibilityBatch action.

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 ChangeMessageVisibilityBatchInput | ChangeMessageVisibilityBatchInputDict | 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[ChangeMessageVisibilityBatchInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ChangeMessageVisibilityBatchOutput

An instance of ChangeMessageVisibilityBatchOutput.

change_message_visibility_batch async

change_message_visibility_batch(request: ChangeMessageVisibilityBatchInput | ChangeMessageVisibilityBatchInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ChangeMessageVisibilityBatchInputDict]) -> ChangeMessageVisibilityBatchOutput

Changes the visibility timeout of multiple messages. This is a batch version of ``ChangeMessageVisibility``. The result of the action on each message is reported individually in the response. You can send up to 10 ``ChangeMessageVisibility`` requests with each ChangeMessageVisibilityBatch action.

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 ChangeMessageVisibilityBatchInput | ChangeMessageVisibilityBatchInputDict | 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[ChangeMessageVisibilityBatchInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ChangeMessageVisibilityBatchOutput

An instance of ChangeMessageVisibilityBatchOutput.

Input

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

ChangeMessageVisibilityBatchInputDict

Bases: TypedDict

Dictionary form of ChangeMessageVisibilityBatchInput.

Attributes

entries instance-attribute

Lists the receipt handles of the messages for which the visibility timeout must be changed.

queue_url instance-attribute
queue_url: Required[str]

The URL of the Amazon SQS queue whose messages' visibility is changed.

Queue URLs and names are case-sensitive.

ChangeMessageVisibilityBatchInput dataclass

Bases: _SerdeShape

Attributes

entries class-attribute instance-attribute

Lists the receipt handles of the messages for which the visibility timeout must be changed.

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

The URL of the Amazon SQS queue whose messages' visibility is changed.

Queue URLs and names are case-sensitive.

Output

ChangeMessageVisibilityBatchOutput dataclass

Bases: _SerdeShape

For each message in the batch, the response contains a ``ChangeMessageVisibilityBatchResultEntry`` tag if the message succeeds or a ``BatchResultErrorEntry`` tag if the message fails.

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 ``ChangeMessageVisibilityBatchResultEntry`` items.