{-# 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.Kendra.DescribeFaq
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Gets information about an FAQ list.
module Amazonka.Kendra.DescribeFaq
  ( -- * Creating a Request
    DescribeFaq (..),
    newDescribeFaq,

    -- * Request Lenses
    describeFaq_id,
    describeFaq_indexId,

    -- * Destructuring the Response
    DescribeFaqResponse (..),
    newDescribeFaqResponse,

    -- * Response Lenses
    describeFaqResponse_createdAt,
    describeFaqResponse_description,
    describeFaqResponse_errorMessage,
    describeFaqResponse_fileFormat,
    describeFaqResponse_id,
    describeFaqResponse_indexId,
    describeFaqResponse_languageCode,
    describeFaqResponse_name,
    describeFaqResponse_roleArn,
    describeFaqResponse_s3Path,
    describeFaqResponse_status,
    describeFaqResponse_updatedAt,
    describeFaqResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Kendra.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newDescribeFaq' smart constructor.
data DescribeFaq = DescribeFaq'
  { -- | The identifier of the FAQ you want to get information on.
    DescribeFaq -> Text
id :: Prelude.Text,
    -- | The identifier of the index for the FAQ.
    DescribeFaq -> Text
indexId :: Prelude.Text
  }
  deriving (DescribeFaq -> DescribeFaq -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeFaq -> DescribeFaq -> Bool
$c/= :: DescribeFaq -> DescribeFaq -> Bool
== :: DescribeFaq -> DescribeFaq -> Bool
$c== :: DescribeFaq -> DescribeFaq -> Bool
Prelude.Eq, ReadPrec [DescribeFaq]
ReadPrec DescribeFaq
Int -> ReadS DescribeFaq
ReadS [DescribeFaq]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeFaq]
$creadListPrec :: ReadPrec [DescribeFaq]
readPrec :: ReadPrec DescribeFaq
$creadPrec :: ReadPrec DescribeFaq
readList :: ReadS [DescribeFaq]
$creadList :: ReadS [DescribeFaq]
readsPrec :: Int -> ReadS DescribeFaq
$creadsPrec :: Int -> ReadS DescribeFaq
Prelude.Read, Int -> DescribeFaq -> ShowS
[DescribeFaq] -> ShowS
DescribeFaq -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeFaq] -> ShowS
$cshowList :: [DescribeFaq] -> ShowS
show :: DescribeFaq -> String
$cshow :: DescribeFaq -> String
showsPrec :: Int -> DescribeFaq -> ShowS
$cshowsPrec :: Int -> DescribeFaq -> ShowS
Prelude.Show, forall x. Rep DescribeFaq x -> DescribeFaq
forall x. DescribeFaq -> Rep DescribeFaq x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeFaq x -> DescribeFaq
$cfrom :: forall x. DescribeFaq -> Rep DescribeFaq x
Prelude.Generic)

-- |
-- Create a value of 'DescribeFaq' 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:
--
-- 'id', 'describeFaq_id' - The identifier of the FAQ you want to get information on.
--
-- 'indexId', 'describeFaq_indexId' - The identifier of the index for the FAQ.
newDescribeFaq ::
  -- | 'id'
  Prelude.Text ->
  -- | 'indexId'
  Prelude.Text ->
  DescribeFaq
newDescribeFaq :: Text -> Text -> DescribeFaq
newDescribeFaq Text
pId_ Text
pIndexId_ =
  DescribeFaq' {$sel:id:DescribeFaq' :: Text
id = Text
pId_, $sel:indexId:DescribeFaq' :: Text
indexId = Text
pIndexId_}

-- | The identifier of the FAQ you want to get information on.
describeFaq_id :: Lens.Lens' DescribeFaq Prelude.Text
describeFaq_id :: Lens' DescribeFaq Text
describeFaq_id = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFaq' {Text
id :: Text
$sel:id:DescribeFaq' :: DescribeFaq -> Text
id} -> Text
id) (\s :: DescribeFaq
s@DescribeFaq' {} Text
a -> DescribeFaq
s {$sel:id:DescribeFaq' :: Text
id = Text
a} :: DescribeFaq)

