Skip to main content

ISQSChangeMessageVisibilityBatchRequest

Interface in AWS.SQS

Interface for ChangeMessageVisibilityBatch requests.

Ancestors

Properties

Entries

property Entries: TList<ISQSChangeMessageVisibilityBatchRequestEntry>

Type: ISQSChangeMessageVisibilityBatchRequestEntry

A collection of receipt handles and visibility timeout values for the messages to be updated.

You can send up to 10 entries with each ChangeMessageVisibilityBatch request. Each entry must have a unique identifier within the batch request. 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. If the batch contains more than 10 entries, a ESQSTooManyEntriesInBatchRequest error will be returned.

Methods

AddEntry

function AddEntry(const AId, AReceiptHandle: string; const AVisibilityTimeout: Integer): Integer; overload;

Adds an entry to the batch request.

Parameters

NameDescription
AIdA unique identifier used to communicate the results of this entry in the results.
AReceiptHandleThe receipt handle of the message whose visibility timeout is to be changed.
AVisibilityTimeoutNew value for the message's visibility timeout in seconds. Valid range from 0 to 43200 (12 hours).

Returns

The index of the added entry.


function AddEntry(const AId, AReceiptHandle: string): Integer; overload;

Adds an entry to the batch request.

Returns

The index of the added entry.