Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.Types.FaqSummary

Description

Synopsis

data FaqSummary = FaqSummary' {
- createdAt :: Maybe POSIX
- fileFormat :: Maybe FaqFileFormat
- id :: Maybe Text
- languageCode :: Maybe Text
- name :: Maybe Text
- status :: Maybe FaqStatus
- updatedAt :: Maybe POSIX
}
newFaqSummary :: FaqSummary
faqSummary_createdAt :: Lens' FaqSummary (Maybe UTCTime)
faqSummary_fileFormat :: Lens' FaqSummary (Maybe FaqFileFormat)
faqSummary_id :: Lens' FaqSummary (Maybe Text)
faqSummary_languageCode :: Lens' FaqSummary (Maybe Text)
faqSummary_name :: Lens' FaqSummary (Maybe Text)
faqSummary_status :: Lens' FaqSummary (Maybe FaqStatus)
faqSummary_updatedAt :: Lens' FaqSummary (Maybe UTCTime)

Documentation

data FaqSummary Source #

Summary information for frequently asked questions and answers included in an index.

See: newFaqSummary smart constructor.

Constructors

FaqSummary'

Fields

createdAt :: Maybe POSIX
The UNIX datetime that the FAQ was added to the index.
fileFormat :: Maybe FaqFileFormat
The file type used to create the FAQ.
id :: Maybe Text
The identifier of the FAQ.
languageCode :: Maybe Text
The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
name :: Maybe Text
The name that you assigned the FAQ when you created or updated the FAQ.
status :: Maybe FaqStatus
The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.
updatedAt :: Maybe POSIX
The UNIX datetime that the FAQ was last updated.

Instances

Instances details

FromJSON FaqSummary Source #
Instance details Defined in Amazonka.Kendra.Types.FaqSummary Methods parseJSON :: Value -> Parser FaqSummary # parseJSONList :: Value -> Parser [FaqSummary] #
Generic FaqSummary Source #
Instance details Defined in Amazonka.Kendra.Types.FaqSummary Associated Types type Rep FaqSummary :: Type -> Type # Methods from :: FaqSummary -> Rep FaqSummary x # to :: Rep FaqSummary x -> FaqSummary #
Read FaqSummary Source #
Instance details Defined in Amazonka.Kendra.Types.FaqSummary Methods readsPrec :: Int -> ReadS FaqSummary # readList :: ReadS [FaqSummary] # readPrec :: ReadPrec FaqSummary # readListPrec :: ReadPrec [FaqSummary] #
Show FaqSummary Source #
Instance details Defined in Amazonka.Kendra.Types.FaqSummary Methods showsPrec :: Int -> FaqSummary -> ShowS # show :: FaqSummary -> String # showList :: [FaqSummary] -> ShowS #
NFData FaqSummary Source #
Instance details Defined in Amazonka.Kendra.Types.FaqSummary Methods rnf :: FaqSummary -> () #
Eq FaqSummary Source #
Instance details Defined in Amazonka.Kendra.Types.FaqSummary Methods (==) :: FaqSummary -> FaqSummary -> Bool # (/=) :: FaqSummary -> FaqSummary -> Bool #
Hashable FaqSummary Source #
Instance details Defined in Amazonka.Kendra.Types.FaqSummary Methods hashWithSalt :: Int -> FaqSummary -> Int # hash :: FaqSummary -> Int #
type Rep FaqSummary Source #
Instance details Defined in Amazonka.Kendra.Types.FaqSummary type Rep FaqSummary = D1 ('MetaData "FaqSummary" "Amazonka.Kendra.Types.FaqSummary" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "FaqSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "fileFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FaqFileFormat)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FaqStatus)) :: S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newFaqSummary :: FaqSummary Source #

Create a value of FaqSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createdAt:FaqSummary', faqSummary_createdAt - The UNIX datetime that the FAQ was added to the index.

$sel:fileFormat:FaqSummary', faqSummary_fileFormat - The file type used to create the FAQ.

$sel:id:FaqSummary', faqSummary_id - The identifier of the FAQ.

$sel:languageCode:FaqSummary', faqSummary_languageCode - The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

$sel:name:FaqSummary', faqSummary_name - The name that you assigned the FAQ when you created or updated the FAQ.

$sel:status:FaqSummary', faqSummary_status - The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.

$sel:updatedAt:FaqSummary', faqSummary_updatedAt - The UNIX datetime that the FAQ was last updated.

faqSummary_createdAt :: Lens' FaqSummary (Maybe UTCTime) Source #

The UNIX datetime that the FAQ was added to the index.

faqSummary_fileFormat :: Lens' FaqSummary (Maybe FaqFileFormat) Source #

The file type used to create the FAQ.

faqSummary_id :: Lens' FaqSummary (Maybe Text) Source #

The identifier of the FAQ.

faqSummary_languageCode :: Lens' FaqSummary (Maybe Text) Source #

The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

faqSummary_name :: Lens' FaqSummary (Maybe Text) Source #

The name that you assigned the FAQ when you created or updated the FAQ.

faqSummary_status :: Lens' FaqSummary (Maybe FaqStatus) Source #

The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.

faqSummary_updatedAt :: Lens' FaqSummary (Maybe UTCTime) Source #

The UNIX datetime that the FAQ was last updated.