amazonka-sqs-0.2.2: gen/Network/AWS/SQS/SendMessageBatch.hs

{-# LANGUAGE DataKinds                   #-}
{-# LANGUAGE DeriveGeneric               #-}
{-# LANGUAGE FlexibleInstances           #-}
{-# LANGUAGE GeneralizedNewtypeDeriving  #-}
{-# LANGUAGE LambdaCase                  #-}
{-# LANGUAGE NoImplicitPrelude           #-}
{-# LANGUAGE OverloadedStrings           #-}
{-# LANGUAGE RecordWildCards             #-}
{-# LANGUAGE TypeFamilies                #-}

{-# OPTIONS_GHC -fno-warn-unused-imports #-}

-- Module      : Network.AWS.SQS.SendMessageBatch
-- Copyright   : (c) 2013-2014 Brendan Hay <brendan.g.hay@gmail.com>
-- License     : This Source Code Form is subject to the terms of
--               the Mozilla Public License, v. 2.0.
--               A copy of the MPL can be found in the LICENSE file or
--               you can obtain it at http://mozilla.org/MPL/2.0/.
-- Maintainer  : Brendan Hay <brendan.g.hay@gmail.com>
-- Stability   : experimental
-- Portability : non-portable (GHC extensions)
--
-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- | 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 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.  Some API actions take lists of
-- parameters. These lists are specified using the 'param.n' notation. Values of 'n'
-- are integers starting from 1. For example, a parameter list with two elements
-- looks like this:  '&Attribute.1=this'
--
-- '&Attribute.2=that'
--
-- <http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessageBatch.html>
module Network.AWS.SQS.SendMessageBatch
    (
    -- * Request
      SendMessageBatch
    -- ** Request constructor
    , sendMessageBatch
    -- ** Request lenses
    , smbEntries
    , smbQueueUrl

    -- * Response
    , SendMessageBatchResponse
    -- ** Response constructor
    , sendMessageBatchResponse
    -- ** Response lenses
    , smbrFailed
    , smbrSuccessful
    ) where

import Network.AWS.Prelude
import Network.AWS.Request.Query
import Network.AWS.SQS.Types
import qualified GHC.Exts

data SendMessageBatch = SendMessageBatch
    { _smbEntries  :: List "member" SendMessageBatchRequestEntry
    , _smbQueueUrl :: Text
    } deriving (Eq, Read, Show)

-- | 'SendMessageBatch' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'smbEntries' @::@ ['SendMessageBatchRequestEntry']
--
-- * 'smbQueueUrl' @::@ 'Text'
--
sendMessageBatch :: Text -- ^ 'smbQueueUrl'
                 -> SendMessageBatch
sendMessageBatch p1 = SendMessageBatch
    { _smbQueueUrl = p1
    , _smbEntries  = mempty
    }

-- | A list of 'SendMessageBatchRequestEntry' items.
smbEntries :: Lens' SendMessageBatch [SendMessageBatchRequestEntry]
smbEntries = lens _smbEntries (\s a -> s { _smbEntries = a }) . _List

-- | The URL of the Amazon SQS queue to take action on.
smbQueueUrl :: Lens' SendMessageBatch Text
smbQueueUrl = lens _smbQueueUrl (\s a -> s { _smbQueueUrl = a })

data SendMessageBatchResponse = SendMessageBatchResponse
    { _smbrFailed     :: List "member" BatchResultErrorEntry
    , _smbrSuccessful :: List "member" SendMessageBatchResultEntry
    } deriving (Eq, Read, Show)

-- | 'SendMessageBatchResponse' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'smbrFailed' @::@ ['BatchResultErrorEntry']
--
-- * 'smbrSuccessful' @::@ ['SendMessageBatchResultEntry']
--
sendMessageBatchResponse :: SendMessageBatchResponse
sendMessageBatchResponse = SendMessageBatchResponse
    { _smbrSuccessful = mempty
    , _smbrFailed     = mempty
    }

-- | 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.
smbrSuccessful :: Lens' SendMessageBatchResponse [SendMessageBatchResultEntry]
smbrSuccessful = lens _smbrSuccessful (\s a -> s { _smbrSuccessful = a }) . _List

instance ToPath SendMessageBatch where
    toPath = const "/"

instance ToQuery SendMessageBatch where
    toQuery SendMessageBatch{..} = mconcat
        [ toQuery   _smbEntries
        , "QueueUrl" =? _smbQueueUrl
        ]

instance ToHeaders SendMessageBatch

instance AWSRequest SendMessageBatch where
    type Sv SendMessageBatch = SQS
    type Rs SendMessageBatch = SendMessageBatchResponse

    request  = post "SendMessageBatch"
    response = xmlResponse

instance FromXML SendMessageBatchResponse where
    parseXML = withElement "SendMessageBatchResult" $ \x -> SendMessageBatchResponse
        <$> parseXML x
        <*> parseXML x