AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDeleteMessageBatch and EndDeleteMessageBatch.

Namespace: Amazon.SQS
Assembly: AWSSDK.SQS.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<DeleteMessageBatchResponse> DeleteMessageBatchAsync(
         String queueUrl,
         List<DeleteMessageBatchRequestEntry> entries,
         CancellationToken cancellationToken
)

Parameters

queueUrl
Type: System.String

The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and names are case-sensitive.

entries
Type: System.Collections.Generic.List<Amazon.SQS.Model.DeleteMessageBatchRequestEntry>

Lists the receipt handles for the messages to be deleted.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DeleteMessageBatch service method, as returned by SQS.

Exceptions

ExceptionCondition
BatchEntryIdsNotDistinctException Two or more batch entries in the request have the same Id.
EmptyBatchRequestException The batch request doesn't contain any entries.
InvalidAddressException The accountId is invalid.
InvalidBatchEntryIdException The Id of a batch entry in a batch request doesn't abide by the specification.
InvalidSecurityException When the request to a queue is not HTTPS and SigV4.
QueueDoesNotExistException The specified queue doesn't exist.
RequestThrottledException The request was denied due to request throttling. The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region. A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key." Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
TooManyEntriesInBatchRequestException The batch request contains more entries than permissible.
UnsupportedOperationException Error code 400. Unsupported operation.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also