-- | The identifier of the index for the FAQ.
describeFaq_indexId :: Lens.Lens' DescribeFaq Prelude.Text
describeFaq_indexId :: Lens' DescribeFaq Text
describeFaq_indexId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFaq' {Text
indexId :: Text
$sel:indexId:DescribeFaq' :: DescribeFaq -> Text
indexId} -> Text
indexId) (\s :: DescribeFaq
s@DescribeFaq' {} Text
a -> DescribeFaq
s {$sel:indexId:DescribeFaq' :: Text
indexId = Text
a} :: DescribeFaq)

instance Core.AWSRequest DescribeFaq where
  type AWSResponse DescribeFaq = DescribeFaqResponse
  request :: (Service -> Service) -> DescribeFaq -> Request DescribeFaq
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy DescribeFaq
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeFaq)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe POSIX
-> Maybe Text
-> Maybe Text
-> Maybe FaqFileFormat
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe S3Path
-> Maybe FaqStatus
-> Maybe POSIX
-> Int
-> DescribeFaqResponse
DescribeFaqResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"CreatedAt")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"Description")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"ErrorMessage")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"FileFormat")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"Id")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"IndexId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"LanguageCode")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"Name")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"RoleArn")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"S3Path")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"Status")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"UpdatedAt")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable DescribeFaq where
  hashWithSalt :: Int -> DescribeFaq -> Int
hashWithSalt Int
_salt DescribeFaq' {Text
indexId :: Text
id :: Text
$sel:indexId:DescribeFaq' :: DescribeFaq -> Text
$sel:id:DescribeFaq' :: DescribeFaq -> Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
id
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
indexId

instance Prelude.NFData DescribeFaq where
  rnf :: DescribeFaq -> ()
rnf DescribeFaq' {Text
indexId :: Text
id :: Text
$sel:indexId:DescribeFaq' :: DescribeFaq -> Text
$sel:id:DescribeFaq' :: DescribeFaq -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
id seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
indexId

instance Data.ToHeaders DescribeFaq where
  toHeaders :: DescribeFaq -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"AWSKendraFrontendService.DescribeFaq" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON DescribeFaq where
  toJSON :: DescribeFaq -> Value
toJSON DescribeFaq' {Text
indexId :: Text
id :: Text
$sel:indexId:DescribeFaq' :: DescribeFaq -> Text
$sel:id:DescribeFaq' :: DescribeFaq -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just (Key
"Id" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
id),
            forall a. a -> Maybe a
Prelude.Just (Key
"IndexId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
indexId)
          ]
      )

instance Data.ToPath DescribeFaq where
  toPath :: DescribeFaq -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery DescribeFaq where
  toQuery :: DescribeFaq -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newDescribeFaqResponse' smart constructor.
