Network.AWS.SQS.GetQueueAttributes

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'

Creating a Request

getQueueAttributes

Arguments

:: Text

gqaQueueURL

-> GetQueueAttributes

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
• gqaQueueURL

data GetQueueAttributes

See: getQueueAttributes smart constructor.

Instances

Eq GetQueueAttributes

Data GetQueueAttributes

Read GetQueueAttributes

Show GetQueueAttributes

Generic GetQueueAttributes

Hashable GetQueueAttributes

AWSRequest GetQueueAttributes

ToPath GetQueueAttributes

ToHeaders GetQueueAttributes

ToQuery GetQueueAttributes

type Rep GetQueueAttributes

type Rs GetQueueAttributes = GetQueueAttributesResponse

Request Lenses

gqaAttributeNames :: Lens' GetQueueAttributes [QueueAttributeName]

A list of attributes to retrieve information for.

gqaQueueURL :: Lens' GetQueueAttributes Text

The URL of the Amazon SQS queue to take action on.

Destructuring the Response

getQueueAttributesResponse

Arguments

:: Int

gqarsResponseStatus

-> GetQueueAttributesResponse

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
• gqarsResponseStatus

data GetQueueAttributesResponse

A list of returned queue attributes.

See: getQueueAttributesResponse smart constructor.

Instances

Eq GetQueueAttributesResponse

Data GetQueueAttributesResponse

Read GetQueueAttributesResponse

Show GetQueueAttributesResponse

Generic GetQueueAttributesResponse

type Rep GetQueueAttributesResponse

Response Lenses

gqarsAttributes :: Lens' GetQueueAttributesResponse (HashMap QueueAttributeName Text)

A map of attributes to the respective values.

gqarsResponseStatus :: Lens' GetQueueAttributesResponse Int

The response status code.