{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.SQS.SendMessageBatch
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Delivers up to ten messages to the specified queue. This is a batch
-- version of @ @@SendMessage@@.@ For a FIFO queue, multiple messages
-- within a single batch are enqueued in the order they are sent.
--
-- The result of sending 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@.
--
-- The maximum allowed individual message size and the maximum total
-- payload size (the sum of the individual lengths of all of the batched
-- messages) are both 256 KB (262,144 bytes).
--
-- A message can include only XML, JSON, and unformatted text. The
-- following Unicode characters are allowed:
--
-- @#x9@ | @#xA@ | @#xD@ | @#x20@ to @#xD7FF@ | @#xE000@ to @#xFFFD@ |
-- @#x10000@ to @#x10FFFF@
--
-- Any characters not included in this list will be rejected. For more
-- information, see the
-- <http://www.w3.org/TR/REC-xml/#charsets W3C specification for characters>.
--
-- If you don\'t specify the @DelaySeconds@ parameter for an entry, Amazon
-- SQS uses the default value for the queue.
--
-- Some 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:
--
-- @&AttributeName.1=first@
--
-- @&AttributeName.2=second@
module Amazonka.SQS.SendMessageBatch
  ( -- * Creating a Request
    SendMessageBatch (..),
    newSendMessageBatch,

    -- * Request Lenses
    sendMessageBatch_queueUrl,
    sendMessageBatch_entries,

    -- * Destructuring the Response
    SendMessageBatchResponse (..),
    newSendMessageBatchResponse,

    -- * Response Lenses
    sendMessageBatchResponse_httpStatus,
    sendMessageBatchResponse_successful,
    sendMessageBatchResponse_failed,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.SQS.Types

-- |
--
-- /See:/ 'newSendMessageBatch' smart constructor.
data SendMessageBatch = SendMessageBatch'
  { -- | The URL of the Amazon SQS queue to which batched messages are sent.
    --
    -- Queue URLs and names are case-sensitive.
    SendMessageBatch -> Text
queueUrl :: Prelude.Text,
    -- | A list of @ @@SendMessageBatchRequestEntry@@ @ items.
    SendMessageBatch -> [SendMessageBatchRequestEntry]
entries :: [SendMessageBatchRequestEntry]
  }
  deriving (SendMessageBatch -> SendMessageBatch -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SendMessageBatch -> SendMessageBatch -> Bool
$c/= :: SendMessageBatch -> SendMessageBatch -> Bool
== :: SendMessageBatch -> SendMessageBatch -> Bool
$c== :: SendMessageBatch -> SendMessageBatch -> Bool
Prelude.Eq, ReadPrec [SendMessageBatch]
ReadPrec SendMessageBatch
Int -> ReadS SendMessageBatch
ReadS [SendMessageBatch]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SendMessageBatch]
$creadListPrec :: ReadPrec [SendMessageBatch]
readPrec :: ReadPrec SendMessageBatch
$creadPrec :: ReadPrec SendMessageBatch
readList :: ReadS [SendMessageBatch]
$creadList :: ReadS [SendMessageBatch]
readsPrec :: Int -> ReadS SendMessageBatch
$creadsPrec :: Int -> ReadS SendMessageBatch
Prelude.Read, Int -> SendMessageBatch -> ShowS
[SendMessageBatch] -> ShowS
SendMessageBatch -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SendMessageBatch] -> ShowS
$cshowList :: [SendMessageBatch] -> ShowS
show :: SendMessageBatch -> String
$cshow :: SendMessageBatch -> String
showsPrec :: Int -> SendMessageBatch -> ShowS
$cshowsPrec :: Int -> SendMessageBatch -> ShowS
Prelude.Show, forall x. Rep SendMessageBatch x -> SendMessageBatch
forall x. SendMessageBatch -> Rep SendMessageBatch x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep SendMessageBatch x -> SendMessageBatch
$cfrom :: forall x. SendMessageBatch -> Rep SendMessageBatch x
Prelude.Generic)

-- |
-- Create a value of 'SendMessageBatch' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'queueUrl', 'sendMessageBatch_queueUrl' - The URL of the Amazon SQS queue to which batched messages are sent.
--
-- Queue URLs and names are case-sensitive.
--
-- 'entries', 'sendMessageBatch_entries' - A list of @ @@SendMessageBatchRequestEntry@@ @ items.
newSendMessageBatch ::
  -- | 'queueUrl'
  Prelude.Text ->
  SendMessageBatch