data DescribeFaqResponse = DescribeFaqResponse'
  { -- | The date and time that the FAQ was created.
    DescribeFaqResponse -> Maybe POSIX
createdAt :: Prelude.Maybe Data.POSIX,
    -- | The description of the FAQ that you provided when it was created.
    DescribeFaqResponse -> Maybe Text
description :: Prelude.Maybe Prelude.Text,
    -- | If the @Status@ field is @FAILED@, the @ErrorMessage@ field contains the
    -- reason why the FAQ failed.
    DescribeFaqResponse -> Maybe Text
errorMessage :: Prelude.Maybe Prelude.Text,
    -- | The file format used by the input files for the FAQ.
    DescribeFaqResponse -> Maybe FaqFileFormat
fileFormat :: Prelude.Maybe FaqFileFormat,
    -- | The identifier of the FAQ.
    DescribeFaqResponse -> Maybe Text
id :: Prelude.Maybe Prelude.Text,
    -- | The identifier of the index for the FAQ.
    DescribeFaqResponse -> Maybe Text
indexId :: Prelude.Maybe Prelude.Text,
    -- | The code for a language. This shows a supported language for the FAQ
    -- document. English is supported by default. For more information on
    -- supported languages, including their codes, see
    -- <https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html Adding documents in languages other than English>.
    DescribeFaqResponse -> Maybe Text
languageCode :: Prelude.Maybe Prelude.Text,
    -- | The name that you gave the FAQ when it was created.
    DescribeFaqResponse -> Maybe Text
name :: Prelude.Maybe Prelude.Text,
    -- | The Amazon Resource Name (ARN) of the role that provides access to the
    -- S3 bucket containing the input files for the FAQ.
    DescribeFaqResponse -> Maybe Text
roleArn :: Prelude.Maybe Prelude.Text,
    DescribeFaqResponse -> Maybe S3Path
s3Path :: Prelude.Maybe S3Path,
    -- | The status of the FAQ. It is ready to use when the status is @ACTIVE@.
    DescribeFaqResponse -> Maybe FaqStatus
status :: Prelude.Maybe FaqStatus,
    -- | The date and time that the FAQ was last updated.
    DescribeFaqResponse -> Maybe POSIX
updatedAt :: Prelude.Maybe Data.POSIX,
    -- | The response's http status code.
    DescribeFaqResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeFaqResponse -> DescribeFaqResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeFaqResponse -> DescribeFaqResponse -> Bool
$c/= :: DescribeFaqResponse -> DescribeFaqResponse -> Bool
== :: DescribeFaqResponse -> DescribeFaqResponse -> Bool
$c== :: DescribeFaqResponse -> DescribeFaqResponse -> Bool
Prelude.Eq, ReadPrec [DescribeFaqResponse]
ReadPrec DescribeFaqResponse
Int -> ReadS DescribeFaqResponse
ReadS [DescribeFaqResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeFaqResponse]
$creadListPrec :: ReadPrec [DescribeFaqResponse]
readPrec :: ReadPrec DescribeFaqResponse
$creadPrec :: ReadPrec DescribeFaqResponse
readList :: ReadS [DescribeFaqResponse]
$creadList :: ReadS [DescribeFaqResponse]
readsPrec :: Int -> ReadS DescribeFaqResponse
$creadsPrec :: Int -> ReadS DescribeFaqResponse
Prelude.Read, Int -> DescribeFaqResponse -> ShowS
[DescribeFaqResponse] -> ShowS
DescribeFaqResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeFaqResponse] -> ShowS
$cshowList :: [DescribeFaqResponse] -> ShowS
show :: DescribeFaqResponse -> String
$cshow :: DescribeFaqResponse -> String
showsPrec :: Int -> DescribeFaqResponse -> ShowS
$cshowsPrec :: Int -> DescribeFaqResponse -> ShowS
Prelude.Show, forall x. Rep DescribeFaqResponse x -> DescribeFaqResponse
forall x. DescribeFaqResponse -> Rep DescribeFaqResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeFaqResponse x -> DescribeFaqResponse
$cfrom :: forall x. DescribeFaqResponse -> Rep DescribeFaqResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeFaqResponse' 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:
--
-- 'createdAt', 'describeFaqResponse_createdAt' - The date and time that the FAQ was created.
--
-- 'description', 'describeFaqResponse_description' - The description of the FAQ that you provided when it was created.
--
-- 'errorMessage', 'describeFaqResponse_errorMessage' - If the @Status@ field is @FAILED@, the @ErrorMessage@ field contains the
-- reason why the FAQ failed.
--
-- 'fileFormat', 'describeFaqResponse_fileFormat' - The file format used by the input files for the FAQ.
--
-- 'id', 'describeFaqResponse_id' - The identifier of the FAQ.
--
-- 'indexId', 'describeFaqResponse_indexId' - The identifier of the index for the FAQ.
--
-- 'languageCode', 'describeFaqResponse_languageCode' - The code for a language. This shows a supported language for the FAQ
-- document. English is supported by default. For more information on
-- supported languages, including their codes, see
-- <https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html Adding documents in languages other than English>.
--
-- 'name', 'describeFaqResponse_name' - The name that you gave the FAQ when it was created.
--
-- 'roleArn', 'describeFaqResponse_roleArn' - The Amazon Resource Name (ARN) of the role that provides access to the
-- S3 bucket containing the input files for the FAQ.
--
-- 's3Path', 'describeFaqResponse_s3Path' - Undocumented member.
--
-- 'status', 'describeFaqResponse_status' - The status of the FAQ. It is ready to use when the status is @ACTIVE@.
--
-- 'updatedAt', 'describeFaqResponse_updatedAt' - The date and time that the FAQ was last updated.
--
-- 'httpStatus', 'describeFaqResponse_httpStatus' - The response's http status code.
newDescribeFaqResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeFaqResponse
newDescribeFaqResponse :: Int -> DescribeFaqResponse
newDescribeFaqResponse Int
pHttpStatus_ =
  DescribeFaqResponse'
    { $sel:createdAt:DescribeFaqResponse' :: Maybe POSIX
createdAt = forall a. Maybe a
Prelude.Nothing,
      $sel:description:DescribeFaqResponse' :: Maybe Text
description = forall a. Maybe a
Prelude.Nothing,
      $sel:errorMessage:DescribeFaqResponse' :: Maybe Text
errorMessage = forall a. Maybe a
Prelude.Nothing,
      $sel:fileFormat:DescribeFaqResponse' :: Maybe FaqFileFormat
fileFormat = forall a. Maybe a
Prelude.Nothing,
      $sel:id:DescribeFaqResponse' :: Maybe Text
id = forall a. Maybe a
Prelude.Nothing,
      $sel:indexId:DescribeFaqResponse' :: Maybe Text
indexId = forall a. Maybe a
Prelude.Nothing,
      $sel:languageCode:DescribeFaqResponse' :: Maybe Text
languageCode = forall a. Maybe a
Prelude.Nothing,
      $sel:name:DescribeFaqResponse' :: Maybe Text
name = forall a. Maybe a
Prelude.Nothing,
      $sel:roleArn:DescribeFaqResponse' :: Maybe Text
roleArn = forall a. Maybe a
Prelude.Nothing,
      $sel:s3Path:DescribeFaqResponse' :: Maybe S3Path
s3Path = forall a. Maybe a
Prelude.Nothing,
      $sel:status:DescribeFaqResponse' :: Maybe FaqStatus
status = forall a. Maybe a
Prelude.Nothing,
      $sel:updatedAt:DescribeFaqResponse' :: Maybe POSIX
updatedAt = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeFaqResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The date and time that the FAQ was created.
describeFaqResponse_createdAt :: Lens.Lens' DescribeFaqResponse (Prelude.Maybe Prelude.UTCTime)
describeFaqResponse_createdAt :: Lens' DescribeFaqResponse (Maybe UTCTime)
describeFaqResponse_createdAt = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFaqResponse' {Maybe POSIX
createdAt :: Maybe POSIX
$sel:createdAt:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe POSIX
createdAt} -> Maybe POSIX
createdAt) (\s :: DescribeFaqResponse
s@DescribeFaqResponse' {} Maybe POSIX
a -> DescribeFaqResponse
s {$sel:createdAt:DescribeFaqResponse' :: Maybe POSIX
createdAt = Maybe POSIX
a} :: DescribeFaqResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | The description of the FAQ that you provided when it was created.
describeFaqResponse_description :: Lens.Lens' DescribeFaqResponse (Prelude.Maybe Prelude.Text)
describeFaqResponse_description :: Lens' DescribeFaqResponse (Maybe Text)
describeFaqResponse_description = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFaqResponse' {Maybe Text
description :: Maybe Text
$sel:description:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe Text
description} -> Maybe Text
description) (\s :: DescribeFaqResponse
s@DescribeFaqResponse' {} Maybe Text
a -> DescribeFaqResponse
s {$sel:description:DescribeFaqResponse' :: Maybe Text
description = Maybe Text
a} :: DescribeFaqResponse)

