{-# 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.LexV2Models.Types.S3BucketTranscriptSource
-- 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.LexV2Models.Types.S3BucketTranscriptSource where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.LexV2Models.Types.PathFormat
import Amazonka.LexV2Models.Types.TranscriptFilter
import Amazonka.LexV2Models.Types.TranscriptFormat
import qualified Amazonka.Prelude as Prelude

-- | The object representing the Amazon S3 bucket containing the transcript,
-- as well as the associated metadata.
--
-- /See:/ 'newS3BucketTranscriptSource' smart constructor.
data S3BucketTranscriptSource = S3BucketTranscriptSource'
  { -- | The ARN of the KMS key that customer use to encrypt their Amazon S3
    -- bucket. Only use this field if your bucket is encrypted using a customer
    -- managed KMS key.
    S3BucketTranscriptSource -> Maybe Text
kmsKeyArn :: Prelude.Maybe Prelude.Text,
    -- | The object that contains a path format that will be applied when Amazon
    -- Lex reads the transcript file in the bucket you provide. Specify this
    -- object if you only want Lex to read a subset of files in your Amazon S3
    -- bucket.
    S3BucketTranscriptSource -> Maybe PathFormat
pathFormat :: Prelude.Maybe PathFormat,
    -- | The object that contains the filter which will be applied when Amazon
    -- Lex reads through the Amazon S3 bucket. Specify this object if you want
    -- Amazon Lex to read only a subset of the Amazon S3 bucket based on the
    -- filter you provide.
    S3BucketTranscriptSource -> Maybe TranscriptFilter
transcriptFilter :: Prelude.Maybe TranscriptFilter,
    -- | The name of the bucket containing the transcript and the associated
    -- metadata.
    S3BucketTranscriptSource -> Text
s3BucketName :: Prelude.Text,
    -- | The format of the transcript content. Currently, Genie only supports the
    -- Amazon Lex transcript format.
    S3BucketTranscriptSource -> TranscriptFormat
transcriptFormat :: TranscriptFormat
  }
  deriving (S3BucketTranscriptSource -> S3BucketTranscriptSource -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: S3BucketTranscriptSource -> S3BucketTranscriptSource -> Bool
$c/= :: S3BucketTranscriptSource -> S3BucketTranscriptSource -> Bool
== :: S3BucketTranscriptSource -> S3BucketTranscriptSource -> Bool
$c== :: S3BucketTranscriptSource -> S3BucketTranscriptSource -> Bool
Prelude.Eq, ReadPrec [S3BucketTranscriptSource]
ReadPrec S3BucketTranscriptSource
Int -> ReadS S3BucketTranscriptSource
ReadS [S3BucketTranscriptSource]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [S3BucketTranscriptSource]
$creadListPrec :: ReadPrec [S3BucketTranscriptSource]
readPrec :: ReadPrec S3BucketTranscriptSource
$creadPrec :: ReadPrec S3BucketTranscriptSource
readList :: ReadS [S3BucketTranscriptSource]
$creadList :: ReadS [S3BucketTranscriptSource]
readsPrec :: Int -> ReadS S3BucketTranscriptSource
$creadsPrec :: Int -> ReadS S3BucketTranscriptSource
Prelude.Read, Int -> S3BucketTranscriptSource -> ShowS
[S3BucketTranscriptSource] -> ShowS
S3BucketTranscriptSource -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [S3BucketTranscriptSource] -> ShowS
$cshowList :: [S3BucketTranscriptSource] -> ShowS
show :: S3BucketTranscriptSource -> String
$cshow :: S3BucketTranscriptSource -> String
showsPrec :: Int -> S3BucketTranscriptSource -> ShowS
$cshowsPrec :: Int -> S3BucketTranscriptSource -> ShowS
Prelude.Show, forall x.
Rep S3BucketTranscriptSource x -> S3BucketTranscriptSource
forall x.
S3BucketTranscriptSource -> Rep S3BucketTranscriptSource x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep S3BucketTranscriptSource x -> S3BucketTranscriptSource
$cfrom :: forall x.
S3BucketTranscriptSource -> Rep S3BucketTranscriptSource x
Prelude.Generic)

-- |
-- Create a value of 'S3BucketTranscriptSource' 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:
--
-- 'kmsKeyArn', 's3BucketTranscriptSource_kmsKeyArn' - The ARN of the KMS key that customer use to encrypt their Amazon S3
-- bucket. Only use this field if your bucket is encrypted using a customer
-- managed KMS key.
--
-- 'pathFormat', 's3BucketTranscriptSource_pathFormat' - The object that contains a path format that will be applied when Amazon
-- Lex reads the transcript file in the bucket you provide. Specify this
-- object if you only want Lex to read a subset of files in your Amazon S3
-- bucket.
--
-- 'transcriptFilter', 's3BucketTranscriptSource_transcriptFilter' - The object that contains the filter which will be applied when Amazon
-- Lex reads through the Amazon S3 bucket. Specify this object if you want
-- Amazon Lex to read only a subset of the Amazon S3 bucket based on the
-- filter you provide.
--
-- 's3BucketName', 's3BucketTranscriptSource_s3BucketName' - The name of the bucket containing the transcript and the associated
-- metadata.
--
-- 'transcriptFormat', 's3BucketTranscriptSource_transcriptFormat' - The format of the transcript content. Currently, Genie only supports the
-- Amazon Lex transcript format.
newS3BucketTranscriptSource ::
  -- | 's3BucketName'
  Prelude.Text ->
  -- | 'transcriptFormat'
  TranscriptFormat ->
  S3BucketTranscriptSource
newS3BucketTranscriptSource :: Text -> TranscriptFormat -> S3BucketTranscriptSource
newS3BucketTranscriptSource
  Text
pS3BucketName_
  TranscriptFormat
pTranscriptFormat_ =
    S3BucketTranscriptSource'
      { $sel:kmsKeyArn:S3BucketTranscriptSource' :: Maybe Text
kmsKeyArn =
          forall a. Maybe a
Prelude.Nothing,
        $sel:pathFormat:S3BucketTranscriptSource' :: Maybe PathFormat
pathFormat = forall a. Maybe a
Prelude.Nothing,
        $sel:transcriptFilter:S3BucketTranscriptSource' :: Maybe TranscriptFilter
transcriptFilter = forall a. Maybe a
Prelude.Nothing,
        $sel:s3BucketName:S3BucketTranscriptSource' :: Text
s3BucketName = Text
pS3BucketName_,
        $sel:transcriptFormat:S3BucketTranscriptSource' :: TranscriptFormat
transcriptFormat = TranscriptFormat
pTranscriptFormat_
      }

-- | The ARN of the KMS key that customer use to encrypt their Amazon S3
-- bucket. Only use this field if your bucket is encrypted using a customer
-- managed KMS key.
s3BucketTranscriptSource_kmsKeyArn :: Lens.Lens' S3BucketTranscriptSource (Prelude.Maybe Prelude.Text)
s3BucketTranscriptSource_kmsKeyArn :: Lens' S3BucketTranscriptSource (Maybe Text)
s3BucketTranscriptSource_kmsKeyArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\S3BucketTranscriptSource' {Maybe Text
kmsKeyArn :: Maybe Text
$sel:kmsKeyArn:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> Maybe Text
kmsKeyArn} -> Maybe Text
kmsKeyArn) (\s :: S3BucketTranscriptSource
s@S3BucketTranscriptSource' {} Maybe Text
a -> S3BucketTranscriptSource
s {$sel:kmsKeyArn:S3BucketTranscriptSource' :: Maybe Text
kmsKeyArn = Maybe Text
a} :: S3BucketTranscriptSource)

