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.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&Attribute.1=this

&Attribute.2=that

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. For Unity the operation does not take CancellationToken as a parameter, and instead takes AmazonServiceCallback<DeleteMessageBatchRequest, DeleteMessageBatchResponse> and AsyncOptions as additional parameters.

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

Syntax

C#
public virtual 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 are case-sensitive.

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

A list of 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.
InvalidBatchEntryIdException The Id of a batch entry in a batch request doesn't abide by the specification.
TooManyEntriesInBatchRequestException The batch request contains more entries than permissible.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone

See Also