-- | If the @Status@ field is @FAILED@, the @ErrorMessage@ field contains the
-- reason why the FAQ failed.
describeFaqResponse_errorMessage :: Lens.Lens' DescribeFaqResponse (Prelude.Maybe Prelude.Text)
describeFaqResponse_errorMessage :: Lens' DescribeFaqResponse (Maybe Text)
describeFaqResponse_errorMessage = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFaqResponse' {Maybe Text
errorMessage :: Maybe Text
$sel:errorMessage:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe Text
errorMessage} -> Maybe Text
errorMessage) (\s :: DescribeFaqResponse
s@DescribeFaqResponse' {} Maybe Text
a -> DescribeFaqResponse
s {$sel:errorMessage:DescribeFaqResponse' :: Maybe Text
errorMessage = Maybe Text
a} :: DescribeFaqResponse)

-- | The file format used by the input files for the FAQ.
describeFaqResponse_fileFormat :: Lens.Lens' DescribeFaqResponse (Prelude.Maybe FaqFileFormat)
describeFaqResponse_fileFormat :: Lens' DescribeFaqResponse (Maybe FaqFileFormat)
describeFaqResponse_fileFormat = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFaqResponse' {Maybe FaqFileFormat
fileFormat :: Maybe FaqFileFormat
$sel:fileFormat:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe FaqFileFormat
fileFormat} -> Maybe FaqFileFormat
fileFormat) (\s :: DescribeFaqResponse
s@DescribeFaqResponse' {} Maybe FaqFileFormat
a -> DescribeFaqResponse
s {$sel:fileFormat:DescribeFaqResponse' :: Maybe FaqFileFormat
fileFormat = Maybe FaqFileFormat
a} :: DescribeFaqResponse)

