Prev		Next

GetVisibilityTimeout (SOAP)

The GetVisibilityTimeout action retrieves the VisibilityTimeout value set on the queue specified. See SetVisibilityTimeout for more information about VisibilityTimeout.

Validation

GetVisibilityTimeout requests are validated on the following:

The value specified for QueueName must be alphanumeric of length 1 to 80.

Returns

Returns Success and the current visibility timeout setting if successful or an error response if unsuccessful.

Request Parameters

This operation has no input parameters other than those common to all requests to SQS. See SOAP Parameters for more information.

Example GetVisibilityTimeout Request (SOAP)

The following example GetVisibilityTimeout request returns the VisibilityTimeout value for the queue specified.

Sample Request

<soap:Body wsu:Id="body"
 xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<m:GetVisibilityTimeout
xmlns:m="http://queue.amazonaws.com/doc/2006-04-01/">
</m:GetVisibilityTimeout>
</soap:Body>

Sample Response

<GetVisibilityTimeoutResponse>
    <VisibilityTimeout>
      35
    </VisibilityTimeout>
    <ResponseStatus>
      <StatusCode>Success</StatusCode>
      <RequestId>cb919c0a-9bce-4afe-9b48-9bdf2412bb67</RequestId>
    </ResponseStatus>
</GetVisibilityTimeoutResponse>

Error Responses

Error	Description
InvalidURI	The URL for the queue is not valid or was not a URL returned by a `CreateQueue` or `ListQueues` request.