{-# 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.OutputDataConfig
-- 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.Comprehend.Types.OutputDataConfig where

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

-- | Provides configuration parameters for the output of topic detection
-- jobs.
--
-- /See:/ 'newOutputDataConfig' smart constructor.
data OutputDataConfig = OutputDataConfig'
  { -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
    -- uses to encrypt the output results from an analysis job. The KmsKeyId
    -- can be one of the following formats:
    --
    -- -   KMS Key ID: @\"1234abcd-12ab-34cd-56ef-1234567890ab\"@
    --
    -- -   Amazon Resource Name (ARN) of a KMS Key:
    --     @\"arn:aws:kms:us-west-2:111122223333:key\/1234abcd-12ab-34cd-56ef-1234567890ab\"@
    --
    -- -   KMS Key Alias: @\"alias\/ExampleAlias\"@
    --
    -- -   ARN of a KMS Key Alias:
    --     @\"arn:aws:kms:us-west-2:111122223333:alias\/ExampleAlias\"@
    OutputDataConfig -> Maybe Text
kmsKeyId :: Prelude.Maybe Prelude.Text,
    -- | When you use the @OutputDataConfig@ object with asynchronous operations,
    -- you specify the Amazon S3 location where you want to write the output
    -- data. The URI must be in the same region as the API endpoint that you
    -- are calling. The location is used as the prefix for the actual location
    -- of the output file.
    --
    -- When the topic detection job is finished, the service creates an output
    -- file in a directory specific to the job. The @S3Uri@ field contains the
    -- location of the output file, called @output.tar.gz@. It is a compressed
    -- archive that contains the ouput of the operation.
    OutputDataConfig -> Text
s3Uri :: Prelude.Text
  }
  deriving (OutputDataConfig -> OutputDataConfig -> Bool
(OutputDataConfig -> OutputDataConfig -> Bool)
-> (OutputDataConfig -> OutputDataConfig -> Bool)
-> Eq OutputDataConfig
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: OutputDataConfig -> OutputDataConfig -> Bool
$c/= :: OutputDataConfig -> OutputDataConfig -> Bool
== :: OutputDataConfig -> OutputDataConfig -> Bool
$c== :: OutputDataConfig -> OutputDataConfig -> Bool
Prelude.Eq, ReadPrec [OutputDataConfig]
ReadPrec OutputDataConfig
Int -> ReadS OutputDataConfig
ReadS [OutputDataConfig]
(Int -> ReadS OutputDataConfig)
-> ReadS [OutputDataConfig]
-> ReadPrec OutputDataConfig
-> ReadPrec [OutputDataConfig]
-> Read OutputDataConfig
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [OutputDataConfig]
$creadListPrec :: ReadPrec [OutputDataConfig]
readPrec :: ReadPrec OutputDataConfig
$creadPrec :: ReadPrec OutputDataConfig
readList :: ReadS [OutputDataConfig]
$creadList :: ReadS [OutputDataConfig]
readsPrec :: Int -> ReadS OutputDataConfig
$creadsPrec :: Int -> ReadS OutputDataConfig
Prelude.Read, Int -> OutputDataConfig -> ShowS
[OutputDataConfig] -> ShowS
OutputDataConfig -> String
(Int -> OutputDataConfig -> ShowS)
-> (OutputDataConfig -> String)
-> ([OutputDataConfig] -> ShowS)
-> Show OutputDataConfig
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [OutputDataConfig] -> ShowS
$cshowList :: [OutputDataConfig] -> ShowS
show :: OutputDataConfig -> String
$cshow :: OutputDataConfig -> String
showsPrec :: Int -> OutputDataConfig -> ShowS
$cshowsPrec :: Int -> OutputDataConfig -> ShowS
Prelude.Show, (forall x. OutputDataConfig -> Rep OutputDataConfig x)
-> (forall x. Rep OutputDataConfig x -> OutputDataConfig)
-> Generic OutputDataConfig
forall x. Rep OutputDataConfig x -> OutputDataConfig
forall x. OutputDataConfig -> Rep OutputDataConfig x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep OutputDataConfig x -> OutputDataConfig
$cfrom :: forall x. OutputDataConfig -> Rep OutputDataConfig x
Prelude.Generic)

-- |
-- Create a value of 'OutputDataConfig' 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', 'outputDataConfig_kmsKeyId' - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
-- uses to encrypt the output results from an analysis job. The KmsKeyId
-- can be one of the following formats:
--
-- -   KMS Key ID: @\"1234abcd-12ab-34cd-56ef-1234567890ab\"@
--
-- -   Amazon Resource Name (ARN) of a KMS Key:
--     @\"arn:aws:kms:us-west-2:111122223333:key\/1234abcd-12ab-34cd-56ef-1234567890ab\"@
--
-- -   KMS Key Alias: @\"alias\/ExampleAlias\"@
--
-- -   ARN of a KMS Key Alias:
--     @\"arn:aws:kms:us-west-2:111122223333:alias\/ExampleAlias\"@
--
-- 's3Uri', 'outputDataConfig_s3Uri' - When you use the @OutputDataConfig@ object with asynchronous operations,
-- you specify the Amazon S3 location where you want to write the output
-- data. The URI must be in the same region as the API endpoint that you
-- are calling. The location is used as the prefix for the actual location
-- of the output file.
--
-- When the topic detection job is finished, the service creates an output
-- file in a directory specific to the job. The @S3Uri@ field contains the
-- location of the output file, called @output.tar.gz@. It is a compressed
-- archive that contains the ouput of the operation.
newOutputDataConfig ::
  -- | 's3Uri'
  Prelude.Text ->
  OutputDataConfig
newOutputDataConfig :: Text -> OutputDataConfig
newOutputDataConfig Text
pS3Uri_ =
  OutputDataConfig' :: Maybe Text -> Text -> OutputDataConfig
OutputDataConfig'
    { $sel:kmsKeyId:OutputDataConfig' :: Maybe Text
kmsKeyId = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:s3Uri:OutputDataConfig' :: 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. The KmsKeyId
-- can be one of the following formats:
--
-- -   KMS Key ID: @\"1234abcd-12ab-34cd-56ef-1234567890ab\"@
--
-- -   Amazon Resource Name (ARN) of a KMS Key:
--     @\"arn:aws:kms:us-west-2:111122223333:key\/1234abcd-12ab-34cd-56ef-1234567890ab\"@
--
-- -   KMS Key Alias: @\"alias\/ExampleAlias\"@
--
-- -   ARN of a KMS Key Alias:
--     @\"arn:aws:kms:us-west-2:111122223333:alias\/ExampleAlias\"@
outputDataConfig_kmsKeyId :: Lens.Lens' OutputDataConfig (Prelude.Maybe Prelude.Text)
outputDataConfig_kmsKeyId :: (Maybe Text -> f (Maybe Text))
-> OutputDataConfig -> f OutputDataConfig
outputDataConfig_kmsKeyId = (OutputDataConfig -> Maybe Text)
-> (OutputDataConfig -> Maybe Text -> OutputDataConfig)
-> Lens OutputDataConfig OutputDataConfig (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\OutputDataConfig' {Maybe Text
kmsKeyId :: Maybe Text
$sel:kmsKeyId:OutputDataConfig' :: OutputDataConfig -> Maybe Text
kmsKeyId} -> Maybe Text
kmsKeyId) (\s :: OutputDataConfig
s@OutputDataConfig' {} Maybe Text
a -> OutputDataConfig
s {$sel:kmsKeyId:OutputDataConfig' :: Maybe Text
kmsKeyId = Maybe Text
a} :: OutputDataConfig)

-- | When you use the @OutputDataConfig@ object with asynchronous operations,
-- you specify the Amazon S3 location where you want to write the output
-- data. The URI must be in the same region as the API endpoint that you
-- are calling. The location is used as the prefix for the actual location
-- of the output file.
--
-- When the topic detection job is finished, the service creates an output
-- file in a directory specific to the job. The @S3Uri@ field contains the
-- location of the output file, called @output.tar.gz@. It is a compressed
-- archive that contains the ouput of the operation.
outputDataConfig_s3Uri :: Lens.Lens' OutputDataConfig Prelude.Text
outputDataConfig_s3Uri :: (Text -> f Text) -> OutputDataConfig -> f OutputDataConfig
outputDataConfig_s3Uri = (OutputDataConfig -> Text)
-> (OutputDataConfig -> Text -> OutputDataConfig)
-> Lens OutputDataConfig OutputDataConfig Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\OutputDataConfig' {Text
s3Uri :: Text
$sel:s3Uri:OutputDataConfig' :: OutputDataConfig -> Text
s3Uri} -> Text
s3Uri) (\s :: OutputDataConfig
s@OutputDataConfig' {} Text
a -> OutputDataConfig
s {$sel:s3Uri:OutputDataConfig' :: Text
s3Uri = Text
a} :: OutputDataConfig)

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

instance Prelude.Hashable OutputDataConfig

instance Prelude.NFData OutputDataConfig

instance Core.ToJSON OutputDataConfig where
  toJSON :: OutputDataConfig -> Value
toJSON OutputDataConfig' {Maybe Text
Text
s3Uri :: Text
kmsKeyId :: Maybe Text
$sel:s3Uri:OutputDataConfig' :: OutputDataConfig -> Text
$sel:kmsKeyId:OutputDataConfig' :: OutputDataConfig -> Maybe Text
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"KmsKeyId" 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
kmsKeyId,
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"S3Uri" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
s3Uri)
          ]
      )