GetQueueAttributes
Gets attributes for the specified queue.
To determine whether a queue is FIFO, you can check whether QueueName
ends with the .fifo
suffix.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- AttributeName.N
-
A list of attributes for which to retrieve information.
Note In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
The following attributes are supported:
Important The
ApproximateNumberOfMessagesDelayed
,ApproximateNumberOfMessagesNotVisible
, andApproximateNumberOfMessagesVisible
metrics may not achieve consistency until at least 1 minute after the producers stop sending messages. This period is required for the queue metadata to reach eventual consistency.-
All
– Returns all values. -
ApproximateNumberOfMessages
– Returns the approximate number of messages available for retrieval from the queue. -
ApproximateNumberOfMessagesDelayed
– Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter. -
ApproximateNumberOfMessagesNotVisible
– Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window. -
CreatedTimestamp
– Returns the time when the queue was created in seconds (epoch time). -
DelaySeconds
– Returns the default delay on the queue in seconds. -
LastModifiedTimestamp
– Returns the time when the queue was last changed in seconds (epoch time). -
MaximumMessageSize
– Returns the limit of how many bytes a message can contain before Amazon SQS rejects it. -
MessageRetentionPeriod
– Returns the length of time, in seconds, for which Amazon SQS retains a message. -
Policy
– Returns the policy of the queue. -
QueueArn
– Returns the Amazon resource name (ARN) of the queue. -
ReceiveMessageWaitTimeSeconds
– Returns the length of time, in seconds, for which theReceiveMessage
action waits for a message to arrive. -
RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.-
deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value ofmaxReceiveCount
is exceeded. -
maxReceiveCount
– The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When theReceiveCount
for a message exceeds themaxReceiveCount
for a queue, Amazon SQS moves the message to the dead-letter-queue.
-
-
VisibilityTimeout
– Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
The following attributes apply only to server-side-encryption:
-
KmsMasterKeyId
– Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. -
KmsDataKeyReusePeriodSeconds
– Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.
The following attributes apply only to FIFO (first-in-first-out) queues:
-
FifoQueue
– Returns information about whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.Note To determine whether a queue is FIFO, you can check whether
QueueName
ends with the.fifo
suffix. -
ContentBasedDeduplication
– Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
Preview: High throughput for FIFO queues
High throughput for Amazon SQS FIFO queues is in preview release and is subject to change. This feature provides a high number of transactions per second (TPS) for messages in FIFO queues. For information on throughput quotas, see Quotas related to messages in the Amazon Simple Queue Service Developer Guide.
This preview includes two new attributes:
-
DeduplicationScope
– Specifies whether message deduplication occurs at the message group or queue level. Valid values aremessageGroup
andqueue
. -
FifoThroughputLimit
– Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values areperQueue
andperMessageGroupId
. TheperMessageGroupId
value is allowed only when the value forDeduplicationScope
ismessageGroup
.
To enable high throughput for FIFO queues, do the following:
-
Set
DeduplicationScope
tomessageGroup
. -
Set
FifoThroughputLimit
toperMessageGroupId
.
If you set these attributes to anything other than the values shown for enabling high throughput, standard throughput is in effect and deduplication occurs as specified.
This preview is available in the following AWS Regions:
-
US East (Ohio); us-east-2
-
US East (N. Virginia); us-east-1
-
US West (Oregon); us-west-2
-
Europe (Ireland); eu-west-1
For more information about high throughput for FIFO queues, see Preview: High throughput for FIFO queues in the Amazon Simple Queue Service Developer Guide.
Type: Array of strings
Valid Values:
All | Policy | VisibilityTimeout | MaximumMessageSize | MessageRetentionPeriod | ApproximateNumberOfMessages | ApproximateNumberOfMessagesNotVisible | CreatedTimestamp | LastModifiedTimestamp | QueueArn | ApproximateNumberOfMessagesDelayed | DelaySeconds | ReceiveMessageWaitTimeSeconds | RedrivePolicy | FifoQueue | ContentBasedDeduplication | KmsMasterKeyId | KmsDataKeyReusePeriodSeconds | DeduplicationScope | FifoThroughputLimit
Required: No
-
- QueueUrl
-
The URL of the Amazon SQS queue whose attribute information is retrieved.
Queue URLs and names are case-sensitive.
Type: String
Required: Yes
Response Elements
The following element is returned by the service.
- Attribute
- Attribute.N.Name (key)
- Attribute.N.Value (value)
-
A map of attributes to their respective values.
Type: String to string map
Valid Keys:
All | Policy | VisibilityTimeout | MaximumMessageSize | MessageRetentionPeriod | ApproximateNumberOfMessages | ApproximateNumberOfMessagesNotVisible | CreatedTimestamp | LastModifiedTimestamp | QueueArn | ApproximateNumberOfMessagesDelayed | DelaySeconds | ReceiveMessageWaitTimeSeconds | RedrivePolicy | FifoQueue | ContentBasedDeduplication | KmsMasterKeyId | KmsDataKeyReusePeriodSeconds | DeduplicationScope | FifoThroughputLimit
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidAttributeName
-
The specified attribute doesn't exist.
HTTP Status Code: 400
Examples
Example
The following example query requests gets all the attribute values for the specified
queue. The structure of AUTHPARAMS
depends on the signature of the API request.
For more information, see
Examples of Signed Signature Version 4 Requests in the Amazon Web Services General Reference.
Sample Request
https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue/
?Action=GetQueueAttributes
&AttributeName.1=All
&Expires=2020-10-18T22%3A52%3A43PST
&Version=2012-11-05
&AUTHPARAMS
Sample Response
<GetQueueAttributesResponse>
<GetQueueAttributesResult>
<Attribute>
<Name>ReceiveMessageWaitTimeSeconds</Name>
<Value>2</Value>
</Attribute>
<Attribute>
<Name>VisibilityTimeout</Name>
<Value>30</Value>
</Attribute>
<Attribute>
<Name>ApproximateNumberOfMessages</Name>
<Value>0</Value>
</Attribute>
<Attribute>
<Name>ApproximateNumberOfMessagesNotVisible</Name>
<Value>0</Value>
</Attribute>
<Attribute>
<Name>CreatedTimestamp</Name>
<Value>1286771522</Value>
</Attribute>
<Attribute>
<Name>LastModifiedTimestamp</Name>
<Value>1286771522</Value>
</Attribute>
<Attribute>
<Name>QueueArn</Name>
<Value>arn:aws:sqs:us-east-2:123456789012:MyQueue</Value>
</Attribute>
<Attribute>
<Name>MaximumMessageSize</Name>
<Value>8192</Value>
</Attribute>
<Attribute>
<Name>MessageRetentionPeriod</Name>
<Value>345600</Value>
</Attribute>
</GetQueueAttributesResult>
<ResponseMetadata>
<RequestId>1ea71be5-b5a2-4f9d-b85a-945d8d08cd0b</RequestId>
</ResponseMetadata>
</GetQueueAttributesResponse>
Example
The following example query request gets three attribute values for the specified
queue. The structure of AUTHPARAMS
depends on the signature of the API request.
For more information, see
Examples of Signed Signature Version 4 Requests in the Amazon Web Services General Reference.
Sample Request
https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue/
?Action=GetQueueAttributes
&Action=GetQueueAttributes
&AttributeName.1=VisibilityTimeout
&AttributeName.2=DelaySeconds
&AttributeName.3=ReceiveMessageWaitTimeSeconds
&Expires=2020-10-18T22%3A52%3A43PST
&Version=2012-11-05
&AUTHPARAMS
Sample Response
<GetQueueAttributesResponse>
<GetQueueAttributesResult>
<Attribute>
<Name>VisibilityTimeout</Name>
<Value>30</Value>
</Attribute>
<Attribute>
<Name>DelaySeconds</Name>
<Value>0</Value>
</Attribute>
<Attribute>
<Name>ReceiveMessageWaitTimeSeconds</Name>
<Value>2</Value>
</Attribute>
</GetQueueAttributesResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: