{-# 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.Comprehend.Types.PiiOutputDataConfig
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Comprehend.Types.PiiOutputDataConfig 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

-- | Provides configuration parameters for the output of PII entity detection
-- jobs.
--
-- /See:/ 'newPiiOutputDataConfig' smart constructor.
data PiiOutputDataConfig = PiiOutputDataConfig'
  { -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
    -- uses to encrypt the output results from an analysis job.
    PiiOutputDataConfig -> Maybe Text
kmsKeyId :: Prelude.Maybe Prelude.Text,
    -- | When you use the @PiiOutputDataConfig@ object with asynchronous
    -- operations, you specify the Amazon S3 location where you want to write
    -- the output data.
    --
    -- For a PII entity detection job, the output file is plain text, not a
    -- compressed archive. The output file name is the same as the input file,
    -- with @.out@ appended at the end.
    PiiOutputDataConfig -> Text
s3Uri :: Prelude.Text
  }
  deriving (PiiOutputDataConfig -> PiiOutputDataConfig -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PiiOutputDataConfig -> PiiOutputDataConfig -> Bool
$c/= :: PiiOutputDataConfig -> PiiOutputDataConfig -> Bool
== :: PiiOutputDataConfig -> PiiOutputDataConfig -> Bool
$c== :: PiiOutputDataConfig -> PiiOutputDataConfig -> Bool
Prelude.Eq, ReadPrec [PiiOutputDataConfig]
ReadPrec PiiOutputDataConfig
Int -> ReadS PiiOutputDataConfig
ReadS [PiiOutputDataConfig]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [PiiOutputDataConfig]
$creadListPrec :: ReadPrec [PiiOutputDataConfig]
readPrec :: ReadPrec PiiOutputDataConfig
$creadPrec :: ReadPrec PiiOutputDataConfig
readList :: ReadS [PiiOutputDataConfig]
$creadList :: ReadS [PiiOutputDataConfig]
readsPrec :: Int -> ReadS PiiOutputDataConfig
$creadsPrec :: Int -> ReadS PiiOutputDataConfig
Prelude.Read, Int -> PiiOutputDataConfig -> ShowS
[PiiOutputDataConfig] -> ShowS
PiiOutputDataConfig -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PiiOutputDataConfig] -> ShowS
$cshowList :: [PiiOutputDataConfig] -> ShowS
show :: PiiOutputDataConfig -> String
$cshow :: PiiOutputDataConfig -> String
showsPrec :: Int -> PiiOutputDataConfig -> ShowS
$cshowsPrec :: Int -> PiiOutputDataConfig -> ShowS
Prelude.Show, forall x. Rep PiiOutputDataConfig x -> PiiOutputDataConfig
forall x. PiiOutputDataConfig -> Rep PiiOutputDataConfig x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep PiiOutputDataConfig x -> PiiOutputDataConfig
$cfrom :: forall x. PiiOutputDataConfig -> Rep PiiOutputDataConfig x
Prelude.Generic)

-- |
-- Create a value of 'PiiOutputDataConfig' 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:
--
-- 'kmsKeyId', 'piiOutputDataConfig_kmsKeyId' - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
-- uses to encrypt the output results from an analysis job.
--
-- 's3Uri', 'piiOutputDataConfig_s3Uri' - When you use the @PiiOutputDataConfig@ object with asynchronous
-- operations, you specify the Amazon S3 location where you want to write
-- the output data.
--
-- For a PII entity detection job, the output file is plain text, not a
-- compressed archive. The output file name is the same as the input file,
-- with @.out@ appended at the end.
newPiiOutputDataConfig ::
  -- | 's3Uri'
  Prelude.Text ->
  PiiOutputDataConfig
newPiiOutputDataConfig :: Text -> PiiOutputDataConfig
newPiiOutputDataConfig Text
pS3Uri_ =
  PiiOutputDataConfig'
    { $sel:kmsKeyId:PiiOutputDataConfig' :: Maybe Text
kmsKeyId = forall a. Maybe a
Prelude.Nothing,
      $sel:s3Uri:PiiOutputDataConfig' :: Text
s3Uri = Text
pS3Uri_
    }

-- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
-- uses to encrypt the output results from an analysis job.
piiOutputDataConfig_kmsKeyId :: Lens.Lens' PiiOutputDataConfig (Prelude.Maybe Prelude.Text)
piiOutputDataConfig_kmsKeyId :: Lens' PiiOutputDataConfig (Maybe Text)
piiOutputDataConfig_kmsKeyId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PiiOutputDataConfig' {Maybe Text
kmsKeyId :: Maybe Text
$sel:kmsKeyId:PiiOutputDataConfig' :: PiiOutputDataConfig -> Maybe Text
kmsKeyId} -> Maybe Text
kmsKeyId) (\s :: PiiOutputDataConfig
s@PiiOutputDataConfig' {} Maybe Text
a -> PiiOutputDataConfig
s {$sel:kmsKeyId:PiiOutputDataConfig' :: Maybe Text
kmsKeyId = Maybe Text
a} :: PiiOutputDataConfig)

-- | When you use the @PiiOutputDataConfig@ object with asynchronous
-- operations, you specify the Amazon S3 location where you want to write
-- the output data.
--
-- For a PII entity detection job, the output file is plain text, not a
-- compressed archive. The output file name is the same as the input file,
-- with @.out@ appended at the end.
piiOutputDataConfig_s3Uri :: Lens.Lens' PiiOutputDataConfig Prelude.Text
piiOutputDataConfig_s3Uri :: Lens' PiiOutputDataConfig Text
piiOutputDataConfig_s3Uri = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PiiOutputDataConfig' {Text
s3Uri :: Text
$sel:s3Uri:PiiOutputDataConfig' :: PiiOutputDataConfig -> Text
s3Uri} -> Text
s3Uri) (\s :: PiiOutputDataConfig
s@PiiOutputDataConfig' {} Text
a -> PiiOutputDataConfig
s {$sel:s3Uri:PiiOutputDataConfig' :: Text
s3Uri = Text
a} :: PiiOutputDataConfig)

instance Data.FromJSON PiiOutputDataConfig where
  parseJSON :: Value -> Parser PiiOutputDataConfig
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"PiiOutputDataConfig"
      ( \Object
x ->
          Maybe Text -> Text -> PiiOutputDataConfig
PiiOutputDataConfig'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"KmsKeyId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"S3Uri")
      )

instance Prelude.Hashable PiiOutputDataConfig where
  hashWithSalt :: Int -> PiiOutputDataConfig -> Int
hashWithSalt Int
_salt PiiOutputDataConfig' {Maybe Text
Text
s3Uri :: Text
kmsKeyId :: Maybe Text
$sel:s3Uri:PiiOutputDataConfig' :: PiiOutputDataConfig -> Text
$sel:kmsKeyId:PiiOutputDataConfig' :: PiiOutputDataConfig -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
kmsKeyId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
s3Uri

instance Prelude.NFData PiiOutputDataConfig where
  rnf :: PiiOutputDataConfig -> ()
rnf PiiOutputDataConfig' {Maybe Text
Text
s3Uri :: Text
kmsKeyId :: Maybe Text
$sel:s3Uri:PiiOutputDataConfig' :: PiiOutputDataConfig -> Text
$sel:kmsKeyId:PiiOutputDataConfig' :: PiiOutputDataConfig -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
kmsKeyId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
s3Uri