DeleteMessageRequest Class | AWS SDK for .NET V3

Container for the parameters to the DeleteMessage operation. Deletes the specified message from the specified queue. To select the message to delete, use the ReceiptHandle of the message (not the MessageId which you receive when you send the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than the retention period configured for the queue.

The ReceiptHandle is associated with a specific instance of receiving a message. If you receive a message more than once, the ReceiptHandle is different each time you receive a message. When you use the DeleteMessage action, you must provide the most recently received ReceiptHandle for the message (otherwise, the request succeeds, but the message will not be deleted).

For standard queues, it is possible to receive a message even after you delete it. This might happen on rare occasions if one of the servers which stores a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you during a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SQS.AmazonSQSRequest
      Amazon.SQS.Model.DeleteMessageRequest

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

Syntax

public class DeleteMessageRequest : AmazonSQSRequest
         IAmazonWebServiceRequest

The DeleteMessageRequest type exposes the following members

Constructors

	Name	Description
	DeleteMessageRequest()	Empty constructor used to set properties independently even when a simple constructor is available
	DeleteMessageRequest(string, string)	Instantiates DeleteMessageRequest with the parameterized properties

Properties

	Name	Type	Description
	QueueUrl	System.String	Gets and sets the property QueueUrl. The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and names are case-sensitive.
	ReceiptHandle	System.String	Gets and sets the property ReceiptHandle. The receipt handle associated with the message to delete.

Name

Type

Description

QueueUrl

System.String

Gets and sets the property QueueUrl.

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

Queue URLs and names are case-sensitive.

ReceiptHandle

System.String

Gets and sets the property ReceiptHandle.

The receipt handle associated with the message to delete.

Examples

This example shows how to delete a message.

Delete message example

var client = new AmazonSQSClient();

var request = new ReceiveMessageRequest
{
  AttributeNames = new List<string>() { "All" },
  MaxNumberOfMessages = 5,
  QueueUrl = "https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyTestQueue",
  VisibilityTimeout = (int)TimeSpan.FromMinutes(10).TotalSeconds,
  WaitTimeSeconds = (int)TimeSpan.FromSeconds(5).TotalSeconds
};

var response = client.ReceiveMessage(request);

if (response.Messages.Count > 0)
{
  foreach (var message in response.Messages)
  {
    Console.Write("Message ID '" + message.MessageId + "' ");

    var delRequest = new DeleteMessageRequest
    {
      QueueUrl = "https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyTestQueue",
      ReceiptHandle = message.ReceiptHandle
    };

    var delResponse = client.DeleteMessage(delRequest);
  }
}
else
{
  Console.WriteLine("No messages to delete.");
}

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5