amazonka-clouddirectory-2.0: gen/Amazonka/CloudDirectory/BatchWrite.hs
{-# 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.CloudDirectory.BatchWrite
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Performs all the write operations in a batch. Either all the operations
-- succeed or none.
module Amazonka.CloudDirectory.BatchWrite
( -- * Creating a Request
BatchWrite (..),
newBatchWrite,
-- * Request Lenses
batchWrite_directoryArn,
batchWrite_operations,
-- * Destructuring the Response
BatchWriteResponse (..),
newBatchWriteResponse,
-- * Response Lenses
batchWriteResponse_responses,
batchWriteResponse_httpStatus,
)
where
import Amazonka.CloudDirectory.Types
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
-- | /See:/ 'newBatchWrite' smart constructor.
data BatchWrite = BatchWrite'
{ -- | The Amazon Resource Name (ARN) that is associated with the Directory.
-- For more information, see arns.
directoryArn :: Prelude.Text,
-- | A list of operations that are part of the batch.
operations :: [BatchWriteOperation]
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'BatchWrite' 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:
--
-- 'directoryArn', 'batchWrite_directoryArn' - The Amazon Resource Name (ARN) that is associated with the Directory.
-- For more information, see arns.
--
-- 'operations', 'batchWrite_operations' - A list of operations that are part of the batch.
newBatchWrite ::
-- | 'directoryArn'
Prelude.Text ->
BatchWrite
newBatchWrite pDirectoryArn_ =
BatchWrite'
{ directoryArn = pDirectoryArn_,
operations = Prelude.mempty
}
-- | The Amazon Resource Name (ARN) that is associated with the Directory.
-- For more information, see arns.
batchWrite_directoryArn :: Lens.Lens' BatchWrite Prelude.Text
batchWrite_directoryArn = Lens.lens (\BatchWrite' {directoryArn} -> directoryArn) (\s@BatchWrite' {} a -> s {directoryArn = a} :: BatchWrite)
-- | A list of operations that are part of the batch.
batchWrite_operations :: Lens.Lens' BatchWrite [BatchWriteOperation]
batchWrite_operations = Lens.lens (\BatchWrite' {operations} -> operations) (\s@BatchWrite' {} a -> s {operations = a} :: BatchWrite) Prelude.. Lens.coerced
instance Core.AWSRequest BatchWrite where
type AWSResponse BatchWrite = BatchWriteResponse
request overrides =
Request.putJSON (overrides defaultService)
response =
Response.receiveJSON
( \s h x ->
BatchWriteResponse'
Prelude.<$> (x Data..?> "Responses" Core..!@ Prelude.mempty)
Prelude.<*> (Prelude.pure (Prelude.fromEnum s))
)
instance Prelude.Hashable BatchWrite where
hashWithSalt _salt BatchWrite' {..} =
_salt
`Prelude.hashWithSalt` directoryArn
`Prelude.hashWithSalt` operations
instance Prelude.NFData BatchWrite where
rnf BatchWrite' {..} =
Prelude.rnf directoryArn
`Prelude.seq` Prelude.rnf operations
instance Data.ToHeaders BatchWrite where
toHeaders BatchWrite' {..} =
Prelude.mconcat
["x-amz-data-partition" Data.=# directoryArn]
instance Data.ToJSON BatchWrite where
toJSON BatchWrite' {..} =
Data.object
( Prelude.catMaybes
[Prelude.Just ("Operations" Data..= operations)]
)
instance Data.ToPath BatchWrite where
toPath =
Prelude.const
"/amazonclouddirectory/2017-01-11/batchwrite"
instance Data.ToQuery BatchWrite where
toQuery = Prelude.const Prelude.mempty
-- | /See:/ 'newBatchWriteResponse' smart constructor.
data BatchWriteResponse = BatchWriteResponse'
{ -- | A list of all the responses for each batch write.
responses :: Prelude.Maybe [BatchWriteOperationResponse],
-- | The response's http status code.
httpStatus :: Prelude.Int
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'BatchWriteResponse' 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:
--
-- 'responses', 'batchWriteResponse_responses' - A list of all the responses for each batch write.
--
-- 'httpStatus', 'batchWriteResponse_httpStatus' - The response's http status code.
newBatchWriteResponse ::
-- | 'httpStatus'
Prelude.Int ->
BatchWriteResponse
newBatchWriteResponse pHttpStatus_ =
BatchWriteResponse'
{ responses = Prelude.Nothing,
httpStatus = pHttpStatus_
}
-- | A list of all the responses for each batch write.
batchWriteResponse_responses :: Lens.Lens' BatchWriteResponse (Prelude.Maybe [BatchWriteOperationResponse])
batchWriteResponse_responses = Lens.lens (\BatchWriteResponse' {responses} -> responses) (\s@BatchWriteResponse' {} a -> s {responses = a} :: BatchWriteResponse) Prelude.. Lens.mapping Lens.coerced
-- | The response's http status code.
batchWriteResponse_httpStatus :: Lens.Lens' BatchWriteResponse Prelude.Int
batchWriteResponse_httpStatus = Lens.lens (\BatchWriteResponse' {httpStatus} -> httpStatus) (\s@BatchWriteResponse' {} a -> s {httpStatus = a} :: BatchWriteResponse)
instance Prelude.NFData BatchWriteResponse where
rnf BatchWriteResponse' {..} =
Prelude.rnf responses
`Prelude.seq` Prelude.rnf httpStatus