amazonka-sqs-1.4.5: Amazon Simple Queue Service SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.SQS.GetQueueAttributes

Contents

Description

Gets attributes for the specified queue.

&amp;Attribute.1=this
&amp;Attribute.2=that

Synopsis

Creating a Request

getQueueAttributes Source #

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.

Instances

Eq GetQueueAttributes Source # 
Data GetQueueAttributes Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetQueueAttributes -> c GetQueueAttributes #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetQueueAttributes #

toConstr :: GetQueueAttributes -> Constr #

dataTypeOf :: GetQueueAttributes -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetQueueAttributes) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetQueueAttributes) #

gmapT :: (forall b. Data b => b -> b) -> GetQueueAttributes -> GetQueueAttributes #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetQueueAttributes -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetQueueAttributes -> r #

gmapQ :: (forall d. Data d => d -> u) -> GetQueueAttributes -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetQueueAttributes -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetQueueAttributes -> m GetQueueAttributes #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetQueueAttributes -> m GetQueueAttributes #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetQueueAttributes -> m GetQueueAttributes #

Read GetQueueAttributes Source # 
Show GetQueueAttributes Source # 
Generic GetQueueAttributes Source # 
Hashable GetQueueAttributes Source # 
NFData GetQueueAttributes Source # 

Methods

rnf :: GetQueueAttributes -> () #

AWSRequest GetQueueAttributes Source # 
ToPath GetQueueAttributes Source # 
ToHeaders GetQueueAttributes Source # 
ToQuery GetQueueAttributes Source # 
type Rep GetQueueAttributes Source # 
type Rep GetQueueAttributes = D1 (MetaData "GetQueueAttributes" "Network.AWS.SQS.GetQueueAttributes" "amazonka-sqs-1.4.5-4rQHB5Mk9mo8cQvbOgAp4I" False) (C1 (MetaCons "GetQueueAttributes'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gqaAttributeNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [QueueAttributeName]))) (S1 (MetaSel (Just Symbol "_gqaQueueURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs GetQueueAttributes Source # 

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:

data GetQueueAttributesResponse Source #

A list of returned queue attributes.

See: getQueueAttributesResponse smart constructor.

Instances

Eq GetQueueAttributesResponse Source # 
Data GetQueueAttributesResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetQueueAttributesResponse -> c GetQueueAttributesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetQueueAttributesResponse #

toConstr :: GetQueueAttributesResponse -> Constr #

dataTypeOf :: GetQueueAttributesResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetQueueAttributesResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetQueueAttributesResponse) #

gmapT :: (forall b. Data b => b -> b) -> GetQueueAttributesResponse -> GetQueueAttributesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetQueueAttributesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetQueueAttributesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> GetQueueAttributesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetQueueAttributesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetQueueAttributesResponse -> m GetQueueAttributesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetQueueAttributesResponse -> m GetQueueAttributesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetQueueAttributesResponse -> m GetQueueAttributesResponse #

Read GetQueueAttributesResponse Source # 
Show GetQueueAttributesResponse Source # 
Generic GetQueueAttributesResponse Source # 
NFData GetQueueAttributesResponse Source # 
type Rep GetQueueAttributesResponse Source # 
type Rep GetQueueAttributesResponse = D1 (MetaData "GetQueueAttributesResponse" "Network.AWS.SQS.GetQueueAttributes" "amazonka-sqs-1.4.5-4rQHB5Mk9mo8cQvbOgAp4I" False) (C1 (MetaCons "GetQueueAttributesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gqarsAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map QueueAttributeName Text)))) (S1 (MetaSel (Just Symbol "_gqarsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

gqarsAttributes :: Lens' GetQueueAttributesResponse (HashMap QueueAttributeName Text) Source #

A map of attributes to the respective values.