newSendMessageBatch :: Text -> SendMessageBatch
newSendMessageBatch Text
pQueueUrl_ =
  SendMessageBatch'
    { $sel:queueUrl:SendMessageBatch' :: Text
queueUrl = Text
pQueueUrl_,
      $sel:entries:SendMessageBatch' :: [SendMessageBatchRequestEntry]
entries = forall a. Monoid a => a
Prelude.mempty
    }

-- | The URL of the Amazon SQS queue to which batched messages are sent.
--
-- Queue URLs and names are case-sensitive.
sendMessageBatch_queueUrl :: Lens.Lens' SendMessageBatch Prelude.Text
sendMessageBatch_queueUrl :: Lens' SendMessageBatch Text
sendMessageBatch_queueUrl = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SendMessageBatch' {Text
queueUrl :: Text
$sel:queueUrl:SendMessageBatch' :: SendMessageBatch -> Text
queueUrl} -> Text
queueUrl) (\s :: SendMessageBatch
s@SendMessageBatch' {} Text
a -> SendMessageBatch
s {$sel:queueUrl:SendMessageBatch' :: Text
queueUrl = Text
a} :: SendMessageBatch)

-- | A list of @ @@SendMessageBatchRequestEntry@@ @ items.
sendMessageBatch_entries :: Lens.Lens' SendMessageBatch [SendMessageBatchRequestEntry]
sendMessageBatch_entries :: Lens' SendMessageBatch [SendMessageBatchRequestEntry]
sendMessageBatch_entries = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SendMessageBatch' {[SendMessageBatchRequestEntry]
entries :: [SendMessageBatchRequestEntry]
$sel:entries:SendMessageBatch' :: SendMessageBatch -> [SendMessageBatchRequestEntry]
entries} -> [SendMessageBatchRequestEntry]
entries) (\s :: SendMessageBatch
s@SendMessageBatch' {} [SendMessageBatchRequestEntry]
a -> SendMessageBatch
s {$sel:entries:SendMessageBatch' :: [SendMessageBatchRequestEntry]
entries = [SendMessageBatchRequestEntry]
a} :: SendMessageBatch) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Core.AWSRequest SendMessageBatch where
  type
    AWSResponse SendMessageBatch =
      SendMessageBatchResponse
  request :: (Service -> Service)
-> SendMessageBatch -> Request SendMessageBatch
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.postQuery (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy SendMessageBatch
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse SendMessageBatch)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
Text
-> (Int
    -> ResponseHeaders -> [Node] -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveXMLWrapper
      Text
"SendMessageBatchResult"
      ( \Int
s ResponseHeaders
h [Node]
x ->
          Int
-> [SendMessageBatchResultEntry]
-> [BatchResultErrorEntry]
-> SendMessageBatchResponse
SendMessageBatchResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall a. FromXML a => Text -> [Node] -> Either String [a]
Data.parseXMLList Text
"SendMessageBatchResultEntry" [Node]
x)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall a. FromXML a => Text -> [Node] -> Either String [a]
Data.parseXMLList Text
"BatchResultErrorEntry" [Node]
x)
      )

instance Prelude.Hashable SendMessageBatch where
  hashWithSalt :: Int -> SendMessageBatch -> Int