-- | The identifier of the FAQ.
describeFaqResponse_id :: Lens.Lens' DescribeFaqResponse (Prelude.Maybe Prelude.Text)
describeFaqResponse_id :: Lens' DescribeFaqResponse (Maybe Text)
describeFaqResponse_id = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFaqResponse' {Maybe Text
id :: Maybe Text
$sel:id:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe Text
id} -> Maybe Text
id) (\s :: DescribeFaqResponse
s@DescribeFaqResponse' {} Maybe Text
a -> DescribeFaqResponse
s {$sel:id:DescribeFaqResponse' :: Maybe Text
id = Maybe Text
a} :: DescribeFaqResponse)

-- | The identifier of the index for the FAQ.
describeFaqResponse_indexId :: Lens.Lens' DescribeFaqResponse (Prelude.Maybe Prelude.Text)
describeFaqResponse_indexId :: Lens' DescribeFaqResponse (Maybe Text)
describeFaqResponse_indexId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFaqResponse' {Maybe Text
indexId :: Maybe Text
$sel:indexId:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe Text
indexId} -> Maybe Text
indexId) (\s :: DescribeFaqResponse
s@DescribeFaqResponse' {} Maybe Text
a -> DescribeFaqResponse
s {$sel:indexId:DescribeFaqResponse' :: Maybe Text
indexId = Maybe Text
a} :: DescribeFaqResponse)

-- | The code for a language. This shows a supported language for the FAQ
-- document. English is supported by default. For more information on
-- supported languages, including their codes, see
-- <https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html Adding documents in languages other than English>.
describeFaqResponse_languageCode :: Lens.Lens' DescribeFaqResponse (Prelude.Maybe Prelude.Text)
describeFaqResponse_languageCode :: Lens' DescribeFaqResponse (Maybe Text)
describeFaqResponse_languageCode = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFaqResponse' {Maybe Text
languageCode :: Maybe Text
$sel:languageCode:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe Text
languageCode} -> Maybe Text
languageCode) (\s :: DescribeFaqResponse
s@DescribeFaqResponse' {} Maybe Text
a -> DescribeFaqResponse
s {$sel:languageCode:DescribeFaqResponse' :: Maybe Text
languageCode = Maybe Text
a} :: DescribeFaqResponse)

-- | The name that you gave the FAQ when it was created.
describeFaqResponse_name :: Lens.Lens' DescribeFaqResponse (Prelude.Maybe Prelude.Text)
describeFaqResponse_name :: Lens' DescribeFaqResponse (Maybe Text)
describeFaqResponse_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFaqResponse' {Maybe Text
name :: Maybe Text
$sel:name:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe Text
name} -> Maybe Text
name) (\s :: DescribeFaqResponse
s@DescribeFaqResponse' {} Maybe Text
a -> DescribeFaqResponse
s {$sel:name:DescribeFaqResponse' :: Maybe Text
name = Maybe Text
a} :: DescribeFaqResponse)

-- | The Amazon Resource Name (ARN) of the role that provides access to the
-- S3 bucket containing the input files for the FAQ.
describeFaqResponse_roleArn :: Lens.Lens' DescribeFaqResponse (Prelude.Maybe Prelude.Text)
describeFaqResponse_roleArn :: Lens' DescribeFaqResponse (Maybe Text)
describeFaqResponse_roleArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFaqResponse' {Maybe Text
roleArn :: Maybe Text
$sel:roleArn:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe Text
roleArn} -> Maybe Text
roleArn) (\s :: DescribeFaqResponse
s@DescribeFaqResponse' {} Maybe Text
a -> DescribeFaqResponse
s {$sel:roleArn:DescribeFaqResponse' :: Maybe Text
roleArn = Maybe Text
a} :: DescribeFaqResponse)