-- | The object that contains a path format that will be applied when Amazon
-- Lex reads the transcript file in the bucket you provide. Specify this
-- object if you only want Lex to read a subset of files in your Amazon S3
-- bucket.
s3BucketTranscriptSource_pathFormat :: Lens.Lens' S3BucketTranscriptSource (Prelude.Maybe PathFormat)
s3BucketTranscriptSource_pathFormat :: Lens' S3BucketTranscriptSource (Maybe PathFormat)
s3BucketTranscriptSource_pathFormat = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\S3BucketTranscriptSource' {Maybe PathFormat
pathFormat :: Maybe PathFormat
$sel:pathFormat:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> Maybe PathFormat
pathFormat} -> Maybe PathFormat
pathFormat) (\s :: S3BucketTranscriptSource
s@S3BucketTranscriptSource' {} Maybe PathFormat
a -> S3BucketTranscriptSource
s {$sel:pathFormat:S3BucketTranscriptSource' :: Maybe PathFormat
pathFormat = Maybe PathFormat
a} :: S3BucketTranscriptSource)

-- | The object that contains the filter which will be applied when Amazon
-- Lex reads through the Amazon S3 bucket. Specify this object if you want
-- Amazon Lex to read only a subset of the Amazon S3 bucket based on the
-- filter you provide.
s3BucketTranscriptSource_transcriptFilter :: Lens.Lens' S3BucketTranscriptSource (Prelude.Maybe TranscriptFilter)
s3BucketTranscriptSource_transcriptFilter :: Lens' S3BucketTranscriptSource (Maybe TranscriptFilter)
s3BucketTranscriptSource_transcriptFilter = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\S3BucketTranscriptSource' {Maybe TranscriptFilter
transcriptFilter :: Maybe TranscriptFilter
$sel:transcriptFilter:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> Maybe TranscriptFilter
transcriptFilter} -> Maybe TranscriptFilter
transcriptFilter) (\s :: S3BucketTranscriptSource
s@S3BucketTranscriptSource' {} Maybe TranscriptFilter
a -> S3BucketTranscriptSource
s {$sel:transcriptFilter:S3BucketTranscriptSource' :: Maybe TranscriptFilter
transcriptFilter = Maybe TranscriptFilter
a} :: S3BucketTranscriptSource)