hashWithSalt Int
_salt SendMessageBatch' {[SendMessageBatchRequestEntry]
Text
entries :: [SendMessageBatchRequestEntry]
queueUrl :: Text
$sel:entries:SendMessageBatch' :: SendMessageBatch -> [SendMessageBatchRequestEntry]
$sel:queueUrl:SendMessageBatch' :: SendMessageBatch -> Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
queueUrl
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` [SendMessageBatchRequestEntry]
entries

instance Prelude.NFData SendMessageBatch where
  rnf :: SendMessageBatch -> ()
rnf SendMessageBatch' {[SendMessageBatchRequestEntry]
Text
entries :: [SendMessageBatchRequestEntry]
queueUrl :: Text
$sel:entries:SendMessageBatch' :: SendMessageBatch -> [SendMessageBatchRequestEntry]
$sel:queueUrl:SendMessageBatch' :: SendMessageBatch -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
queueUrl
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf [SendMessageBatchRequestEntry]
entries

instance Data.ToHeaders SendMessageBatch where
  toHeaders :: SendMessageBatch -> ResponseHeaders
toHeaders = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

instance Data.ToPath SendMessageBatch where
  toPath :: SendMessageBatch -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery SendMessageBatch where
  toQuery :: SendMessageBatch -> QueryString
toQuery SendMessageBatch' {[SendMessageBatchRequestEntry]
Text
entries :: [SendMessageBatchRequestEntry]
queueUrl :: Text
$sel:entries:SendMessageBatch' :: SendMessageBatch -> [SendMessageBatchRequestEntry]
$sel:queueUrl:SendMessageBatch' :: SendMessageBatch -> Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"Action"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: (ByteString
"SendMessageBatch" :: Prelude.ByteString),
        ByteString
"Version"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: (ByteString
"2012-11-05" :: Prelude.ByteString),
        ByteString
"QueueUrl" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Text
queueUrl,
        forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Data.toQueryList
          ByteString
"SendMessageBatchRequestEntry"
          [SendMessageBatchRequestEntry]
entries
      ]

-- | For each message in the batch, the response contains a
-- @ @@SendMessageBatchResultEntry@@ @ tag if the message succeeds or a
-- @ @@BatchResultErrorEntry@@ @ tag if the message fails.
--
-- /See:/ 'newSendMessageBatchResponse' smart constructor.
data SendMessageBatchResponse = SendMessageBatchResponse'
  { -- | The response's http status code.
    SendMessageBatchResponse -> Int
httpStatus :: Prelude.Int,
    -- | A list of @ @@SendMessageBatchResultEntry@@ @ items.
    SendMessageBatchResponse -> [SendMessageBatchResultEntry]
successful :: [SendMessageBatchResultEntry],
    -- | A list of @ @@BatchResultErrorEntry@@ @ items with error details about
    -- each message that can\'t be enqueued.
    SendMessageBatchResponse -> [BatchResultErrorEntry]
failed :: [BatchResultErrorEntry]
  }
  deriving (SendMessageBatchResponse -> SendMessageBatchResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SendMessageBatchResponse -> SendMessageBatchResponse -> Bool
$c/= :: SendMessageBatchResponse -> SendMessageBatchResponse -> Bool
== :: SendMessageBatchResponse -> SendMessageBatchResponse -> Bool
$c== :: SendMessageBatchResponse -> SendMessageBatchResponse -> Bool
Prelude.Eq, ReadPrec [SendMessageBatchResponse]
ReadPrec SendMessageBatchResponse
Int -> ReadS SendMessageBatchResponse
ReadS [SendMessageBatchResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SendMessageBatchResponse]
$creadListPrec :: ReadPrec [SendMessageBatchResponse]
readPrec :: ReadPrec SendMessageBatchResponse
$creadPrec :: ReadPrec SendMessageBatchResponse
readList :: ReadS [SendMessageBatchResponse]
$creadList :: ReadS [SendMessageBatchResponse]
readsPrec :: Int -> ReadS SendMessageBatchResponse
$creadsPrec :: Int -> ReadS SendMessageBatchResponse
Prelude.Read, Int -> SendMessageBatchResponse -> ShowS
[SendMessageBatchResponse] -> ShowS
SendMessageBatchResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SendMessageBatchResponse] -> ShowS
$cshowList :: [SendMessageBatchResponse] -> ShowS
show :: SendMessageBatchResponse -> String
$cshow :: SendMessageBatchResponse -> String
showsPrec :: Int -> SendMessageBatchResponse -> ShowS
$cshowsPrec :: Int -> SendMessageBatchResponse -> ShowS
Prelude.Show, forall x.
Rep SendMessageBatchResponse x -> SendMessageBatchResponse
forall x.
SendMessageBatchResponse -> Rep SendMessageBatchResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep SendMessageBatchResponse x -> SendMessageBatchResponse
$cfrom :: forall x.
SendMessageBatchResponse -> Rep SendMessageBatchResponse x
Prelude.Generic)

-- |
-- Create a value of 'SendMessageBatchResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'httpStatus', 'sendMessageBatchResponse_httpStatus' - The response's http status code.
--
-- 'successful', 'sendMessageBatchResponse_successful' - A list of @ @@SendMessageBatchResultEntry@@ @ items.
--
-- 'failed', 'sendMessageBatchResponse_failed' - A list of @ @@BatchResultErrorEntry@@ @ items with error details about
-- each message that can\'t be enqueued.
newSendMessageBatchResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  SendMessageBatchResponse
newSendMessageBatchResponse :: Int -> SendMessageBatchResponse
newSendMessageBatchResponse Int
pHttpStatus_ =
  SendMessageBatchResponse'
    { $sel:httpStatus:SendMessageBatchResponse' :: Int
httpStatus =
        Int
pHttpStatus_,
      $sel:successful:SendMessageBatchResponse' :: [SendMessageBatchResultEntry]
successful = forall a. Monoid a => a
Prelude.mempty,
      $sel:failed:SendMessageBatchResponse' :: [BatchResultErrorEntry]
failed = forall a. Monoid a => a
Prelude.mempty
    }

-- | The response's http status code.
sendMessageBatchResponse_httpStatus :: Lens.Lens' SendMessageBatchResponse Prelude.Int
sendMessageBatchResponse_httpStatus :: Lens' SendMessageBatchResponse Int
sendMessageBatchResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SendMessageBatchResponse' {Int
httpStatus :: Int
$sel:httpStatus:SendMessageBatchResponse' :: SendMessageBatchResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: SendMessageBatchResponse
s@SendMessageBatchResponse' {} Int
a -> SendMessageBatchResponse
s {$sel:httpStatus:SendMessageBatchResponse' :: Int
httpStatus = Int
a} :: SendMessageBatchResponse)

-- | A list of @ @@SendMessageBatchResultEntry@@ @ items.
sendMessageBatchResponse_successful :: Lens.Lens' SendMessageBatchResponse [SendMessageBatchResultEntry]
sendMessageBatchResponse_successful :: Lens' SendMessageBatchResponse [SendMessageBatchResultEntry]
sendMessageBatchResponse_successful = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SendMessageBatchResponse' {[SendMessageBatchResultEntry]
successful :: [SendMessageBatchResultEntry]
$sel:successful:SendMessageBatchResponse' :: SendMessageBatchResponse -> [SendMessageBatchResultEntry]
successful} -> [SendMessageBatchResultEntry]
successful) (\s :: SendMessageBatchResponse
s@SendMessageBatchResponse' {} [SendMessageBatchResultEntry]
a -> SendMessageBatchResponse
s {$sel:successful:SendMessageBatchResponse' :: [SendMessageBatchResultEntry]
successful = [SendMessageBatchResultEntry]
a} :: SendMessageBatchResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | A list of @ @@BatchResultErrorEntry@@ @ items with error details about
-- each message that can\'t be enqueued.
sendMessageBatchResponse_failed :: Lens.Lens' SendMessageBatchResponse [BatchResultErrorEntry]
sendMessageBatchResponse_failed :: Lens' SendMessageBatchResponse [BatchResultErrorEntry]
sendMessageBatchResponse_failed = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SendMessageBatchResponse' {[BatchResultErrorEntry]
failed :: [BatchResultErrorEntry]
$sel:failed:SendMessageBatchResponse' :: SendMessageBatchResponse -> [BatchResultErrorEntry]
failed} -> [BatchResultErrorEntry]
failed) (\s :: SendMessageBatchResponse
s@SendMessageBatchResponse' {} [BatchResultErrorEntry]
a -> SendMessageBatchResponse
s {$sel:failed:SendMessageBatchResponse' :: [BatchResultErrorEntry]
failed = [BatchResultErrorEntry]
a} :: SendMessageBatchResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Prelude.NFData SendMessageBatchResponse where
  rnf :: SendMessageBatchResponse -> ()
rnf SendMessageBatchResponse' {Int
[BatchResultErrorEntry]
[SendMessageBatchResultEntry]
failed :: [BatchResultErrorEntry]
successful :: [SendMessageBatchResultEntry]
httpStatus :: Int
$sel:failed:SendMessageBatchResponse' :: SendMessageBatchResponse -> [BatchResultErrorEntry]
$sel:successful:SendMessageBatchResponse' :: SendMessageBatchResponse -> [SendMessageBatchResultEntry]
$sel:httpStatus:SendMessageBatchResponse' :: SendMessageBatchResponse -> Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf [SendMessageBatchResultEntry]
successful
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf [BatchResultErrorEntry]
failed