-- | Undocumented member.
describeFaqResponse_s3Path :: Lens.Lens' DescribeFaqResponse (Prelude.Maybe S3Path)
describeFaqResponse_s3Path :: Lens' DescribeFaqResponse (Maybe S3Path)
describeFaqResponse_s3Path = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFaqResponse' {Maybe S3Path
s3Path :: Maybe S3Path
$sel:s3Path:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe S3Path
s3Path} -> Maybe S3Path
s3Path) (\s :: DescribeFaqResponse
s@DescribeFaqResponse' {} Maybe S3Path
a -> DescribeFaqResponse
s {$sel:s3Path:DescribeFaqResponse' :: Maybe S3Path
s3Path = Maybe S3Path
a} :: DescribeFaqResponse)

-- | The status of the FAQ. It is ready to use when the status is @ACTIVE@.
describeFaqResponse_status :: Lens.Lens' DescribeFaqResponse (Prelude.Maybe FaqStatus)
describeFaqResponse_status :: Lens' DescribeFaqResponse (Maybe FaqStatus)
describeFaqResponse_status = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFaqResponse' {Maybe FaqStatus
status :: Maybe FaqStatus
$sel:status:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe FaqStatus
status} -> Maybe FaqStatus
status) (\s :: DescribeFaqResponse
s@DescribeFaqResponse' {} Maybe FaqStatus
a -> DescribeFaqResponse
s {$sel:status:DescribeFaqResponse' :: Maybe FaqStatus
status = Maybe FaqStatus
a} :: DescribeFaqResponse)

-- | The date and time that the FAQ was last updated.
describeFaqResponse_updatedAt :: Lens.Lens' DescribeFaqResponse (Prelude.Maybe Prelude.UTCTime)
describeFaqResponse_updatedAt :: Lens' DescribeFaqResponse (Maybe UTCTime)
describeFaqResponse_updatedAt = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFaqResponse' {Maybe POSIX
updatedAt :: Maybe POSIX
$sel:updatedAt:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe POSIX
updatedAt} -> Maybe POSIX
updatedAt) (\s :: DescribeFaqResponse
s@DescribeFaqResponse' {} Maybe POSIX
a -> DescribeFaqResponse
s {$sel:updatedAt:DescribeFaqResponse' :: Maybe POSIX
updatedAt = Maybe POSIX
a} :: DescribeFaqResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | The response's http status code.
describeFaqResponse_httpStatus :: Lens.Lens' DescribeFaqResponse Prelude.Int
describeFaqResponse_httpStatus :: Lens' DescribeFaqResponse Int
describeFaqResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeFaqResponse' {Int
httpStatus :: Int
$sel:httpStatus:DescribeFaqResponse' :: DescribeFaqResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: DescribeFaqResponse
s@DescribeFaqResponse' {} Int
a -> DescribeFaqResponse
s {$sel:httpStatus:DescribeFaqResponse' :: Int
httpStatus = Int
a} :: DescribeFaqResponse)

instance Prelude.NFData DescribeFaqResponse where
  rnf :: DescribeFaqResponse -> ()
rnf DescribeFaqResponse' {Int
Maybe Text
Maybe POSIX
Maybe FaqFileFormat
Maybe FaqStatus
Maybe S3Path
httpStatus :: Int
updatedAt :: Maybe POSIX
status :: Maybe FaqStatus
s3Path :: Maybe S3Path
roleArn :: Maybe Text
name :: Maybe Text
languageCode :: Maybe Text
indexId :: Maybe Text
id :: Maybe Text
fileFormat :: Maybe FaqFileFormat
errorMessage :: Maybe Text
description :: Maybe Text
createdAt :: Maybe POSIX
$sel:httpStatus:DescribeFaqResponse' :: DescribeFaqResponse -> Int
$sel:updatedAt:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe POSIX
$sel:status:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe FaqStatus
$sel:s3Path:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe S3Path
$sel:roleArn:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe Text
$sel:name:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe Text
$sel:languageCode:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe Text
$sel:indexId:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe Text
$sel:id:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe Text
$sel:fileFormat:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe FaqFileFormat
$sel:errorMessage:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe Text
$sel:description:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe Text
$sel:createdAt:DescribeFaqResponse' :: DescribeFaqResponse -> Maybe POSIX
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
createdAt
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
description
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
errorMessage
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe FaqFileFormat
fileFormat
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
id
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
indexId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
languageCode
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
roleArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe S3Path
s3Path
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe FaqStatus
status
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
updatedAt
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus