receipt handle and not the message ID
you received when you sent the message. Even if the message is locked by another reader
due to the visibility timeout setting, it is still deleted from the queue. If you
leave a message in the queue for longer than the queue's configured retention period,
Amazon SQS automatically deletes it.
The receipt handle is associated with a specific instance of receiving the message.
If you receive a message more than once, the receipt handle you get each time you
receive the message is different. When you request DeleteMessage, if
you don't provide the most recently received receipt handle for the message, the request
will still succeed, but the message might not be deleted.
It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.SQS.AmazonSQSRequest
Amazon.SQS.Model.DeleteMessageRequest
Namespace: Amazon.SQS.Model
Assembly: AWSSDK.dll
Version: (assembly version)
Syntax
public class DeleteMessageRequest : AmazonSQSRequest IRequestEvents
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 to take action on. |
|
|
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 Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8