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

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

-- |
-- Module      : Amazonka.Textract.Types.OutputConfig
-- 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)
module Amazonka.Textract.Types.OutputConfig where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | Sets whether or not your output will go to a user created bucket. Used
-- to set the name of the bucket, and the prefix on the output file.
--
-- @OutputConfig@ is an optional parameter which lets you adjust where your
-- output will be placed. By default, Amazon Textract will store the
-- results internally and can only be accessed by the Get API operations.
-- With OutputConfig enabled, you can set the name of the bucket the output
-- will be sent to and the file prefix of the results where you can
-- download your results. Additionally, you can set the @KMSKeyID@
-- parameter to a customer master key (CMK) to encrypt your output. Without
-- this parameter set Amazon Textract will encrypt server-side using the
-- AWS managed CMK for Amazon S3.
--
-- Decryption of Customer Content is necessary for processing of the
-- documents by Amazon Textract. If your account is opted out under an AI
-- services opt out policy then all unencrypted Customer Content is
-- immediately and permanently deleted after the Customer Content has been
-- processed by the service. No copy of of the output is retained by Amazon
-- Textract. For information about how to opt out, see
-- <https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html Managing AI services opt-out policy.>
--
-- For more information on data privacy, see the
-- <https://aws.amazon.com/compliance/data-privacy-faq/ Data Privacy FAQ>.
--
-- /See:/ 'newOutputConfig' smart constructor.
data OutputConfig = OutputConfig'
  { -- | The prefix of the object key that the output will be saved to. When not
    -- enabled, the prefix will be “textract_output\".
    OutputConfig -> Maybe Text
s3Prefix :: Prelude.Maybe Prelude.Text,
    -- | The name of the bucket your output will go to.
    OutputConfig -> Text
s3Bucket :: Prelude.Text
  }
  deriving (OutputConfig -> OutputConfig -> Bool
(OutputConfig -> OutputConfig -> Bool)
-> (OutputConfig -> OutputConfig -> Bool) -> Eq OutputConfig
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: OutputConfig -> OutputConfig -> Bool
$c/= :: OutputConfig -> OutputConfig -> Bool
== :: OutputConfig -> OutputConfig -> Bool
$c== :: OutputConfig -> OutputConfig -> Bool
Prelude.Eq, ReadPrec [OutputConfig]
ReadPrec OutputConfig
Int -> ReadS OutputConfig
ReadS [OutputConfig]
(Int -> ReadS OutputConfig)
-> ReadS [OutputConfig]
-> ReadPrec OutputConfig
-> ReadPrec [OutputConfig]
-> Read OutputConfig
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [OutputConfig]
$creadListPrec :: ReadPrec [OutputConfig]
readPrec :: ReadPrec OutputConfig
$creadPrec :: ReadPrec OutputConfig
readList :: ReadS [OutputConfig]
$creadList :: ReadS [OutputConfig]
readsPrec :: Int -> ReadS OutputConfig
$creadsPrec :: Int -> ReadS OutputConfig
Prelude.Read, Int -> OutputConfig -> ShowS
[OutputConfig] -> ShowS
OutputConfig -> String
(Int -> OutputConfig -> ShowS)
-> (OutputConfig -> String)
-> ([OutputConfig] -> ShowS)
-> Show OutputConfig
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [OutputConfig] -> ShowS
$cshowList :: [OutputConfig] -> ShowS
show :: OutputConfig -> String
$cshow :: OutputConfig -> String
showsPrec :: Int -> OutputConfig -> ShowS
$cshowsPrec :: Int -> OutputConfig -> ShowS
Prelude.Show, (forall x. OutputConfig -> Rep OutputConfig x)
-> (forall x. Rep OutputConfig x -> OutputConfig)
-> Generic OutputConfig
forall x. Rep OutputConfig x -> OutputConfig
forall x. OutputConfig -> Rep OutputConfig x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep OutputConfig x -> OutputConfig
$cfrom :: forall x. OutputConfig -> Rep OutputConfig x
Prelude.Generic)

-- |
-- Create a value of 'OutputConfig' 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:
--
-- 's3Prefix', 'outputConfig_s3Prefix' - The prefix of the object key that the output will be saved to. When not
-- enabled, the prefix will be “textract_output\".
--
-- 's3Bucket', 'outputConfig_s3Bucket' - The name of the bucket your output will go to.
newOutputConfig ::
  -- | 's3Bucket'
  Prelude.Text ->
  OutputConfig
newOutputConfig :: Text -> OutputConfig
newOutputConfig Text
pS3Bucket_ =
  OutputConfig' :: Maybe Text -> Text -> OutputConfig
OutputConfig'
    { $sel:s3Prefix:OutputConfig' :: Maybe Text
s3Prefix = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:s3Bucket:OutputConfig' :: Text
s3Bucket = Text
pS3Bucket_
    }

-- | The prefix of the object key that the output will be saved to. When not
-- enabled, the prefix will be “textract_output\".
outputConfig_s3Prefix :: Lens.Lens' OutputConfig (Prelude.Maybe Prelude.Text)
outputConfig_s3Prefix :: (Maybe Text -> f (Maybe Text)) -> OutputConfig -> f OutputConfig
outputConfig_s3Prefix = (OutputConfig -> Maybe Text)
-> (OutputConfig -> Maybe Text -> OutputConfig)
-> Lens OutputConfig OutputConfig (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\OutputConfig' {Maybe Text
s3Prefix :: Maybe Text
$sel:s3Prefix:OutputConfig' :: OutputConfig -> Maybe Text
s3Prefix} -> Maybe Text
s3Prefix) (\s :: OutputConfig
s@OutputConfig' {} Maybe Text
a -> OutputConfig
s {$sel:s3Prefix:OutputConfig' :: Maybe Text
s3Prefix = Maybe Text
a} :: OutputConfig)

-- | The name of the bucket your output will go to.
outputConfig_s3Bucket :: Lens.Lens' OutputConfig Prelude.Text
outputConfig_s3Bucket :: (Text -> f Text) -> OutputConfig -> f OutputConfig
outputConfig_s3Bucket = (OutputConfig -> Text)
-> (OutputConfig -> Text -> OutputConfig)
-> Lens OutputConfig OutputConfig Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\OutputConfig' {Text
s3Bucket :: Text
$sel:s3Bucket:OutputConfig' :: OutputConfig -> Text
s3Bucket} -> Text
s3Bucket) (\s :: OutputConfig
s@OutputConfig' {} Text
a -> OutputConfig
s {$sel:s3Bucket:OutputConfig' :: Text
s3Bucket = Text
a} :: OutputConfig)

instance Prelude.Hashable OutputConfig

instance Prelude.NFData OutputConfig

instance Core.ToJSON OutputConfig where
  toJSON :: OutputConfig -> Value
toJSON OutputConfig' {Maybe Text
Text
s3Bucket :: Text
s3Prefix :: Maybe Text
$sel:s3Bucket:OutputConfig' :: OutputConfig -> Text
$sel:s3Prefix:OutputConfig' :: OutputConfig -> Maybe Text
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"S3Prefix" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
s3Prefix,
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"S3Bucket" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
s3Bucket)
          ]
      )