-- | The name of the bucket containing the transcript and the associated
-- metadata.
s3BucketTranscriptSource_s3BucketName :: Lens.Lens' S3BucketTranscriptSource Prelude.Text
s3BucketTranscriptSource_s3BucketName :: Lens' S3BucketTranscriptSource Text
s3BucketTranscriptSource_s3BucketName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\S3BucketTranscriptSource' {Text
s3BucketName :: Text
$sel:s3BucketName:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> Text
s3BucketName} -> Text
s3BucketName) (\s :: S3BucketTranscriptSource
s@S3BucketTranscriptSource' {} Text
a -> S3BucketTranscriptSource
s {$sel:s3BucketName:S3BucketTranscriptSource' :: Text
s3BucketName = Text
a} :: S3BucketTranscriptSource)

-- | The format of the transcript content. Currently, Genie only supports the
-- Amazon Lex transcript format.
s3BucketTranscriptSource_transcriptFormat :: Lens.Lens' S3BucketTranscriptSource TranscriptFormat
s3BucketTranscriptSource_transcriptFormat :: Lens' S3BucketTranscriptSource TranscriptFormat
s3BucketTranscriptSource_transcriptFormat = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\S3BucketTranscriptSource' {TranscriptFormat
transcriptFormat :: TranscriptFormat
$sel:transcriptFormat:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> TranscriptFormat
transcriptFormat} -> TranscriptFormat
transcriptFormat) (\s :: S3BucketTranscriptSource
s@S3BucketTranscriptSource' {} TranscriptFormat
a -> S3BucketTranscriptSource
s {$sel:transcriptFormat:S3BucketTranscriptSource' :: TranscriptFormat
transcriptFormat = TranscriptFormat
a} :: S3BucketTranscriptSource)

