Copyright | (c) 2013-2016 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.
&Attribute.1=this
&Attribute.2=that
- getQueueAttributes :: Text -> GetQueueAttributes
- data GetQueueAttributes
- gqaAttributeNames :: Lens' GetQueueAttributes [QueueAttributeName]
- gqaQueueURL :: Lens' GetQueueAttributes Text
- getQueueAttributesResponse :: Int -> GetQueueAttributesResponse
- data GetQueueAttributesResponse
- gqarsAttributes :: Lens' GetQueueAttributesResponse (HashMap QueueAttributeName Text)
- gqarsResponseStatus :: 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:
gqaAttributeNames
- A list of attributes for which to retrieve information. 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 . *ApproximateNumberOfMessagesDelayed
- Returns the approximate number of messages that are waiting to be added to the queue. *ApproximateNumberOfMessagesNotVisible
- Returns the approximate number of messages that have not timed-out and are not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide . *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 number of 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 number of seconds for which 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 the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide . *VisibilityTimeout
- Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide . The following attributes apply only to FIFO (first-in-first-out) queues : *FifoQueue
- Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide . *ContentBasedDeduplication
- Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide .gqaQueueURL
- The URL of the Amazon SQS queue to take action on. Queue URLs are case-sensitive.
data GetQueueAttributes Source #
See: getQueueAttributes
smart constructor.
Request Lenses
gqaAttributeNames :: Lens' GetQueueAttributes [QueueAttributeName] Source #
A list of attributes for which to retrieve information. 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 . * ApproximateNumberOfMessagesDelayed
- Returns the approximate number of messages that are waiting to be added to the queue. * ApproximateNumberOfMessagesNotVisible
- Returns the approximate number of messages that have not timed-out and are not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide . * 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 number of 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 number of seconds for which 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 the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide . * VisibilityTimeout
- Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide . The following attributes apply only to FIFO (first-in-first-out) queues : * FifoQueue
- Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide . * ContentBasedDeduplication
- Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide .
gqaQueueURL :: Lens' GetQueueAttributes Text Source #
The URL of the Amazon SQS queue to take action on. Queue URLs are case-sensitive.
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:
gqarsAttributes
- A map of attributes to the respective values.gqarsResponseStatus
- -- | The response status code.
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.
gqarsResponseStatus :: Lens' GetQueueAttributesResponse Int Source #
- - | The response status code.