AWS SDK Version 2 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.

.NET Framework 4.5
 
Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. (For more information visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.)

For example, let's say you have a message and its default message visibility timeout is 30 minutes. You could call ChangeMessageVisiblity with a value of two hours and the effective timeout would be two hours and 30 minutes. When that time comes near you could again extend the time out by calling ChangeMessageVisiblity, but this time the maximum allowed timeout would be 9 hours and 30 minutes.

There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received from the queue by a consuming component, but have not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon SQS. To help avoid reaching the limit, you should delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages.

If you attempt to set the VisibilityTimeout to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the ChangeMessageVisibility action.

Namespace: Amazon.SQS
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public virtual ChangeMessageVisibilityResponse ChangeMessageVisibility(
         ChangeMessageVisibilityRequest request
)

Parameters

request
Type: Amazon.SQS.Model.ChangeMessageVisibilityRequest

Container for the necessary parameters to execute the ChangeMessageVisibility service method.

Return Value
Type: Amazon.SQS.Model.ChangeMessageVisibilityResponse
The response from the ChangeMessageVisibility service method, as returned by SQS.

Exceptions

ExceptionCondition
MessageNotInflightException The message referred to is not in flight.
ReceiptHandleIsInvalidException The receipt handle provided is not valid.

Examples

This example shows how to change message visibility.

Change message visibility example

var client = new AmazonSQSClient();

var url = "https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyTestQueue";

// Receive messages.
var rcvRequest = new ReceiveMessageRequest
{
  AttributeNames = new List<string>() { "All" },
  QueueUrl = url
};

var rcvResponse = client.ReceiveMessage(rcvRequest);

// Change visibility timeout for each message.
if (rcvResponse.Messages.Count > 0)
{
  foreach (var message in rcvResponse.Messages)
  {
    var visRequest = new ChangeMessageVisibilityRequest
    {
      QueueUrl = url,
      ReceiptHandle = message.ReceiptHandle,
      VisibilityTimeout = (int)TimeSpan.FromMinutes(10).TotalSeconds
    };

    client.ChangeMessageVisibility(visRequest);
  }
}
else
{
  Console.WriteLine("No messages to change visibility for.");
}
      

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5