Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Gets attributes for the specified queue. The following attributes are supported:
All
- returns all values.ApproximateNumberOfMessages
- returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.ApproximateNumberOfMessagesNotVisible
- returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.VisibilityTimeout
- returns the visibility timeout for the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.CreatedTimestamp
- returns the time when the queue was created (epoch time in seconds).LastModifiedTimestamp
- returns the time when the queue was last changed (epoch time in seconds).Policy
- returns the queue's policy.MaximumMessageSize
- returns the limit of how many bytes a message can contain before Amazon SQS rejects it.MessageRetentionPeriod
- returns the number of seconds Amazon SQS retains a message.QueueArn
- returns the queue's Amazon resource name (ARN).ApproximateNumberOfMessagesDelayed
- returns the approximate number of messages that are pending to be added to the queue.DelaySeconds
- returns the default delay on the queue in seconds.ReceiveMessageWaitTimeSeconds
- returns the time for which a ReceiveMessage call will wait for a message to arrive.RedrivePolicy
- returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.
Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
Some API actions take lists of parameters. These lists are specified
using the 'param.n' notation. Values of n
are integers starting from
1. For example, a parameter list with two elements looks like this:
'&Attribute.1=this'
'&Attribute.2=that'
See: AWS API Reference for GetQueueAttributes.
- getQueueAttributes :: Text -> GetQueueAttributes
- data GetQueueAttributes
- gqaAttributeNames :: Lens' GetQueueAttributes [QueueAttributeName]
- gqaQueueURL :: Lens' GetQueueAttributes Text
- getQueueAttributesResponse :: Int -> GetQueueAttributesResponse
- data GetQueueAttributesResponse
- gqarsAttributes :: Lens' GetQueueAttributesResponse (HashMap QueueAttributeName Text)
- gqarsStatus :: Lens' GetQueueAttributesResponse Int
Creating a Request
Creates a value of GetQueueAttributes
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetQueueAttributes Source
See: getQueueAttributes
smart constructor.
Request Lenses
gqaAttributeNames :: Lens' GetQueueAttributes [QueueAttributeName] Source
A list of attributes to retrieve information for.
gqaQueueURL :: Lens' GetQueueAttributes Text Source
The URL of the Amazon SQS queue to take action on.
Destructuring the Response
getQueueAttributesResponse Source
Creates a value of GetQueueAttributesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetQueueAttributesResponse Source
A list of returned queue attributes.
See: getQueueAttributesResponse
smart constructor.
Response Lenses
gqarsAttributes :: Lens' GetQueueAttributesResponse (HashMap QueueAttributeName Text) Source
A map of attributes to the respective values.
gqarsStatus :: Lens' GetQueueAttributesResponse Int Source
The response status code.