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.

Container for the parameters to the DeleteMessageBatch operation. 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:



Inheritance Hierarchy


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


public class DeleteMessageBatchRequest : AmazonSQSRequest

The DeleteMessageBatchRequest type exposes the following members


Public Method DeleteMessageBatchRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method DeleteMessageBatchRequest(string, List<DeleteMessageBatchRequestEntry>)

Instantiates DeleteMessageBatchRequest with the parameterized properties


Public Property Entries System.Collections.Generic.List<Amazon.SQS.Model.DeleteMessageBatchRequestEntry>

Gets and sets the property Entries.

A list of receipt handles for the messages to be deleted.

Public Property QueueUrl System.String

Gets and sets the property QueueUrl.

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

Queue URLs are case-sensitive.


This example shows how to delete messages in batch.

Batch delete messages example

var client = new AmazonSQSClient();

var request = new ReceiveMessageRequest
  AttributeNames = new List() { "All" },
  MaxNumberOfMessages = 5,
  QueueUrl = "",
  VisibilityTimeout = (int)TimeSpan.FromMinutes(10).TotalSeconds,
  WaitTimeSeconds = (int)TimeSpan.FromSeconds(5).TotalSeconds

var response = client.ReceiveMessage(request);
var batchEntries = new List();

if (response.Messages.Count > 0)
  foreach (var message in response.Messages)
    var batchEntry = new DeleteMessageBatchRequestEntry
      Id = message.MessageId,
      ReceiptHandle = message.ReceiptHandle


  var delRequest = new DeleteMessageBatchRequest
    Entries = batchEntries,
    QueueUrl = ""

  var delResponse = client.DeleteMessageBatch(delRequest);

  if (delResponse.Failed.Count > 0)
    Console.WriteLine("Failed deletions:");

    foreach (var failure in delResponse.Failed)
      Console.WriteLine("  For ID '" + failure.Id + "': ");
      Console.WriteLine("    Code = " + failure.Code);
      Console.WriteLine("    Message = " + failure.Message);
      Console.WriteLine("    Sender's fault? = " + failure.SenderFault);

  if (delResponse.Successful.Count > 0)
    Console.WriteLine("Successful deletions:");

    foreach (var success in delResponse.Successful)
      Console.WriteLine("  ID '" + success.Id + "'");
  Console.WriteLine("No messages to delete.");

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.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

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