{-# 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.SDB.BatchPutAttributes
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- The @BatchPutAttributes@ operation creates or replaces attributes within
-- one or more items. By using this operation, the client can perform
-- multiple PutAttribute operation with a single call. This helps yield
-- savings in round trips and latencies, enabling Amazon SimpleDB to
-- optimize requests and generally produce better throughput.
--
-- The client may specify the item name with the @Item.X.ItemName@
-- parameter. The client may specify new attributes using a combination of
-- the @Item.X.Attribute.Y.Name@ and @Item.X.Attribute.Y.Value@ parameters.
-- The client may specify the first attribute for the first item using the
-- parameters @Item.0.Attribute.0.Name@ and @Item.0.Attribute.0.Value@, and
-- for the second attribute for the first item by the parameters
-- @Item.0.Attribute.1.Name@ and @Item.0.Attribute.1.Value@, and so on.
--
-- Attributes are uniquely identified within an item by their name\/value
-- combination. For example, a single item can have the attributes
-- @{ \"first_name\", \"first_value\" }@ and
-- @{ \"first_name\", \"second_value\" }@. However, it cannot have two
-- attribute instances where both the @Item.X.Attribute.Y.Name@ and
-- @Item.X.Attribute.Y.Value@ are the same.
--
-- Optionally, the requester can supply the @Replace@ parameter for each
-- individual value. Setting this value to @true@ will cause the new
-- attribute values to replace the existing attribute values. For example,
-- if an item @I@ has the attributes @{ \'a\', \'1\' }, { \'b\', \'2\'}@
-- and @{ \'b\', \'3\' }@ and the requester does a BatchPutAttributes of
-- @{\'I\', \'b\', \'4\' }@ with the Replace parameter set to true, the
-- final attributes of the item will be @{ \'a\', \'1\' }@ and
-- @{ \'b\', \'4\' }@, replacing the previous values of the \'b\' attribute
-- with the new value.
--
-- This operation is vulnerable to exceeding the maximum URL size when
-- making a REST request using the HTTP GET method. This operation does not
-- support conditions using @Expected.X.Name@, @Expected.X.Value@, or
-- @Expected.X.Exists@.
--
-- You can execute multiple @BatchPutAttributes@ operations and other
-- operations in parallel. However, large numbers of concurrent
-- @BatchPutAttributes@ calls can result in Service Unavailable (503)
-- responses.
--
-- The following limitations are enforced for this operation:
--
-- -   256 attribute name-value pairs per item
-- -   1 MB request size
-- -   1 billion attributes per domain
-- -   10 GB of total user data storage per domain
-- -   25 item limit per @BatchPutAttributes@ operation
module Amazonka.SDB.BatchPutAttributes
  ( -- * Creating a Request
    BatchPutAttributes (..),
    newBatchPutAttributes,

    -- * Request Lenses
    batchPutAttributes_domainName,
    batchPutAttributes_items,

    -- * Destructuring the Response
    BatchPutAttributesResponse (..),
    newBatchPutAttributesResponse,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.SDB.Types

-- | /See:/ 'newBatchPutAttributes' smart constructor.
data BatchPutAttributes = BatchPutAttributes'
  { -- | The name of the domain in which the attributes are being stored.
    BatchPutAttributes -> Text
domainName :: Prelude.Text,
    -- | A list of items on which to perform the operation.
    BatchPutAttributes -> [ReplaceableItem]
items :: [ReplaceableItem]
  }
  deriving (BatchPutAttributes -> BatchPutAttributes -> Bool
(BatchPutAttributes -> BatchPutAttributes -> Bool)
-> (BatchPutAttributes -> BatchPutAttributes -> Bool)
-> Eq BatchPutAttributes
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: BatchPutAttributes -> BatchPutAttributes -> Bool
$c/= :: BatchPutAttributes -> BatchPutAttributes -> Bool
== :: BatchPutAttributes -> BatchPutAttributes -> Bool
$c== :: BatchPutAttributes -> BatchPutAttributes -> Bool
Prelude.Eq, ReadPrec [BatchPutAttributes]
ReadPrec BatchPutAttributes
Int -> ReadS BatchPutAttributes
ReadS [BatchPutAttributes]
(Int -> ReadS BatchPutAttributes)
-> ReadS [BatchPutAttributes]
-> ReadPrec BatchPutAttributes
-> ReadPrec [BatchPutAttributes]
-> Read BatchPutAttributes
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [BatchPutAttributes]
$creadListPrec :: ReadPrec [BatchPutAttributes]
readPrec :: ReadPrec BatchPutAttributes
$creadPrec :: ReadPrec BatchPutAttributes
readList :: ReadS [BatchPutAttributes]
$creadList :: ReadS [BatchPutAttributes]
readsPrec :: Int -> ReadS BatchPutAttributes
$creadsPrec :: Int -> ReadS BatchPutAttributes
Prelude.Read, Int -> BatchPutAttributes -> ShowS
[BatchPutAttributes] -> ShowS
BatchPutAttributes -> String
(Int -> BatchPutAttributes -> ShowS)
-> (BatchPutAttributes -> String)
-> ([BatchPutAttributes] -> ShowS)
-> Show BatchPutAttributes
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [BatchPutAttributes] -> ShowS
$cshowList :: [BatchPutAttributes] -> ShowS
show :: BatchPutAttributes -> String
$cshow :: BatchPutAttributes -> String
showsPrec :: Int -> BatchPutAttributes -> ShowS
$cshowsPrec :: Int -> BatchPutAttributes -> ShowS
Prelude.Show, (forall x. BatchPutAttributes -> Rep BatchPutAttributes x)
-> (forall x. Rep BatchPutAttributes x -> BatchPutAttributes)
-> Generic BatchPutAttributes
forall x. Rep BatchPutAttributes x -> BatchPutAttributes
forall x. BatchPutAttributes -> Rep BatchPutAttributes x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep BatchPutAttributes x -> BatchPutAttributes
$cfrom :: forall x. BatchPutAttributes -> Rep BatchPutAttributes x
Prelude.Generic)

-- |
-- Create a value of 'BatchPutAttributes' 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:
--
-- 'domainName', 'batchPutAttributes_domainName' - The name of the domain in which the attributes are being stored.
--
-- 'items', 'batchPutAttributes_items' - A list of items on which to perform the operation.
newBatchPutAttributes ::
  -- | 'domainName'
  Prelude.Text ->
  BatchPutAttributes
newBatchPutAttributes :: Text -> BatchPutAttributes
newBatchPutAttributes Text
pDomainName_ =
  BatchPutAttributes' :: Text -> [ReplaceableItem] -> BatchPutAttributes
BatchPutAttributes'
    { $sel:domainName:BatchPutAttributes' :: Text
domainName = Text
pDomainName_,
      $sel:items:BatchPutAttributes' :: [ReplaceableItem]
items = [ReplaceableItem]
forall a. Monoid a => a
Prelude.mempty
    }

-- | The name of the domain in which the attributes are being stored.
batchPutAttributes_domainName :: Lens.Lens' BatchPutAttributes Prelude.Text
batchPutAttributes_domainName :: (Text -> f Text) -> BatchPutAttributes -> f BatchPutAttributes
batchPutAttributes_domainName = (BatchPutAttributes -> Text)
-> (BatchPutAttributes -> Text -> BatchPutAttributes)
-> Lens BatchPutAttributes BatchPutAttributes Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BatchPutAttributes' {Text
domainName :: Text
$sel:domainName:BatchPutAttributes' :: BatchPutAttributes -> Text
domainName} -> Text
domainName) (\s :: BatchPutAttributes
s@BatchPutAttributes' {} Text
a -> BatchPutAttributes
s {$sel:domainName:BatchPutAttributes' :: Text
domainName = Text
a} :: BatchPutAttributes)

-- | A list of items on which to perform the operation.
batchPutAttributes_items :: Lens.Lens' BatchPutAttributes [ReplaceableItem]
batchPutAttributes_items :: ([ReplaceableItem] -> f [ReplaceableItem])
-> BatchPutAttributes -> f BatchPutAttributes
batchPutAttributes_items = (BatchPutAttributes -> [ReplaceableItem])
-> (BatchPutAttributes -> [ReplaceableItem] -> BatchPutAttributes)
-> Lens
     BatchPutAttributes
     BatchPutAttributes
     [ReplaceableItem]
     [ReplaceableItem]
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BatchPutAttributes' {[ReplaceableItem]
items :: [ReplaceableItem]
$sel:items:BatchPutAttributes' :: BatchPutAttributes -> [ReplaceableItem]
items} -> [ReplaceableItem]
items) (\s :: BatchPutAttributes
s@BatchPutAttributes' {} [ReplaceableItem]
a -> BatchPutAttributes
s {$sel:items:BatchPutAttributes' :: [ReplaceableItem]
items = [ReplaceableItem]
a} :: BatchPutAttributes) (([ReplaceableItem] -> f [ReplaceableItem])
 -> BatchPutAttributes -> f BatchPutAttributes)
-> (([ReplaceableItem] -> f [ReplaceableItem])
    -> [ReplaceableItem] -> f [ReplaceableItem])
-> ([ReplaceableItem] -> f [ReplaceableItem])
-> BatchPutAttributes
-> f BatchPutAttributes
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. ([ReplaceableItem] -> f [ReplaceableItem])
-> [ReplaceableItem] -> f [ReplaceableItem]
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Core.AWSRequest BatchPutAttributes where
  type
    AWSResponse BatchPutAttributes =
      BatchPutAttributesResponse
  request :: BatchPutAttributes -> Request BatchPutAttributes
request = Service -> BatchPutAttributes -> Request BatchPutAttributes
forall a. ToRequest a => Service -> a -> Request a
Request.postQuery Service
defaultService
  response :: Logger
-> Service
-> Proxy BatchPutAttributes
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse BatchPutAttributes)))
response =
    AWSResponse BatchPutAttributes
-> Logger
-> Service
-> Proxy BatchPutAttributes
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse BatchPutAttributes)))
forall (m :: * -> *) a.
MonadResource m =>
AWSResponse a
-> Logger
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveNull AWSResponse BatchPutAttributes
BatchPutAttributesResponse
BatchPutAttributesResponse'

