ChangeMessageVisibilityRequest Class

.NET Framework 4.5
 
 
 
Did this page help you?  Yes  No   Tell us about it...
Container for the parameters to the ChangeMessageVisibility operation.

The ChangeMessageVisibility action 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.

IMPORTANT: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.

IMPORTANT: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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SQS.Model.ChangeMessageVisibilityRequest

Namespace: Amazon.SQS.Model
Assembly: AWSSDK.dll
Version: 2.0.0.3

Syntax

C#
public class ChangeMessageVisibilityRequest : AmazonWebServiceRequest
         IRequestEvents

The ChangeMessageVisibilityRequest type exposes the following members

Constructors

  Name Description
Public Method ChangeMessageVisibilityRequest()

Properties

  Name Description
Public Property QueueUrl The URL of the SQS queue to take action on.
Public Property ReceiptHandle The receipt handle associated with the message whose visibility timeout should be changed.
Public Property VisibilityTimeout The new value (in seconds) for the message's visibility timeout.

Version Information

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

.NET for Windows Store apps:
Supported in: Windows 8

.NET for Windows Phone:
Supported in: Window Phone 8