instance Data.FromJSON S3BucketTranscriptSource where
  parseJSON :: Value -> Parser S3BucketTranscriptSource
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"S3BucketTranscriptSource"
      ( \Object
x ->
          Maybe Text
-> Maybe PathFormat
-> Maybe TranscriptFilter
-> Text
-> TranscriptFormat
-> S3BucketTranscriptSource
S3BucketTranscriptSource'
            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
"kmsKeyArn")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"pathFormat")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"transcriptFilter")
            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
"s3BucketName")
            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
"transcriptFormat")
      )

instance Prelude.Hashable S3BucketTranscriptSource where
  hashWithSalt :: Int -> S3BucketTranscriptSource -> Int
hashWithSalt Int
_salt S3BucketTranscriptSource' {Maybe Text
Maybe PathFormat
Maybe TranscriptFilter
Text
TranscriptFormat
transcriptFormat :: TranscriptFormat
s3BucketName :: Text
transcriptFilter :: Maybe TranscriptFilter
pathFormat :: Maybe PathFormat
kmsKeyArn :: Maybe Text
$sel:transcriptFormat:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> TranscriptFormat
$sel:s3BucketName:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> Text
$sel:transcriptFilter:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> Maybe TranscriptFilter
$sel:pathFormat:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> Maybe PathFormat
$sel:kmsKeyArn:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
kmsKeyArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe PathFormat
pathFormat
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe TranscriptFilter
transcriptFilter
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
s3BucketName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` TranscriptFormat
transcriptFormat

instance Prelude.NFData S3BucketTranscriptSource where
  rnf :: S3BucketTranscriptSource -> ()
rnf S3BucketTranscriptSource' {Maybe Text
Maybe PathFormat
Maybe TranscriptFilter
Text
TranscriptFormat
transcriptFormat :: TranscriptFormat
s3BucketName :: Text
transcriptFilter :: Maybe TranscriptFilter
pathFormat :: Maybe PathFormat
kmsKeyArn :: Maybe Text
$sel:transcriptFormat:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> TranscriptFormat
$sel:s3BucketName:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> Text
$sel:transcriptFilter:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> Maybe TranscriptFilter
$sel:pathFormat:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> Maybe PathFormat
$sel:kmsKeyArn:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
kmsKeyArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe PathFormat
pathFormat
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe TranscriptFilter
transcriptFilter
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
s3BucketName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf TranscriptFormat
transcriptFormat

instance Data.ToJSON S3BucketTranscriptSource where
  toJSON :: S3BucketTranscriptSource -> Value
toJSON S3BucketTranscriptSource' {Maybe Text
Maybe PathFormat
Maybe TranscriptFilter
Text
TranscriptFormat
transcriptFormat :: TranscriptFormat
s3BucketName :: Text
transcriptFilter :: Maybe TranscriptFilter
pathFormat :: Maybe PathFormat
kmsKeyArn :: Maybe Text
$sel:transcriptFormat:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> TranscriptFormat
$sel:s3BucketName:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> Text
$sel:transcriptFilter:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> Maybe TranscriptFilter
$sel:pathFormat:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> Maybe PathFormat
$sel:kmsKeyArn:S3BucketTranscriptSource' :: S3BucketTranscriptSource -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"kmsKeyArn" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
kmsKeyArn,
            (Key
"pathFormat" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe PathFormat
pathFormat,
            (Key
"transcriptFilter" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe TranscriptFilter
transcriptFilter,
            forall a. a -> Maybe a
Prelude.Just (Key
"s3BucketName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
s3BucketName),
            forall a. a -> Maybe a
Prelude.Just
              (Key
"transcriptFormat" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= TranscriptFormat
transcriptFormat)
          ]
      )