instance Prelude.Hashable BatchPutAttributes

instance Prelude.NFData BatchPutAttributes

instance Core.ToHeaders BatchPutAttributes where
  toHeaders :: BatchPutAttributes -> [Header]
toHeaders = [Header] -> BatchPutAttributes -> [Header]
forall a b. a -> b -> a
Prelude.const [Header]
forall a. Monoid a => a
Prelude.mempty

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

instance Core.ToQuery BatchPutAttributes where
  toQuery :: BatchPutAttributes -> QueryString
toQuery BatchPutAttributes' {[ReplaceableItem]
Text
items :: [ReplaceableItem]
domainName :: Text
$sel:items:BatchPutAttributes' :: BatchPutAttributes -> [ReplaceableItem]
$sel:domainName:BatchPutAttributes' :: BatchPutAttributes -> Text
..} =
    [QueryString] -> QueryString
forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"Action"
          ByteString -> ByteString -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: (ByteString
"BatchPutAttributes" :: Prelude.ByteString),
        ByteString
"Version"
          ByteString -> ByteString -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: (ByteString
"2009-04-15" :: Prelude.ByteString),
        ByteString
"DomainName" ByteString -> Text -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Text
domainName,
        ByteString -> [ReplaceableItem] -> QueryString
forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Core.toQueryList ByteString
"Item" [ReplaceableItem]
items
      ]

-- | /See:/ 'newBatchPutAttributesResponse' smart constructor.
data BatchPutAttributesResponse = BatchPutAttributesResponse'
  {
  }
  deriving (BatchPutAttributesResponse -> BatchPutAttributesResponse -> Bool
(BatchPutAttributesResponse -> BatchPutAttributesResponse -> Bool)
-> (BatchPutAttributesResponse
    -> BatchPutAttributesResponse -> Bool)
-> Eq BatchPutAttributesResponse
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: BatchPutAttributesResponse -> BatchPutAttributesResponse -> Bool
$c/= :: BatchPutAttributesResponse -> BatchPutAttributesResponse -> Bool
== :: BatchPutAttributesResponse -> BatchPutAttributesResponse -> Bool
$c== :: BatchPutAttributesResponse -> BatchPutAttributesResponse -> Bool
Prelude.Eq, ReadPrec [BatchPutAttributesResponse]
ReadPrec BatchPutAttributesResponse
Int -> ReadS BatchPutAttributesResponse
ReadS [BatchPutAttributesResponse]
(Int -> ReadS BatchPutAttributesResponse)
-> ReadS [BatchPutAttributesResponse]
-> ReadPrec BatchPutAttributesResponse
-> ReadPrec [BatchPutAttributesResponse]
-> Read BatchPutAttributesResponse
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [BatchPutAttributesResponse]
$creadListPrec :: ReadPrec [BatchPutAttributesResponse]
readPrec :: ReadPrec BatchPutAttributesResponse
$creadPrec :: ReadPrec BatchPutAttributesResponse
readList :: ReadS [BatchPutAttributesResponse]
$creadList :: ReadS [BatchPutAttributesResponse]
readsPrec :: Int -> ReadS BatchPutAttributesResponse
$creadsPrec :: Int -> ReadS BatchPutAttributesResponse
Prelude.Read, Int -> BatchPutAttributesResponse -> ShowS
[BatchPutAttributesResponse] -> ShowS
BatchPutAttributesResponse -> String
(Int -> BatchPutAttributesResponse -> ShowS)
-> (BatchPutAttributesResponse -> String)
-> ([BatchPutAttributesResponse] -> ShowS)
-> Show BatchPutAttributesResponse
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [BatchPutAttributesResponse] -> ShowS
$cshowList :: [BatchPutAttributesResponse] -> ShowS
show :: BatchPutAttributesResponse -> String
$cshow :: BatchPutAttributesResponse -> String
showsPrec :: Int -> BatchPutAttributesResponse -> ShowS
$cshowsPrec :: Int -> BatchPutAttributesResponse -> ShowS
Prelude.Show, (forall x.
 BatchPutAttributesResponse -> Rep BatchPutAttributesResponse x)
-> (forall x.
    Rep BatchPutAttributesResponse x -> BatchPutAttributesResponse)
-> Generic BatchPutAttributesResponse
forall x.
Rep BatchPutAttributesResponse x -> BatchPutAttributesResponse
forall x.
BatchPutAttributesResponse -> Rep BatchPutAttributesResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep BatchPutAttributesResponse x -> BatchPutAttributesResponse
$cfrom :: forall x.
BatchPutAttributesResponse -> Rep BatchPutAttributesResponse x
Prelude.Generic)

-- |
-- Create a value of 'BatchPutAttributesResponse' 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.
newBatchPutAttributesResponse ::
  BatchPutAttributesResponse
newBatchPutAttributesResponse :: BatchPutAttributesResponse
newBatchPutAttributesResponse =
  BatchPutAttributesResponse
BatchPutAttributesResponse'

instance Prelude.NFData BatchPutAttributesResponse