Network.AWS.SQS.GetQueueAttributes

Gets attributes for the specified queue.

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 - 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 Simple Queue Service 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 aren't deleted. For more information, see Resources Required to Process Messages in the Amazon Simple Queue Service 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 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 the ReceiveMessage action waits for a message to arrive. * RedrivePolicy - Returns the string that includes 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 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 of maxReceiveCount is exceeded. * maxReceiveCount - The number of times a message is delivered to the source queue before being moved 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 whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide . * 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 .
• gqaQueueURL - The URL of the Amazon SQS queue whose attribute information is retrieved. Queue URLs are case-sensitive.

data GetQueueAttributes

See: getQueueAttributes smart constructor.

Instances

Eq GetQueueAttributes

Defined in Network.AWS.SQS.GetQueueAttributes

Methods

(==) :: GetQueueAttributes -> GetQueueAttributes -> Bool

(/=) :: GetQueueAttributes -> GetQueueAttributes -> Bool

Data GetQueueAttributes

Defined in Network.AWS.SQS.GetQueueAttributes

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

Defined in Network.AWS.SQS.GetQueueAttributes

Methods

readsPrec :: Int -> ReadS GetQueueAttributes

readList :: ReadS [GetQueueAttributes]

readPrec :: ReadPrec GetQueueAttributes

readListPrec :: ReadPrec [GetQueueAttributes]

Show GetQueueAttributes

Defined in Network.AWS.SQS.GetQueueAttributes

Methods

showsPrec :: Int -> GetQueueAttributes -> ShowS

show :: GetQueueAttributes -> String

showList :: [GetQueueAttributes] -> ShowS

Generic GetQueueAttributes

Defined in Network.AWS.SQS.GetQueueAttributes

Associated Types

type Rep GetQueueAttributes :: Type -> Type

Methods

from :: GetQueueAttributes -> Rep GetQueueAttributes x

to :: Rep GetQueueAttributes x -> GetQueueAttributes

Hashable GetQueueAttributes

Defined in Network.AWS.SQS.GetQueueAttributes

Methods

hashWithSalt :: Int -> GetQueueAttributes -> Int

hash :: GetQueueAttributes -> Int

AWSRequest GetQueueAttributes

Defined in Network.AWS.SQS.GetQueueAttributes

Associated Types

type Rs GetQueueAttributes :: Type

Methods

request :: GetQueueAttributes -> Request GetQueueAttributes

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetQueueAttributes -> ClientResponse -> m (Response GetQueueAttributes)

ToHeaders GetQueueAttributes

Defined in Network.AWS.SQS.GetQueueAttributes

Methods

toHeaders :: GetQueueAttributes -> [Header]

ToPath GetQueueAttributes

Defined in Network.AWS.SQS.GetQueueAttributes

Methods

toPath :: GetQueueAttributes -> ByteString

ToQuery GetQueueAttributes

Defined in Network.AWS.SQS.GetQueueAttributes

Methods

toQuery :: GetQueueAttributes -> QueryString

NFData GetQueueAttributes

Defined in Network.AWS.SQS.GetQueueAttributes

Methods

rnf :: GetQueueAttributes -> ()

type Rep GetQueueAttributes

Defined in Network.AWS.SQS.GetQueueAttributes

type Rep GetQueueAttributes = D1 (MetaData "GetQueueAttributes" "Network.AWS.SQS.GetQueueAttributes" "amazonka-sqs-1.6.1-4KwGv5jRSGR2noZdqwtyOA" False) (C1 (MetaCons "GetQueueAttributes'" PrefixI True) (S1 (MetaSel (Just "_gqaAttributeNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [QueueAttributeName])) :*: S1 (MetaSel (Just "_gqaQueueURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

type Rs GetQueueAttributes

Defined in Network.AWS.SQS.GetQueueAttributes

type Rs GetQueueAttributes = GetQueueAttributesResponse

Request Lenses

gqaAttributeNames :: Lens' GetQueueAttributes [QueueAttributeName]

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 Simple Queue Service 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 aren't deleted. For more information, see Resources Required to Process Messages in the Amazon Simple Queue Service 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 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 the ReceiveMessage action waits for a message to arrive. * RedrivePolicy - Returns the string that includes 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 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 of maxReceiveCount is exceeded. * maxReceiveCount - The number of times a message is delivered to the source queue before being moved 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 whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide . * 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 .

gqaQueueURL :: Lens' GetQueueAttributes Text

The URL of the Amazon SQS queue whose attribute information is retrieved. Queue URLs are case-sensitive.

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 - A map of attributes to their respective values.
• gqarsResponseStatus - -- | The response status code.

data GetQueueAttributesResponse

A list of returned queue attributes.

See: getQueueAttributesResponse smart constructor.

Instances

Eq GetQueueAttributesResponse

Defined in Network.AWS.SQS.GetQueueAttributes

Methods

(==) :: GetQueueAttributesResponse -> GetQueueAttributesResponse -> Bool

(/=) :: GetQueueAttributesResponse -> GetQueueAttributesResponse -> Bool

Data GetQueueAttributesResponse

Defined in Network.AWS.SQS.GetQueueAttributes

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

Defined in Network.AWS.SQS.GetQueueAttributes

Methods

readsPrec :: Int -> ReadS GetQueueAttributesResponse

readList :: ReadS [GetQueueAttributesResponse]

readPrec :: ReadPrec GetQueueAttributesResponse

readListPrec :: ReadPrec [GetQueueAttributesResponse]

Show GetQueueAttributesResponse

Defined in Network.AWS.SQS.GetQueueAttributes

Methods

showsPrec :: Int -> GetQueueAttributesResponse -> ShowS

show :: GetQueueAttributesResponse -> String

showList :: [GetQueueAttributesResponse] -> ShowS

Generic GetQueueAttributesResponse

Defined in Network.AWS.SQS.GetQueueAttributes

Associated Types

type Rep GetQueueAttributesResponse :: Type -> Type

Methods

from :: GetQueueAttributesResponse -> Rep GetQueueAttributesResponse x

to :: Rep GetQueueAttributesResponse x -> GetQueueAttributesResponse

NFData GetQueueAttributesResponse

Defined in Network.AWS.SQS.GetQueueAttributes

Methods

rnf :: GetQueueAttributesResponse -> ()

type Rep GetQueueAttributesResponse

Defined in Network.AWS.SQS.GetQueueAttributes

type Rep GetQueueAttributesResponse = D1 (MetaData "GetQueueAttributesResponse" "Network.AWS.SQS.GetQueueAttributes" "amazonka-sqs-1.6.1-4KwGv5jRSGR2noZdqwtyOA" False) (C1 (MetaCons "GetQueueAttributesResponse'" PrefixI True) (S1 (MetaSel (Just "_gqarsAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map QueueAttributeName Text))) :*: S1 (MetaSel (Just "_gqarsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

gqarsAttributes :: Lens' GetQueueAttributesResponse (HashMap QueueAttributeName Text)

A map of attributes to their respective values.

gqarsResponseStatus :: Lens' GetQueueAttributesResponse Int

• - | The response status code.