amazonka-sqs 0.0.1 → 0.0.2
raw patch · 19 files changed
+344/−375 lines, 19 filesdep ~amazonka-corePVP: major bump suggested
API removals or changes: PVP suggests a major version bump
Dependency ranges changed: amazonka-core
API changes (from Hackage documentation)
- Network.AWS.SQS.Types: ApproximateNumberOfMessages :: QueueAttributeName
- Network.AWS.SQS.Types: ApproximateNumberOfMessagesDelayed :: QueueAttributeName
- Network.AWS.SQS.Types: ApproximateNumberOfMessagesNotVisible :: QueueAttributeName
- Network.AWS.SQS.Types: CreatedTimestamp :: QueueAttributeName
- Network.AWS.SQS.Types: DelaySeconds :: QueueAttributeName
- Network.AWS.SQS.Types: LastModifiedTimestamp :: QueueAttributeName
- Network.AWS.SQS.Types: MaximumMessageSize :: QueueAttributeName
- Network.AWS.SQS.Types: MessageRetentionPeriod :: QueueAttributeName
- Network.AWS.SQS.Types: Policy :: QueueAttributeName
- Network.AWS.SQS.Types: QueueArn :: QueueAttributeName
- Network.AWS.SQS.Types: ReceiveMessageWaitTimeSeconds :: QueueAttributeName
- Network.AWS.SQS.Types: RedrivePolicy :: QueueAttributeName
- Network.AWS.SQS.Types: VisibilityTimeout :: QueueAttributeName
- Network.AWS.SQS.Types: data QueueAttributeName
- Network.AWS.SQS.Types: instance Constructor C1_0QueueAttributeName
- Network.AWS.SQS.Types: instance Constructor C1_10QueueAttributeName
- Network.AWS.SQS.Types: instance Constructor C1_11QueueAttributeName
- Network.AWS.SQS.Types: instance Constructor C1_12QueueAttributeName
- Network.AWS.SQS.Types: instance Constructor C1_1QueueAttributeName
- Network.AWS.SQS.Types: instance Constructor C1_2QueueAttributeName
- Network.AWS.SQS.Types: instance Constructor C1_3QueueAttributeName
- Network.AWS.SQS.Types: instance Constructor C1_4QueueAttributeName
- Network.AWS.SQS.Types: instance Constructor C1_5QueueAttributeName
- Network.AWS.SQS.Types: instance Constructor C1_6QueueAttributeName
- Network.AWS.SQS.Types: instance Constructor C1_7QueueAttributeName
- Network.AWS.SQS.Types: instance Constructor C1_8QueueAttributeName
- Network.AWS.SQS.Types: instance Constructor C1_9QueueAttributeName
- Network.AWS.SQS.Types: instance Datatype D1QueueAttributeName
- Network.AWS.SQS.Types: instance Enum QueueAttributeName
- Network.AWS.SQS.Types: instance Eq QueueAttributeName
- Network.AWS.SQS.Types: instance FromText QueueAttributeName
- Network.AWS.SQS.Types: instance FromXML QueueAttributeName
- Network.AWS.SQS.Types: instance Generic QueueAttributeName
- Network.AWS.SQS.Types: instance Hashable QueueAttributeName
- Network.AWS.SQS.Types: instance Ord QueueAttributeName
- Network.AWS.SQS.Types: instance Show QueueAttributeName
- Network.AWS.SQS.Types: instance ToByteString QueueAttributeName
- Network.AWS.SQS.Types: instance ToHeader QueueAttributeName
- Network.AWS.SQS.Types: instance ToQuery QueueAttributeName
- Network.AWS.SQS.Types: instance ToText QueueAttributeName
- Network.AWS.SQS.CreateQueue: cqAttributes :: Lens' CreateQueue (HashMap QueueAttributeName Text)
+ Network.AWS.SQS.CreateQueue: cqAttributes :: Lens' CreateQueue (HashMap Text Text)
- Network.AWS.SQS.GetQueueAttributes: gqaAttributeNames :: Lens' GetQueueAttributes [QueueAttributeName]
+ Network.AWS.SQS.GetQueueAttributes: gqaAttributeNames :: Lens' GetQueueAttributes [Text]
- Network.AWS.SQS.GetQueueAttributes: gqarAttributes :: Lens' GetQueueAttributesResponse (HashMap QueueAttributeName Text)
+ Network.AWS.SQS.GetQueueAttributes: gqarAttributes :: Lens' GetQueueAttributesResponse (HashMap Text Text)
- Network.AWS.SQS.ReceiveMessage: rmAttributeNames :: Lens' ReceiveMessage [QueueAttributeName]
+ Network.AWS.SQS.ReceiveMessage: rmAttributeNames :: Lens' ReceiveMessage [Text]
- Network.AWS.SQS.SetQueueAttributes: sqaAttributes :: Lens' SetQueueAttributes (HashMap QueueAttributeName Text)
+ Network.AWS.SQS.SetQueueAttributes: sqaAttributes :: Lens' SetQueueAttributes (HashMap Text Text)
- Network.AWS.SQS.Types: mAttributes :: Lens' Message (HashMap QueueAttributeName Text)
+ Network.AWS.SQS.Types: mAttributes :: Lens' Message (HashMap Text Text)
Files
- README.md +7/−1
- amazonka-sqs.cabal +8/−9
- gen/Network/AWS/SQS/AddPermission.hs +20/−20
- gen/Network/AWS/SQS/ChangeMessageVisibility.hs +18/−18
- gen/Network/AWS/SQS/ChangeMessageVisibilityBatch.hs +13/−12
- gen/Network/AWS/SQS/CreateQueue.hs +36/−34
- gen/Network/AWS/SQS/DeleteMessage.hs +8/−5
- gen/Network/AWS/SQS/DeleteMessageBatch.hs +12/−7
- gen/Network/AWS/SQS/DeleteQueue.hs +14/−10
- gen/Network/AWS/SQS/GetQueueAttributes.hs +24/−30
- gen/Network/AWS/SQS/GetQueueUrl.hs +5/−6
- gen/Network/AWS/SQS/ListDeadLetterSourceQueues.hs +3/−2
- gen/Network/AWS/SQS/ListQueues.hs +3/−3
- gen/Network/AWS/SQS/ReceiveMessage.hs +54/−42
- gen/Network/AWS/SQS/RemovePermission.hs +4/−4
- gen/Network/AWS/SQS/SendMessage.hs +29/−26
- gen/Network/AWS/SQS/SendMessageBatch.hs +24/−17
- gen/Network/AWS/SQS/SetQueueAttributes.hs +26/−28
- gen/Network/AWS/SQS/Types.hs +36/−101
README.md view
@@ -8,7 +8,13 @@ ## Description -Amazon Simple Queue Service (SQS) is a fast, reliable, scalable, fully managed message queuing service. SQS makes it simple and cost-effective to decouple the components of a cloud application. You can use SQS to transmit any volume of data, at any level of throughput, without losing messages or requiring other services to be always available. With SQS, you can offload the administrative burden of operating and scaling a highly available messaging cluster, while paying a low price for only what you use.+ Amazon Simple Queue Service (SQS) is a fast, reliable, scalable, fully+ managed message queuing service. SQS makes it simple and cost-effective to+ decouple the components of a cloud application. You can use SQS to transmit+ any volume of data, at any level of throughput, without losing messages or+ requiring other services to be always available. With SQS, you can offload+ the administrative burden of operating and scaling a highly available+ messaging cluster, while paying a low price for only what you use. Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-sqs) and [AWS API Reference](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/Welcome.html).
amazonka-sqs.cabal view
@@ -1,5 +1,5 @@ name: amazonka-sqs-version: 0.0.1+version: 0.0.2 synopsis: Amazon Simple Queue Service SDK. homepage: https://github.com/brendanhay/amazonka license: OtherLicense@@ -14,13 +14,12 @@ description: Amazon Simple Queue Service (SQS) is a fast, reliable, scalable, fully- managed message queuing service. SQS makes it simple and cost-effective- to decouple the components of a cloud application. You can use SQS to- transmit any volume of data, at any level of throughput, without losing- messages or requiring other services to be always available. With SQS,- you can offload the administrative burden of operating and scaling a- highly available messaging cluster, while paying a low price for only- what you use.+ managed message queuing service. SQS makes it simple and cost-effective to+ decouple the components of a cloud application. You can use SQS to transmit+ any volume of data, at any level of throughput, without losing messages or+ requiring other services to be always available. With SQS, you can offload+ the administrative burden of operating and scaling a highly available+ messaging cluster, while paying a low price for only what you use. . /See:/ <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/Welcome.html AWS API Reference> .@@ -60,5 +59,5 @@ other-modules: build-depends:- amazonka-core == 0.0.1.*+ amazonka-core == 0.0.2.* , base >= 4.7 && < 5
gen/Network/AWS/SQS/AddPermission.hs view
@@ -20,13 +20,17 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Adds a permission to a queue for a specific principal. This allows for--- sharing access to the queue. When you create a queue, you have full control--- access rights for the queue. Only you (as owner of the queue) can grant or--- deny permissions to the queue. For more information about these--- permissions, see Shared Queues in the Amazon SQS Developer Guide.--- &Attribute.1=this &Attribute.2=that.+-- | Adds a permission to a queue for a specific <http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P principal>. This allows for+-- sharing access to the queue. --+-- When you create a queue, you have full control access rights for the queue.+-- Only you (as owner of the queue) can grant or deny permissions to the queue.+-- For more information about these permissions, see <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html Shared Queues> in the /AmazonSQS Developer Guide/.+--+-- '&Attribute.1=this'+--+-- '&Attribute.2=that'+-- -- <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_AddPermission.html> module Network.AWS.SQS.AddPermission (@@ -80,28 +84,24 @@ , _apActions = mempty } --- | The AWS account number of the principal who will be given permission. The+-- | The AWS account number of the <http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P principal> who will be given permission. The -- principal must have an AWS account, but does not need to be signed up for--- Amazon SQS. For information about locating the AWS account--- identification, see Your AWS Identifiers in the Amazon SQS Developer--- Guide.+-- Amazon SQS. For information about locating the AWS account identification,+-- see <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AWSCredentials.html Your AWS Identifiers> in the /Amazon SQS Developer Guide/. apAWSAccountIds :: Lens' AddPermission [Text] apAWSAccountIds = lens _apAWSAccountIds (\s a -> s { _apAWSAccountIds = a }) . _List -- | The action the client wants to allow for the specified principal. The--- following are valid values: * | SendMessage | ReceiveMessage |--- DeleteMessage | ChangeMessageVisibility | GetQueueAttributes |--- GetQueueUrl. For more information about these actions, see Understanding--- Permissions in the Amazon SQS Developer Guide. Specifying SendMessage,--- DeleteMessage, or ChangeMessageVisibility for the ActionName.n also--- grants permissions for the corresponding batch versions of those actions:--- SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.+-- following are valid values: '* | SendMessage | ReceiveMessage | DeleteMessage| ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl'. For more+-- information about these actions, see <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html#PermissionTypes Understanding Permissions> in the /AmazonSQS Developer Guide/.+--+-- Specifying 'SendMessage', 'DeleteMessage', or 'ChangeMessageVisibility' for the 'ActionName.n' also grants permissions for the corresponding batch versions of those+-- actions: 'SendMessageBatch', 'DeleteMessageBatch', and 'ChangeMessageVisibilityBatch'. apActions :: Lens' AddPermission [Text] apActions = lens _apActions (\s a -> s { _apActions = a }) . _List --- | The unique identification of the permission you're setting (e.g.,--- AliceSendMessage). Constraints: Maximum 80 characters; alphanumeric--- characters, hyphens (-), and underscores (_) are allowed.+-- | The unique identification of the permission you're setting (e.g., 'AliceSendMessage'). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-),+-- and underscores (_) are allowed. apLabel :: Lens' AddPermission Text apLabel = lens _apLabel (\s a -> s { _apLabel = a })
gen/Network/AWS/SQS/ChangeMessageVisibility.hs view
@@ -24,23 +24,24 @@ -- value. The maximum allowed timeout value you can set the value to is 12 -- hours. This means you can't extend the timeout of a message in an existing -- queue to more than a total visibility timeout of 12 hours. (For more--- information visibility timeout, see Visibility Timeout in the Amazon SQS--- Developer Guide.) For example, let's say you have a message and its default--- message visibility timeout is 30 minutes. You could call--- ChangeMessageVisiblity with a value of two hours and the effective timeout--- would be two hours and 30 minutes. When that time comes near you could--- again extend the time out by calling ChangeMessageVisiblity, but this time--- the maximum allowed timeout would be 9 hours and 30 minutes. If you attempt--- to set the VisibilityTimeout to an amount more than the maximum time left,--- Amazon SQS returns an error. It will not automatically recalculate and--- increase the timeout to the maximum time remaining. Unlike with a queue,--- when you change the visibility timeout for a specific message, that timeout--- value is applied immediately but is not saved in memory for that message.--- If you don't delete a message after it is received, the visibility timeout--- for the message the next time it is received reverts to the original--- timeout value, not the value you set with the ChangeMessageVisibility--- action.+-- information visibility timeout, see <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html Visibility Timeout> in the /Amazon SQSDeveloper Guide/.) --+-- For example, let's say you have a message and its default message visibility+-- timeout is 30 minutes. You could call 'ChangeMessageVisiblity' with a value of+-- two hours and the effective timeout would be two hours and 30 minutes. When+-- that time comes near you could again extend the time out by calling+-- ChangeMessageVisiblity, but this time the maximum allowed timeout would be 9+-- hours and 30 minutes.+--+-- If you attempt to set the 'VisibilityTimeout' to an amount more than the+-- maximum time left, Amazon SQS returns an error. It will not automatically+-- recalculate and increase the timeout to the maximum time remaining. Unlike+-- with a queue, when you change the visibility timeout for a specific message,+-- that timeout value is applied immediately but is not saved in memory for that+-- message. If you don't delete a message after it is received, the visibility+-- timeout for the message the next time it is received reverts to the original+-- timeout value, not the value you set with the 'ChangeMessageVisibility' action.+-- -- <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ChangeMessageVisibility.html> module Network.AWS.SQS.ChangeMessageVisibility (@@ -95,8 +96,7 @@ cmvQueueUrl = lens _cmvQueueUrl (\s a -> s { _cmvQueueUrl = a }) -- | The receipt handle associated with the message whose visibility timeout--- should be changed. This parameter is returned by the ReceiveMessage--- action.+-- should be changed. This parameter is returned by the 'ReceiveMessage' action. cmvReceiptHandle :: Lens' ChangeMessageVisibility Text cmvReceiptHandle = lens _cmvReceiptHandle (\s a -> s { _cmvReceiptHandle = a })
gen/Network/AWS/SQS/ChangeMessageVisibilityBatch.hs view
@@ -20,15 +20,16 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Changes the visibility timeout of multiple messages. This is a batch--- version of ChangeMessageVisibility. The result of the action on each--- message is reported individually in the response. You can send up to 10--- ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch--- action. Because the batch request can result in a combination of successful--- and unsuccessful actions, you should check for batch errors even when the--- call returns an HTTP status code of 200. &Attribute.1=this--- &Attribute.2=that.+-- | Changes the visibility timeout of multiple messages. This is a batch version+-- of 'ChangeMessageVisibility'. The result of the action on each message is+-- reported individually in the response. You can send up to 10 'ChangeMessageVisibility' requests with each 'ChangeMessageVisibilityBatch' action. --+-- Because the batch request can result in a combination of successful and+-- unsuccessful actions, you should check for batch errors even when the call+-- returns an HTTP status code of 200. '&Attribute.1=this'+--+-- '&Attribute.2=that'+-- -- <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ChangeMessageVisibilityBatch.html> module Network.AWS.SQS.ChangeMessageVisibilityBatch (@@ -74,8 +75,8 @@ , _cmvbEntries = mempty } --- | A list of receipt handles of the messages for which the visibility--- timeout must be changed.+-- | A list of receipt handles of the messages for which the visibility timeout+-- must be changed. cmvbEntries :: Lens' ChangeMessageVisibilityBatch [ChangeMessageVisibilityBatchRequestEntry] cmvbEntries = lens _cmvbEntries (\s a -> s { _cmvbEntries = a }) . _List @@ -102,11 +103,11 @@ , _cmvbrFailed = mempty } --- | A list of BatchResultErrorEntry items.+-- | A list of 'BatchResultErrorEntry' items. cmvbrFailed :: Lens' ChangeMessageVisibilityBatchResponse [BatchResultErrorEntry] cmvbrFailed = lens _cmvbrFailed (\s a -> s { _cmvbrFailed = a }) . _List --- | A list of ChangeMessageVisibilityBatchResultEntry items.+-- | A list of 'ChangeMessageVisibilityBatchResultEntry' items. cmvbrSuccessful :: Lens' ChangeMessageVisibilityBatchResponse [ChangeMessageVisibilityBatchResultEntry] cmvbrSuccessful = lens _cmvbrSuccessful (\s a -> s { _cmvbrSuccessful = a }) . _List
gen/Network/AWS/SQS/CreateQueue.hs view
@@ -20,18 +20,22 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Creates a new queue, or returns the URL of an existing one. When you--- request CreateQueue, you provide a name for the queue. To successfully--- create a new queue, you must provide a name that is unique within the scope--- of your own queues. You may pass one or more attributes in the request. If--- you do not provide a value for any attribute, the queue will have the--- default value for that attribute. Permitted attributes are the same that--- can be set using SetQueueAttributes. If you provide the name of an existing--- queue, along with the exact names and values of all the queue's attributes,--- CreateQueue returns the queue URL for the existing queue. If the queue--- name, attribute names, or attribute values do not match an existing queue,--- CreateQueue returns an error. &Attribute.1=this &Attribute.2=that.+-- | Creates a new queue, or returns the URL of an existing one. When you request 'CreateQueue', you provide a name for the queue. To successfully create a new queue, you+-- must provide a name that is unique within the scope of your own queues. --+-- You may pass one or more attributes in the request. If you do not provide a+-- value for any attribute, the queue will have the default value for that+-- attribute. Permitted attributes are the same that can be set using 'SetQueueAttributes'.+--+-- If you provide the name of an existing queue, along with the exact names and+-- values of all the queue's attributes, 'CreateQueue' returns the queue URL for+-- the existing queue. If the queue name, attribute names, or attribute values+-- do not match an existing queue, 'CreateQueue' returns an error.+--+-- '&Attribute.1=this'+--+-- '&Attribute.2=that'+-- -- <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html> module Network.AWS.SQS.CreateQueue (@@ -57,7 +61,7 @@ import qualified GHC.Exts data CreateQueue = CreateQueue- { _cqAttributes :: EMap "Attribute" "Name" "Value" QueueAttributeName Text+ { _cqAttributes :: EMap "Attribute" "Name" "Value" Text Text , _cqQueueName :: Text } deriving (Eq, Show) @@ -65,7 +69,7 @@ -- -- The fields accessible through corresponding lenses are: ----- * 'cqAttributes' @::@ 'HashMap' 'QueueAttributeName' 'Text'+-- * 'cqAttributes' @::@ 'HashMap' 'Text' 'Text' -- -- * 'cqQueueName' @::@ 'Text' --@@ -76,28 +80,26 @@ , _cqAttributes = mempty } --- | A map of attributes with their corresponding values. The following lists--- the names, descriptions, and values of the special request parameters the--- CreateQueue action uses: DelaySeconds - The time in seconds that the--- delivery of all messages in the queue will be delayed. An integer from 0--- to 900 (15 minutes). The default for this attribute is 0 (zero).--- MaximumMessageSize - The limit of how many bytes a message can contain--- before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to--- 262144 bytes (256 KiB). The default for this attribute is 262144 (256--- KiB). MessageRetentionPeriod - The number of seconds Amazon SQS retains a--- message. Integer representing seconds, from 60 (1 minute) to 1209600 (14--- days). The default for this attribute is 345600 (4 days). Policy - The--- queue's policy. A valid form-url-encoded policy. For more information--- about policy structure, see Basic Policy Structure in the Amazon SQS--- Developer Guide. For more information about form-url-encoding, see--- http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.--- ReceiveMessageWaitTimeSeconds - The time for which a ReceiveMessage call+-- | A map of attributes with their corresponding values.+--+-- The following lists the names, descriptions, and values of the special+-- request parameters the 'CreateQueue' action uses:+--+-- 'DelaySeconds' - The time in seconds that the delivery of all messages in+-- the queue will be delayed. An integer from 0 to 900 (15 minutes). The default+-- for this attribute is 0 (zero). 'MaximumMessageSize' - The limit of how many+-- bytes a message can contain before Amazon SQS rejects it. An integer from+-- 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this+-- attribute is 262144 (256 KiB). 'MessageRetentionPeriod' - The number of+-- seconds Amazon SQS retains a message. Integer representing seconds, from 60+-- (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4+-- days). 'Policy' - The queue's policy. A valid form-url-encoded policy. For+-- more information about policy structure, see <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/BasicStructure.html Basic Policy Structure> in the /Amazon SQS Developer Guide/. For more information about form-url-encoding, see <http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1 http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1>. 'ReceiveMessageWaitTimeSeconds' - The time for which a 'ReceiveMessage' call -- will wait for a message to arrive. An integer from 0 to 20 (seconds). The--- default for this attribute is 0. VisibilityTimeout - The visibility--- timeout for the queue. An integer from 0 to 43200 (12 hours). The default--- for this attribute is 30. For more information about visibility timeout,--- see Visibility Timeout in the Amazon SQS Developer Guide.-cqAttributes :: Lens' CreateQueue (HashMap QueueAttributeName Text)+-- default for this attribute is 0. 'VisibilityTimeout' - The visibility timeout+-- for the queue. An integer from 0 to 43200 (12 hours). The default for this+-- attribute is 30. For more information about visibility timeout, see <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html Visibility Timeout> in the /Amazon SQS Developer Guide/.+cqAttributes :: Lens' CreateQueue (HashMap Text Text) cqAttributes = lens _cqAttributes (\s a -> s { _cqAttributes = a }) . _EMap -- | The name for the queue to be created.
gen/Network/AWS/SQS/DeleteMessage.hs view
@@ -21,17 +21,20 @@ -- Portability : non-portable (GHC extensions) -- | Deletes the specified message from the specified queue. You specify the--- message by using the message's receipt handle and not the message ID you--- received when you sent the message. Even if the message is locked by--- another reader due to the visibility timeout setting, it is still deleted--- from the queue. If you leave a message in the queue for longer than the--- queue's configured retention period, Amazon SQS automatically deletes it.+-- message by using the message's 'receipt handle' and not the 'message ID' you+-- received when you sent the message. Even if the message is locked by another+-- reader due to the visibility timeout setting, it is still deleted from the+-- queue. If you leave a message in the queue for longer than the queue's+-- configured retention period, Amazon SQS automatically deletes it.+-- -- It is possible you will receive a message even after you have deleted it. -- This might happen on rare occasions if one of the servers storing a copy of -- the message is unavailable when you request to delete the message. The copy -- remains on the server and might be returned to you again on a subsequent -- receive request. You should create your system to be idempotent so that -- receiving a particular message more than once is not a problem.+--+-- -- -- <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_DeleteMessage.html> module Network.AWS.SQS.DeleteMessage
gen/Network/AWS/SQS/DeleteMessageBatch.hs view
@@ -20,13 +20,18 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Deletes multiple messages. This is a batch version of DeleteMessage. The+-- | Deletes multiple messages. This is a batch version of 'DeleteMessage'. The -- result of the delete action on each message is reported individually in the--- response. Because the batch request can result in a combination of--- successful and unsuccessful actions, you should check for batch errors even--- when the call returns an HTTP status code of 200. &Attribute.1=this--- &Attribute.2=that.+-- response. --+-- Because the batch request can result in a combination of successful and+-- unsuccessful actions, you should check for batch errors even when the call+-- returns an HTTP status code of 200.+--+-- '&Attribute.1=this'+--+-- '&Attribute.2=that'+-- -- <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_DeleteMessageBatch.html> module Network.AWS.SQS.DeleteMessageBatch (@@ -99,11 +104,11 @@ , _dmbrFailed = mempty } --- | A list of BatchResultErrorEntry items.+-- | A list of 'BatchResultErrorEntry' items. dmbrFailed :: Lens' DeleteMessageBatchResponse [BatchResultErrorEntry] dmbrFailed = lens _dmbrFailed (\s a -> s { _dmbrFailed = a }) . _List --- | A list of DeleteMessageBatchResultEntry items.+-- | A list of 'DeleteMessageBatchResultEntry' items. dmbrSuccessful :: Lens' DeleteMessageBatchResponse [DeleteMessageBatchResultEntry] dmbrSuccessful = lens _dmbrSuccessful (\s a -> s { _dmbrSuccessful = a }) . _List
gen/Network/AWS/SQS/DeleteQueue.hs view
@@ -22,16 +22,20 @@ -- | Deletes the queue specified by the queue URL, regardless of whether the -- queue is empty. If the specified queue does not exist, Amazon SQS returns a--- successful response. Use DeleteQueue with care; once you delete your queue,--- any messages in the queue are no longer available. When you delete a queue,--- the deletion process takes up to 60 seconds. Requests you send involving--- that queue during the 60 seconds might succeed. For example, a SendMessage--- request might succeed, but after the 60 seconds, the queue and that message--- you sent no longer exist. Also, when you delete a queue, you must wait at--- least 60 seconds before creating a queue with the same name. We reserve the--- right to delete queues that have had no activity for more than 30 days. For--- more information, see How Amazon SQS Queues Work in the Amazon SQS--- Developer Guide.+-- successful response.+--+-- Use 'DeleteQueue' with care; once you delete your queue, any messages in the+-- queue are no longer available.+--+-- When you delete a queue, the deletion process takes up to 60 seconds.+-- Requests you send involving that queue during the 60 seconds might succeed.+-- For example, a 'SendMessage' request might succeed, but after the 60 seconds,+-- the queue and that message you sent no longer exist. Also, when you delete a+-- queue, you must wait at least 60 seconds before creating a queue with the+-- same name.+--+-- We reserve the right to delete queues that have had no activity for more+-- than 30 days. For more information, see <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSConcepts.html How Amazon SQS Queues Work> in the /Amazon SQS Developer Guide/. -- -- <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_DeleteQueue.html> module Network.AWS.SQS.DeleteQueue
gen/Network/AWS/SQS/GetQueueAttributes.hs view
@@ -21,31 +21,25 @@ -- Portability : non-portable (GHC extensions) -- | 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.--- &Attribute.1=this &Attribute.2=that.+-- supported: 'All' - returns all values. 'ApproximateNumberOfMessages' - returns+-- the approximate number of visible messages in a queue. For more information,+-- see <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html 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 <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html 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 <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html 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 <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html Using Amazon SQSDead Letter Queues> in the /Amazon SQS Developer Guide/. --+-- '&Attribute.1=this'+--+-- '&Attribute.2=that'+-- -- <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueAttributes.html> module Network.AWS.SQS.GetQueueAttributes (@@ -71,7 +65,7 @@ import qualified GHC.Exts data GetQueueAttributes = GetQueueAttributes- { _gqaAttributeNames :: List "AttributeName" QueueAttributeName+ { _gqaAttributeNames :: List "AttributeName" Text , _gqaQueueUrl :: Text } deriving (Eq, Show) @@ -79,7 +73,7 @@ -- -- The fields accessible through corresponding lenses are: ----- * 'gqaAttributeNames' @::@ ['QueueAttributeName']+-- * 'gqaAttributeNames' @::@ ['Text'] -- -- * 'gqaQueueUrl' @::@ 'Text' --@@ -91,7 +85,7 @@ } -- | A list of attributes to retrieve information for.-gqaAttributeNames :: Lens' GetQueueAttributes [QueueAttributeName]+gqaAttributeNames :: Lens' GetQueueAttributes [Text] gqaAttributeNames = lens _gqaAttributeNames (\s a -> s { _gqaAttributeNames = a }) . _List@@ -101,14 +95,14 @@ gqaQueueUrl = lens _gqaQueueUrl (\s a -> s { _gqaQueueUrl = a }) newtype GetQueueAttributesResponse = GetQueueAttributesResponse- { _gqarAttributes :: EMap "Attribute" "Name" "Value" QueueAttributeName Text+ { _gqarAttributes :: EMap "Attribute" "Name" "Value" Text Text } deriving (Eq, Show, Monoid, Semigroup) -- | 'GetQueueAttributesResponse' constructor. -- -- The fields accessible through corresponding lenses are: ----- * 'gqarAttributes' @::@ 'HashMap' 'QueueAttributeName' 'Text'+-- * 'gqarAttributes' @::@ 'HashMap' 'Text' 'Text' -- getQueueAttributesResponse :: GetQueueAttributesResponse getQueueAttributesResponse = GetQueueAttributesResponse@@ -116,7 +110,7 @@ } -- | A map of attributes to the respective values.-gqarAttributes :: Lens' GetQueueAttributesResponse (HashMap QueueAttributeName Text)+gqarAttributes :: Lens' GetQueueAttributesResponse (HashMap Text Text) gqarAttributes = lens _gqarAttributes (\s a -> s { _gqarAttributes = a }) . _EMap instance ToPath GetQueueAttributes where
gen/Network/AWS/SQS/GetQueueUrl.hs view
@@ -21,12 +21,11 @@ -- Portability : non-portable (GHC extensions) -- | Returns the URL of an existing queue. This action provides a simple way to--- retrieve the URL of an Amazon SQS queue. To access a queue that belongs to--- another AWS account, use the QueueOwnerAWSAccountId parameter to specify--- the account ID of the queue's owner. The queue's owner must grant you--- permission to access the queue. For more information about shared queue--- access, see AddPermission or go to Shared Queues in the Amazon SQS--- Developer Guide.+-- retrieve the URL of an Amazon SQS queue.+--+-- To access a queue that belongs to another AWS account, use the 'QueueOwnerAWSAccountId' parameter to specify the account ID of the queue's owner. The queue's owner+-- must grant you permission to access the queue. For more information about+-- shared queue access, see 'AddPermission' or go to <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html Shared Queues> in the /AmazonSQS Developer Guide/. -- -- <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueUrl.html> module Network.AWS.SQS.GetQueueUrl
gen/Network/AWS/SQS/ListDeadLetterSourceQueues.hs view
@@ -21,8 +21,9 @@ -- Portability : non-portable (GHC extensions) -- | Returns a list of your queues that have the RedrivePolicy queue attribute--- configured with a dead letter queue. For more information about using dead--- letter queues, see Using Amazon SQS Dead Letter Queues.+-- configured with a dead letter queue.+--+-- For more information about using dead letter queues, see <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html Using Amazon SQSDead Letter Queues>. -- -- <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ListDeadLetterSourceQueues.html> module Network.AWS.SQS.ListDeadLetterSourceQueues
gen/Network/AWS/SQS/ListQueues.hs view
@@ -21,7 +21,7 @@ -- Portability : non-portable (GHC extensions) -- | Returns a list of your queues. The maximum number of queues that can be--- returned is 1000. If you specify a value for the optional QueueNamePrefix+-- returned is 1000. If you specify a value for the optional 'QueueNamePrefix' -- parameter, only queues with a name beginning with the specified value are -- returned. --@@ -63,8 +63,8 @@ { _lqQueueNamePrefix = Nothing } --- | A string to use for filtering the list results. Only those queues whose--- name begins with the specified string are returned.+-- | A string to use for filtering the list results. Only those queues whose name+-- begins with the specified string are returned. lqQueueNamePrefix :: Lens' ListQueues (Maybe Text) lqQueueNamePrefix = lens _lqQueueNamePrefix (\s a -> s { _lqQueueNamePrefix = a })
gen/Network/AWS/SQS/ReceiveMessage.hs view
@@ -21,28 +21,39 @@ -- Portability : non-portable (GHC extensions) -- | Retrieves one or more messages, with a maximum limit of 10 messages, from--- the specified queue. Long poll support is enabled by using the--- WaitTimeSeconds parameter. For more information, see Amazon SQS Long Poll--- in the Amazon SQS Developer Guide. Short poll is the default behavior where--- a weighted random set of machines is sampled on a ReceiveMessage call. This--- means only the messages on the sampled machines are returned. If the number--- of messages in the queue is small (less than 1000), it is likely you will--- get fewer messages than you requested per ReceiveMessage call. If the--- number of messages in the queue is extremely small, you might not receive--- any messages in a particular ReceiveMessage response; in which case you--- should repeat the request. For each message returned, the response includes--- the following: Message body MD5 digest of the message body. For information--- about MD5, go to http://www.faqs.org/rfcs/rfc1321.html. Message ID you--- received when you sent the message to the queue. Receipt handle. Message--- attributes. MD5 digest of the message attributes. The receipt handle is the--- identifier you must provide when deleting the message. For more--- information, see Queue and Message Identifiers in the Amazon SQS Developer--- Guide. You can provide the VisibilityTimeout parameter in your request,--- which will be applied to the messages that Amazon SQS returns in the--- response. If you do not include the parameter, the overall visibility--- timeout for the queue is used for the returned messages. For more--- information, see Visibility Timeout in the Amazon SQS Developer Guide.+-- the specified queue. Long poll support is enabled by using the 'WaitTimeSeconds'+-- parameter. For more information, see <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html Amazon SQS Long Poll> in the /Amazon SQSDeveloper Guide/. --+-- Short poll is the default behavior where a weighted random set of machines+-- is sampled on a 'ReceiveMessage' call. This means only the messages on the+-- sampled machines are returned. If the number of messages in the queue is+-- small (less than 1000), it is likely you will get fewer messages than you+-- requested per 'ReceiveMessage' call. If the number of messages in the queue is+-- extremely small, you might not receive any messages in a particular 'ReceiveMessage' response; in which case you should repeat the request.+--+-- For each message returned, the response includes the following:+--+-- Message body+--+-- MD5 digest of the message body. For information about MD5, go to <http://www.faqs.org/rfcs/rfc1321.html http://www.faqs.org/rfcs/rfc1321.html>.+--+-- Message ID you received when you sent the message to the queue.+--+-- Receipt handle.+--+-- Message attributes.+--+-- MD5 digest of the message attributes.+--+-- The receipt handle is the identifier you must provide when deleting the+-- message. For more information, see <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html Queue and Message Identifiers> in the /Amazon SQS Developer Guide/.+--+-- You can provide the 'VisibilityTimeout' parameter in your request, which will+-- be applied to the messages that Amazon SQS returns in the response. If you do+-- not include the parameter, the overall visibility timeout for the queue is+-- used for the returned messages. For more information, see <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html Visibility Timeout>+-- in the /Amazon SQS Developer Guide/.+-- -- <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ReceiveMessage.html> module Network.AWS.SQS.ReceiveMessage (@@ -72,7 +83,7 @@ import qualified GHC.Exts data ReceiveMessage = ReceiveMessage- { _rmAttributeNames :: List "AttributeName" QueueAttributeName+ { _rmAttributeNames :: List "AttributeName" Text , _rmMaxNumberOfMessages :: Maybe Int , _rmMessageAttributeNames :: List "MessageAttributeName" Text , _rmQueueUrl :: Text@@ -84,7 +95,7 @@ -- -- The fields accessible through corresponding lenses are: ----- * 'rmAttributeNames' @::@ ['QueueAttributeName']+-- * 'rmAttributeNames' @::@ ['Text'] -- -- * 'rmMaxNumberOfMessages' @::@ 'Maybe' 'Int' --@@ -108,32 +119,33 @@ } -- | A list of attributes that need to be returned along with each message.+-- -- The following lists the names and descriptions of the attributes that can--- be returned: All - returns all values. ApproximateFirstReceiveTimestamp ---- returns the time when the message was first received (epoch time in--- milliseconds). ApproximateReceiveCount - returns the number of times a--- message has been received but not deleted. SenderId - returns the AWS--- account number (or the IP address, if anonymous access is allowed) of the--- sender. SentTimestamp - returns the time when the message was sent (epoch--- time in milliseconds).-rmAttributeNames :: Lens' ReceiveMessage [QueueAttributeName]+-- be returned:+--+-- 'All' - returns all values. 'ApproximateFirstReceiveTimestamp' - returns the+-- time when the message was first received (epoch time in milliseconds). 'ApproximateReceiveCount' - returns the number of times a message has been received but not deleted. 'SenderId' - returns the AWS account number (or the IP address, if anonymous access is+-- allowed) of the sender. 'SentTimestamp' - returns the time when the message+-- was sent (epoch time in milliseconds).+rmAttributeNames :: Lens' ReceiveMessage [Text] rmAttributeNames = lens _rmAttributeNames (\s a -> s { _rmAttributeNames = a }) . _List -- | The maximum number of messages to return. Amazon SQS never returns more--- messages than this value but may return fewer. Values can be from 1 to--- 10. Default is 1. All of the messages are not necessarily returned.+-- messages than this value but may return fewer. Values can be from 1 to 10.+-- Default is 1.+--+-- All of the messages are not necessarily returned. rmMaxNumberOfMessages :: Lens' ReceiveMessage (Maybe Int) rmMaxNumberOfMessages = lens _rmMaxNumberOfMessages (\s a -> s { _rmMaxNumberOfMessages = a }) --- | The message attribute Name can contain the following characters: A-Z,--- a-z, 0-9, underscore(_), hyphen(-), and period (.). The message attribute--- name must not start or end with a period, and it should not have--- successive periods. The message attribute name is case sensitive and must--- be unique among all attribute names for the message. The message--- attribute name can be up to 256 characters long. Attribute names cannot--- start with "AWS." or "Amazon." because these prefixes are reserved for--- use by Amazon Web Services.+-- | The message attribute Name can contain the following characters: A-Z, a-z,+-- 0-9, underscore(_), hyphen(-), and period (.). The message attribute name+-- must not start or end with a period, and it should not have successive+-- periods. The message attribute name is case sensitive and must be unique+-- among all attribute names for the message. The message attribute name can be+-- up to 256 characters long. Attribute names cannot start with "AWS." or+-- "Amazon." because these prefixes are reserved for use by Amazon Web Services. rmMessageAttributeNames :: Lens' ReceiveMessage [Text] rmMessageAttributeNames = lens _rmMessageAttributeNames (\s a -> s { _rmMessageAttributeNames = a })@@ -144,7 +156,7 @@ rmQueueUrl = lens _rmQueueUrl (\s a -> s { _rmQueueUrl = a }) -- | The duration (in seconds) that the received messages are hidden from--- subsequent retrieve requests after being retrieved by a ReceiveMessage+-- subsequent retrieve requests after being retrieved by a 'ReceiveMessage' -- request. rmVisibilityTimeout :: Lens' ReceiveMessage (Maybe Int) rmVisibilityTimeout =
gen/Network/AWS/SQS/RemovePermission.hs view
@@ -20,8 +20,8 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Revokes any permissions in the queue policy that matches the specified--- Label parameter. Only the owner of the queue can remove permissions.+-- | Revokes any permissions in the queue policy that matches the specified 'Label'+-- parameter. Only the owner of the queue can remove permissions. -- -- <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_RemovePermission.html> module Network.AWS.SQS.RemovePermission@@ -66,8 +66,8 @@ , _rpLabel = p2 } --- | The identification of the permission to remove. This is the label added--- with the AddPermission action.+-- | The identification of the permission to remove. This is the label added with+-- the 'AddPermission' action. rpLabel :: Lens' RemovePermission Text rpLabel = lens _rpLabel (\s a -> s { _rpLabel = a })
gen/Network/AWS/SQS/SendMessage.hs view
@@ -20,17 +20,21 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Delivers a message to the specified queue. With Amazon SQS, you now have--- the ability to send large payload messages that are up to 256KB (262,144--- bytes) in size. To send large payloads, you must use an AWS SDK that--- supports SigV4 signing. To verify whether SigV4 is supported for an AWS--- SDK, check the SDK release notes. The following list shows the characters--- (in Unicode) allowed in your message, according to the W3C XML--- specification. For more information, go to--- http://www.w3.org/TR/REC-xml/#charsets If you send any characters not--- included in the list, your request will be rejected. #x9 | #xA | #xD |--- [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF].+-- | Delivers a message to the specified queue. With Amazon SQS, you now have the+-- ability to send large payload messages that are up to 256KB (262,144 bytes)+-- in size. To send large payloads, you must use an AWS SDK that supports SigV4+-- signing. To verify whether SigV4 is supported for an AWS SDK, check the SDK+-- release notes. --+-- The following list shows the characters (in Unicode) allowed in your+-- message, according to the W3C XML specification. For more information, go to <http://www.w3.org/TR/REC-xml/#charsets http://www.w3.org/TR/REC-xml/#charsets> If you send any characters not included in the list, your request will be+-- rejected.+--+-- #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to+-- #x10FFFF]+--+--+-- -- <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html> module Network.AWS.SQS.SendMessage (@@ -88,15 +92,15 @@ , _smMessageAttributes = mempty } --- | The number of seconds (0 to 900 - 15 minutes) to delay a specific--- message. Messages with a positive DelaySeconds value become available for--- processing after the delay time is finished. If you don't specify a--- value, the default value for the queue applies.+-- | The number of seconds (0 to 900 - 15 minutes) to delay a specific message.+-- Messages with a positive 'DelaySeconds' value become available for processing+-- after the delay time is finished. If you don't specify a value, the default+-- value for the queue applies. smDelaySeconds :: Lens' SendMessage (Maybe Int) smDelaySeconds = lens _smDelaySeconds (\s a -> s { _smDelaySeconds = a }) -- | Each message attribute consists of a Name, Type, and Value. For more--- information, see Message Attribute Items.+-- information, see <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSMessageAttributes.html#SQSMessageAttributesNTV Message Attribute Items>. smMessageAttributes :: Lens' SendMessage (HashMap Text MessageAttributeValue) smMessageAttributes = lens _smMessageAttributes (\s a -> s { _smMessageAttributes = a })@@ -134,26 +138,25 @@ , _smrMessageId = Nothing } --- | An MD5 digest of the non-URL-encoded message attribute string. This can--- be used to verify that Amazon SQS received the message correctly. Amazon--- SQS first URL decodes the message before creating the MD5 digest. For--- information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.+-- | An MD5 digest of the non-URL-encoded message attribute string. This can be+-- used to verify that Amazon SQS received the message correctly. Amazon SQS+-- first URL decodes the message before creating the MD5 digest. For information+-- about MD5, go to <http://www.faqs.org/rfcs/rfc1321.html http://www.faqs.org/rfcs/rfc1321.html>. smrMD5OfMessageAttributes :: Lens' SendMessageResponse (Maybe Text) smrMD5OfMessageAttributes = lens _smrMD5OfMessageAttributes (\s a -> s { _smrMD5OfMessageAttributes = a }) --- | An MD5 digest of the non-URL-encoded message body string. This can be--- used to verify that Amazon SQS received the message correctly. Amazon SQS--- first URL decodes the message before creating the MD5 digest. For--- information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.+-- | An MD5 digest of the non-URL-encoded message body string. This can be used to+-- verify that Amazon SQS received the message correctly. Amazon SQS first URL+-- decodes the message before creating the MD5 digest. For information about+-- MD5, go to <http://www.faqs.org/rfcs/rfc1321.html http://www.faqs.org/rfcs/rfc1321.html>. smrMD5OfMessageBody :: Lens' SendMessageResponse (Maybe Text) smrMD5OfMessageBody = lens _smrMD5OfMessageBody (\s a -> s { _smrMD5OfMessageBody = a }) --- | An element containing the message ID of the message sent to the queue.--- For more information, see Queue and Message Identifiers in the Amazon SQS--- Developer Guide.+-- | An element containing the message ID of the message sent to the queue. For+-- more information, see <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html Queue and Message Identifiers> in the /Amazon SQSDeveloper Guide/. smrMessageId :: Lens' SendMessageResponse (Maybe Text) smrMessageId = lens _smrMessageId (\s a -> s { _smrMessageId = a })
gen/Network/AWS/SQS/SendMessageBatch.hs view
@@ -21,21 +21,28 @@ -- Portability : non-portable (GHC extensions) -- | Delivers up to ten messages to the specified queue. This is a batch version--- of SendMessage. The result of the send action on each message is reported--- individually in the response. The maximum allowed individual message size--- is 256 KB (262,144 bytes). The maximum total payload size (i.e., the sum of--- all a batch's individual message lengths) is also 256 KB (262,144 bytes).--- If the DelaySeconds parameter is not specified for an entry, the default--- for the queue is used. The following list shows the characters (in Unicode)--- that are allowed in your message, according to the W3C XML specification.--- For more information, go to http://www.faqs.org/rfcs/rfc1321.html. If you--- send any characters that are not included in the list, your request will be--- rejected. #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] |--- [#x10000 to #x10FFFF] Because the batch request can result in a combination--- of successful and unsuccessful actions, you should check for batch errors--- even when the call returns an HTTP status code of 200.--- &Attribute.1=this &Attribute.2=that.+-- of 'SendMessage'. The result of the send action on each message is reported+-- individually in the response. The maximum allowed individual message size is+-- 256 KB (262,144 bytes). --+-- The maximum total payload size (i.e., the sum of all a batch's individual+-- message lengths) is also 256 KB (262,144 bytes).+--+-- If the 'DelaySeconds' parameter is not specified for an entry, the default for+-- the queue is used.+--+-- The following list shows the characters (in Unicode) that are allowed in+-- your message, according to the W3C XML specification. For more information,+-- go to <http://www.faqs.org/rfcs/rfc1321.html http://www.faqs.org/rfcs/rfc1321.html>. If you send any characters that+-- are not included in the list, your request will be rejected. #x9 | #xA | #xD+-- | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]+--+-- Because the batch request can result in a combination of successful and+-- unsuccessful actions, you should check for batch errors even when the call+-- returns an HTTP status code of 200. '&Attribute.1=this'+--+-- '&Attribute.2=that'+-- -- <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessageBatch.html> module Network.AWS.SQS.SendMessageBatch (@@ -81,7 +88,7 @@ , _smbEntries = mempty } --- | A list of SendMessageBatchRequestEntry items.+-- | A list of 'SendMessageBatchRequestEntry' items. smbEntries :: Lens' SendMessageBatch [SendMessageBatchRequestEntry] smbEntries = lens _smbEntries (\s a -> s { _smbEntries = a }) . _List @@ -108,12 +115,12 @@ , _smbrFailed = mempty } --- | A list of BatchResultErrorEntry items with the error detail about each+-- | A list of 'BatchResultErrorEntry' items with the error detail about each -- message that could not be enqueued. smbrFailed :: Lens' SendMessageBatchResponse [BatchResultErrorEntry] smbrFailed = lens _smbrFailed (\s a -> s { _smbrFailed = a }) . _List --- | A list of SendMessageBatchResultEntry items.+-- | A list of 'SendMessageBatchResultEntry' items. smbrSuccessful :: Lens' SendMessageBatchResponse [SendMessageBatchResultEntry] smbrSuccessful = lens _smbrSuccessful (\s a -> s { _smbrSuccessful = a }) . _List
gen/Network/AWS/SQS/SetQueueAttributes.hs view
@@ -22,8 +22,7 @@ -- | Sets the value of one or more queue attributes. When you change a queue's -- attributes, the change can take up to 60 seconds for most of the attributes--- to propagate throughout the SQS system. Changes made to the--- MessageRetentionPeriod attribute can take up to 15 minutes.+-- to propagate throughout the SQS system. Changes made to the 'MessageRetentionPeriod' attribute can take up to 15 minutes. -- -- <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SetQueueAttributes.html> module Network.AWS.SQS.SetQueueAttributes@@ -48,7 +47,7 @@ import qualified GHC.Exts data SetQueueAttributes = SetQueueAttributes- { _sqaAttributes :: EMap "Attribute" "Name" "Value" QueueAttributeName Text+ { _sqaAttributes :: EMap "Attribute" "Name" "Value" Text Text , _sqaQueueUrl :: Text } deriving (Eq, Show) @@ -56,7 +55,7 @@ -- -- The fields accessible through corresponding lenses are: ----- * 'sqaAttributes' @::@ 'HashMap' 'QueueAttributeName' 'Text'+-- * 'sqaAttributes' @::@ 'HashMap' 'Text' 'Text' -- -- * 'sqaQueueUrl' @::@ 'Text' --@@ -67,31 +66,30 @@ , _sqaAttributes = mempty } --- | A map of attributes to set. The following lists the names, descriptions,--- and values of the special request parameters the SetQueueAttributes--- action uses: DelaySeconds - The time in seconds that the delivery of all--- messages in the queue will be delayed. An integer from 0 to 900 (15--- minutes). The default for this attribute is 0 (zero). MaximumMessageSize--- - The limit of how many bytes a message can contain before Amazon SQS--- rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256--- KiB). The default for this attribute is 262144 (256 KiB).--- MessageRetentionPeriod - The number of seconds Amazon SQS retains a--- message. Integer representing seconds, from 60 (1 minute) to 1209600 (14--- days). The default for this attribute is 345600 (4 days). Policy - The--- queue's policy. A valid form-url-encoded policy. For more information--- about policy structure, see Basic Policy Structure in the Amazon SQS--- Developer Guide. For more information about form-url-encoding, see--- http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1.--- ReceiveMessageWaitTimeSeconds - The time for which a ReceiveMessage call+-- | A map of attributes to set.+--+-- The following lists the names, descriptions, and values of the special+-- request parameters the 'SetQueueAttributes' action uses:+--+-- 'DelaySeconds' - The time in seconds that the delivery of all messages in+-- the queue will be delayed. An integer from 0 to 900 (15 minutes). The default+-- for this attribute is 0 (zero). 'MaximumMessageSize' - The limit of how many+-- bytes a message can contain before Amazon SQS rejects it. An integer from+-- 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this+-- attribute is 262144 (256 KiB). 'MessageRetentionPeriod' - The number of+-- seconds Amazon SQS retains a message. Integer representing seconds, from 60+-- (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4+-- days). 'Policy' - The queue's policy. A valid form-url-encoded policy. For+-- more information about policy structure, see <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/BasicStructure.html Basic Policy Structure> in the /Amazon SQS Developer Guide/. For more information about form-url-encoding, see <http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1 http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1>. 'ReceiveMessageWaitTimeSeconds' - The time for which a ReceiveMessage call -- will wait for a message to arrive. An integer from 0 to 20 (seconds). The--- default for this attribute is 0. VisibilityTimeout - The visibility--- timeout for the queue. An integer from 0 to 43200 (12 hours). The default--- for this attribute is 30. For more information about visibility timeout,--- see Visibility Timeout in the Amazon SQS Developer Guide. RedrivePolicy ---- 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.-sqaAttributes :: Lens' SetQueueAttributes (HashMap QueueAttributeName Text)+-- default for this attribute is 0. 'VisibilityTimeout' - The visibility timeout+-- for the queue. An integer from 0 to 43200 (12 hours). The default for this+-- attribute is 30. For more information about visibility timeout, see+-- Visibility Timeout in the /Amazon SQS Developer Guide/. 'RedrivePolicy' - 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/.+sqaAttributes :: Lens' SetQueueAttributes (HashMap Text Text) sqaAttributes = lens _sqaAttributes (\s a -> s { _sqaAttributes = a }) . _EMap -- | The URL of the Amazon SQS queue to take action on.
gen/Network/AWS/SQS/Types.hs view
@@ -29,9 +29,6 @@ -- ** XML , ns - -- * QueueAttributeName- , QueueAttributeName (..)- -- * DeleteMessageBatchRequestEntry , DeleteMessageBatchRequestEntry , deleteMessageBatchRequestEntry@@ -126,63 +123,6 @@ ns :: Text ns = "http://queue.amazonaws.com/doc/2012-11-05/" -data QueueAttributeName- = ApproximateNumberOfMessages -- ^ ApproximateNumberOfMessages- | ApproximateNumberOfMessagesDelayed -- ^ ApproximateNumberOfMessagesDelayed- | ApproximateNumberOfMessagesNotVisible -- ^ ApproximateNumberOfMessagesNotVisible- | CreatedTimestamp -- ^ CreatedTimestamp- | DelaySeconds -- ^ DelaySeconds- | LastModifiedTimestamp -- ^ LastModifiedTimestamp- | MaximumMessageSize -- ^ MaximumMessageSize- | MessageRetentionPeriod -- ^ MessageRetentionPeriod- | Policy -- ^ Policy- | QueueArn -- ^ QueueArn- | ReceiveMessageWaitTimeSeconds -- ^ ReceiveMessageWaitTimeSeconds- | RedrivePolicy -- ^ RedrivePolicy- | VisibilityTimeout -- ^ VisibilityTimeout- deriving (Eq, Ord, Show, Generic, Enum)--instance Hashable QueueAttributeName--instance FromText QueueAttributeName where- parser = match "ApproximateNumberOfMessages" ApproximateNumberOfMessages- <|> match "ApproximateNumberOfMessagesDelayed" ApproximateNumberOfMessagesDelayed- <|> match "ApproximateNumberOfMessagesNotVisible" ApproximateNumberOfMessagesNotVisible- <|> match "CreatedTimestamp" CreatedTimestamp- <|> match "DelaySeconds" DelaySeconds- <|> match "LastModifiedTimestamp" LastModifiedTimestamp- <|> match "MaximumMessageSize" MaximumMessageSize- <|> match "MessageRetentionPeriod" MessageRetentionPeriod- <|> match "Policy" Policy- <|> match "QueueArn" QueueArn- <|> match "ReceiveMessageWaitTimeSeconds" ReceiveMessageWaitTimeSeconds- <|> match "RedrivePolicy" RedrivePolicy- <|> match "VisibilityTimeout" VisibilityTimeout--instance ToText QueueAttributeName where- toText = \case- ApproximateNumberOfMessages -> "ApproximateNumberOfMessages"- ApproximateNumberOfMessagesDelayed -> "ApproximateNumberOfMessagesDelayed"- ApproximateNumberOfMessagesNotVisible -> "ApproximateNumberOfMessagesNotVisible"- CreatedTimestamp -> "CreatedTimestamp"- DelaySeconds -> "DelaySeconds"- LastModifiedTimestamp -> "LastModifiedTimestamp"- MaximumMessageSize -> "MaximumMessageSize"- MessageRetentionPeriod -> "MessageRetentionPeriod"- Policy -> "Policy"- QueueArn -> "QueueArn"- ReceiveMessageWaitTimeSeconds -> "ReceiveMessageWaitTimeSeconds"- RedrivePolicy -> "RedrivePolicy"- VisibilityTimeout -> "VisibilityTimeout"--instance ToByteString QueueAttributeName-instance ToHeader QueueAttributeName-instance ToQuery QueueAttributeName--instance FromXML QueueAttributeName where- parseXML = parseXMLText "QueueAttributeName"-- data DeleteMessageBatchRequestEntry = DeleteMessageBatchRequestEntry { _dmbreId :: Text , _dmbreReceiptHandle :: Text@@ -204,9 +144,9 @@ , _dmbreReceiptHandle = p2 } --- | An identifier for this particular receipt handle. This is used to--- communicate the result. Note that the Ids of a batch request need to be--- unique within the request.+-- | An identifier for this particular receipt handle. This is used to communicate+-- the result. Note that the 'Id's of a batch request need to be unique within the+-- request. dmbreId :: Lens' DeleteMessageBatchRequestEntry Text dmbreId = lens _dmbreId (\s a -> s { _dmbreId = a }) @@ -271,7 +211,7 @@ -- | Amazon SQS supports the following logical data types: String, Number, and -- Binary. In addition, you can append your own custom labels. For more--- information, see Message Attribute Data Types.+-- information, see <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSMessageAttributes.html#SQSMessageAttributes.DataTypes Message Attribute Data Types>. mavDataType :: Lens' MessageAttributeValue Text mavDataType = lens _mavDataType (\s a -> s { _mavDataType = a }) @@ -281,8 +221,7 @@ lens _mavStringListValues (\s a -> s { _mavStringListValues = a }) . _List --- | Strings are Unicode with UTF8 binary encoding. For a list of code values,--- see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.+-- | Strings are Unicode with UTF8 binary encoding. For a list of code values, see <http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters>. mavStringValue :: Lens' MessageAttributeValue (Maybe Text) mavStringValue = lens _mavStringValue (\s a -> s { _mavStringValue = a }) @@ -319,8 +258,7 @@ { _cmvbreId = p1 } --- | Represents a message whose visibility timeout has been changed--- successfully.+-- | Represents a message whose visibility timeout has been changed successfully. cmvbreId :: Lens' ChangeMessageVisibilityBatchResultEntry Text cmvbreId = lens _cmvbreId (\s a -> s { _cmvbreId = a }) @@ -358,9 +296,9 @@ , _cmvbre1VisibilityTimeout = Nothing } --- | An identifier for this particular receipt handle. This is used to--- communicate the result. Note that the Ids of a batch request need to be--- unique within the request.+-- | An identifier for this particular receipt handle. This is used to communicate+-- the result. Note that the 'Id's of a batch request need to be unique within the+-- request. cmvbre1Id :: Lens' ChangeMessageVisibilityBatchRequestEntry Text cmvbre1Id = lens _cmvbre1Id (\s a -> s { _cmvbre1Id = a }) @@ -418,7 +356,7 @@ ] data Message = Message- { _mAttributes :: EMap "Attribute" "Name" "Value" QueueAttributeName Text+ { _mAttributes :: EMap "Attribute" "Name" "Value" Text Text , _mBody :: Maybe Text , _mMD5OfBody :: Maybe Text , _mMD5OfMessageAttributes :: Maybe Text@@ -431,7 +369,7 @@ -- -- The fields accessible through corresponding lenses are: ----- * 'mAttributes' @::@ 'HashMap' 'QueueAttributeName' 'Text'+-- * 'mAttributes' @::@ 'HashMap' 'Text' 'Text' -- -- * 'mBody' @::@ 'Maybe' 'Text' --@@ -456,11 +394,9 @@ , _mMessageAttributes = mempty } --- | SenderId, SentTimestamp, ApproximateReceiveCount, and/or--- ApproximateFirstReceiveTimestamp. SentTimestamp and--- ApproximateFirstReceiveTimestamp are each returned as an integer--- representing the epoch time in milliseconds.-mAttributes :: Lens' Message (HashMap QueueAttributeName Text)+-- | 'SenderId', 'SentTimestamp', 'ApproximateReceiveCount', and/or 'ApproximateFirstReceiveTimestamp'. 'SentTimestamp' and 'ApproximateFirstReceiveTimestamp' are each returned as an+-- integer representing the <http://en.wikipedia.org/wiki/Unix_time epoch time> in milliseconds.+mAttributes :: Lens' Message (HashMap Text Text) mAttributes = lens _mAttributes (\s a -> s { _mAttributes = a }) . _EMap -- | The message's contents (not URL-encoded).@@ -471,30 +407,29 @@ mMD5OfBody :: Lens' Message (Maybe Text) mMD5OfBody = lens _mMD5OfBody (\s a -> s { _mMD5OfBody = a }) --- | An MD5 digest of the non-URL-encoded message attribute string. This can--- be used to verify that Amazon SQS received the message correctly. Amazon--- SQS first URL decodes the message before creating the MD5 digest. For--- information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.+-- | An MD5 digest of the non-URL-encoded message attribute string. This can be+-- used to verify that Amazon SQS received the message correctly. Amazon SQS+-- first URL decodes the message before creating the MD5 digest. For information+-- about MD5, go to <http://www.faqs.org/rfcs/rfc1321.html http://www.faqs.org/rfcs/rfc1321.html>. mMD5OfMessageAttributes :: Lens' Message (Maybe Text) mMD5OfMessageAttributes = lens _mMD5OfMessageAttributes (\s a -> s { _mMD5OfMessageAttributes = a }) -- | Each message attribute consists of a Name, Type, and Value. For more--- information, see Message Attribute Items.+-- information, see <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSMessageAttributes.html#SQSMessageAttributesNTV Message Attribute Items>. mMessageAttributes :: Lens' Message (HashMap Text MessageAttributeValue) mMessageAttributes = lens _mMessageAttributes (\s a -> s { _mMessageAttributes = a }) . _EMap --- | A unique identifier for the message. Message IDs are considered unique--- across all AWS accounts for an extended period of time.+-- | A unique identifier for the message. Message IDs are considered unique across+-- all AWS accounts for an extended period of time. mMessageId :: Lens' Message (Maybe Text) mMessageId = lens _mMessageId (\s a -> s { _mMessageId = a }) --- | An identifier associated with the act of receiving the message. A new--- receipt handle is returned every time you receive a message. When--- deleting a message, you provide the last received receipt handle to--- delete the message.+-- | An identifier associated with the act of receiving the message. A new receipt+-- handle is returned every time you receive a message. When deleting a message,+-- you provide the last received receipt handle to delete the message. mReceiptHandle :: Lens' Message (Maybe Text) mReceiptHandle = lens _mReceiptHandle (\s a -> s { _mReceiptHandle = a }) @@ -553,14 +488,14 @@ smbreDelaySeconds = lens _smbreDelaySeconds (\s a -> s { _smbreDelaySeconds = a }) --- | An identifier for the message in this batch. This is used to communicate--- the result. Note that the Ids of a batch request need to be unique within--- the request.+-- | An identifier for the message in this batch. This is used to communicate the+-- result. Note that the 'Id's of a batch request need to be unique within the+-- request. smbreId :: Lens' SendMessageBatchRequestEntry Text smbreId = lens _smbreId (\s a -> s { _smbreId = a }) -- | Each message attribute consists of a Name, Type, and Value. For more--- information, see Message Attribute Items.+-- information, see <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSMessageAttributes.html#SQSMessageAttributesNTV Message Attribute Items>. smbreMessageAttributes :: Lens' SendMessageBatchRequestEntry (HashMap Text MessageAttributeValue) smbreMessageAttributes = lens _smbreMessageAttributes (\s a -> s { _smbreMessageAttributes = a })@@ -619,19 +554,19 @@ smbre1Id :: Lens' SendMessageBatchResultEntry Text smbre1Id = lens _smbre1Id (\s a -> s { _smbre1Id = a }) --- | An MD5 digest of the non-URL-encoded message attribute string. This can--- be used to verify that Amazon SQS received the message batch correctly.--- Amazon SQS first URL decodes the message before creating the MD5 digest.--- For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.+-- | An MD5 digest of the non-URL-encoded message attribute string. This can be+-- used to verify that Amazon SQS received the message batch correctly. Amazon+-- SQS first URL decodes the message before creating the MD5 digest. For+-- information about MD5, go to <http://www.faqs.org/rfcs/rfc1321.html http://www.faqs.org/rfcs/rfc1321.html>. smbre1MD5OfMessageAttributes :: Lens' SendMessageBatchResultEntry (Maybe Text) smbre1MD5OfMessageAttributes = lens _smbre1MD5OfMessageAttributes (\s a -> s { _smbre1MD5OfMessageAttributes = a }) --- | An MD5 digest of the non-URL-encoded message body string. This can be--- used to verify that Amazon SQS received the message correctly. Amazon SQS--- first URL decodes the message before creating the MD5 digest. For--- information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.+-- | An MD5 digest of the non-URL-encoded message body string. This can be used to+-- verify that Amazon SQS received the message correctly. Amazon SQS first URL+-- decodes the message before creating the MD5 digest. For information about+-- MD5, go to <http://www.faqs.org/rfcs/rfc1321.html http://www.faqs.org/rfcs/rfc1321.html>. smbre1MD5OfMessageBody :: Lens' SendMessageBatchResultEntry Text smbre1MD5OfMessageBody = lens _smbre1MD5OfMessageBody (\s a -> s { _smbre1MD5OfMessageBody = a })