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.
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.
Access
public
Parameters
Parameter |
Type |
Required |
Description |
---|---|---|---|
|
Required |
The URL of the SQS queue to take action on. |
|
|
Required |
The receipt handle associated with the message whose visibility timeout should be changed. |
|
|
Required |
The new value (in seconds) for the message’s visibility timeout. |
|
|
Optional |
An associative array of parameters that can have the following keys:
|
Returns
Type |
Description |
---|---|
A |
Related Methods
Source
Method defined in services/sqs.class.php | Toggle source view (9 lines) | View on GitHub