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.CreateFaq

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an new set of frequently asked question (FAQ) questions and answers.

Adding FAQs to an index is an asynchronous operation.

For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.

Synopsis

data CreateFaq = CreateFaq' {
- clientToken :: Maybe Text
- description :: Maybe Text
- fileFormat :: Maybe FaqFileFormat
- languageCode :: Maybe Text
- tags :: Maybe [Tag]
- indexId :: Text
- name :: Text
- s3Path :: S3Path
- roleArn :: Text
}
newCreateFaq :: Text -> Text -> S3Path -> Text -> CreateFaq
createFaq_clientToken :: Lens' CreateFaq (Maybe Text)
createFaq_description :: Lens' CreateFaq (Maybe Text)
createFaq_fileFormat :: Lens' CreateFaq (Maybe FaqFileFormat)
createFaq_languageCode :: Lens' CreateFaq (Maybe Text)
createFaq_tags :: Lens' CreateFaq (Maybe [Tag])
createFaq_indexId :: Lens' CreateFaq Text
createFaq_name :: Lens' CreateFaq Text
createFaq_s3Path :: Lens' CreateFaq S3Path
createFaq_roleArn :: Lens' CreateFaq Text
data CreateFaqResponse = CreateFaqResponse' {
- id :: Maybe Text
- httpStatus :: Int
}
newCreateFaqResponse :: Int -> CreateFaqResponse
createFaqResponse_id :: Lens' CreateFaqResponse (Maybe Text)
createFaqResponse_httpStatus :: Lens' CreateFaqResponse Int

Creating a Request

data CreateFaq Source #

See: newCreateFaq smart constructor.

Constructors

CreateFaq'

Fields

clientToken :: Maybe Text
A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.
description :: Maybe Text
A description for the FAQ.
fileFormat :: Maybe FaqFileFormat
The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.
The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.
For more information, see Adding questions and answers.
languageCode :: Maybe Text
The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
tags :: Maybe [Tag]
A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.
indexId :: Text
The identifier of the index for the FAQ.
name :: Text
A name for the FAQ.
s3Path :: S3Path
The path to the FAQ file in S3.
roleArn :: Text
The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

Instances

Instances details

ToJSON CreateFaq Source #
Instance details Defined in Amazonka.Kendra.CreateFaq Methods toJSON :: CreateFaq -> Value # toEncoding :: CreateFaq -> Encoding # toJSONList :: [CreateFaq] -> Value # toEncodingList :: [CreateFaq] -> Encoding #
ToHeaders CreateFaq Source #
Instance details Defined in Amazonka.Kendra.CreateFaq Methods toHeaders :: CreateFaq -> [Header] #
ToPath CreateFaq Source #
Instance details Defined in Amazonka.Kendra.CreateFaq Methods toPath :: CreateFaq -> ByteString #
ToQuery CreateFaq Source #
Instance details Defined in Amazonka.Kendra.CreateFaq Methods toQuery :: CreateFaq -> QueryString #
AWSRequest CreateFaq Source #
Instance details Defined in Amazonka.Kendra.CreateFaq Associated Types type AWSResponse CreateFaq # Methods request :: (Service -> Service) -> CreateFaq -> Request CreateFaq # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateFaq -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateFaq))) #
Generic CreateFaq Source #
Instance details Defined in Amazonka.Kendra.CreateFaq Associated Types type Rep CreateFaq :: Type -> Type # Methods from :: CreateFaq -> Rep CreateFaq x # to :: Rep CreateFaq x -> CreateFaq #
Read CreateFaq Source #
Instance details Defined in Amazonka.Kendra.CreateFaq Methods readsPrec :: Int -> ReadS CreateFaq # readList :: ReadS [CreateFaq] # readPrec :: ReadPrec CreateFaq # readListPrec :: ReadPrec [CreateFaq] #
Show CreateFaq Source #
Instance details Defined in Amazonka.Kendra.CreateFaq Methods showsPrec :: Int -> CreateFaq -> ShowS # show :: CreateFaq -> String # showList :: [CreateFaq] -> ShowS #
NFData CreateFaq Source #
Instance details Defined in Amazonka.Kendra.CreateFaq Methods rnf :: CreateFaq -> () #
Eq CreateFaq Source #
Instance details Defined in Amazonka.Kendra.CreateFaq Methods (==) :: CreateFaq -> CreateFaq -> Bool # (/=) :: CreateFaq -> CreateFaq -> Bool #
Hashable CreateFaq Source #
Instance details Defined in Amazonka.Kendra.CreateFaq Methods hashWithSalt :: Int -> CreateFaq -> Int # hash :: CreateFaq -> Int #
type AWSResponse CreateFaq Source #
Instance details Defined in Amazonka.Kendra.CreateFaq type AWSResponse CreateFaq = CreateFaqResponse
type Rep CreateFaq Source #
Instance details Defined in Amazonka.Kendra.CreateFaq type Rep CreateFaq = D1 ('MetaData "CreateFaq" "Amazonka.Kendra.CreateFaq" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CreateFaq'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "fileFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FaqFileFormat)) :: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "s3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3Path) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateFaq Source #

Arguments

:: Text	`$sel:indexId:CreateFaq'`
-> Text	`CreateFaq`
-> S3Path	`CreateFaq`
-> Text	`CreateFaq`
-> CreateFaq

Create a value of CreateFaq 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:clientToken:CreateFaq', createFaq_clientToken - A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.

$sel:description:CreateFaq', createFaq_description - A description for the FAQ.

CreateFaq, createFaq_fileFormat - The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

CreateFaq, createFaq_languageCode - The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

$sel:tags:CreateFaq', createFaq_tags - A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

$sel:indexId:CreateFaq', createFaq_indexId - The identifier of the index for the FAQ.

CreateFaq, createFaq_name - A name for the FAQ.

CreateFaq, createFaq_s3Path - The path to the FAQ file in S3.

CreateFaq, createFaq_roleArn - The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

Request Lenses

createFaq_clientToken :: Lens' CreateFaq (Maybe Text) Source #

A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.

createFaq_description :: Lens' CreateFaq (Maybe Text) Source #

A description for the FAQ.

createFaq_fileFormat :: Lens' CreateFaq (Maybe FaqFileFormat) Source #

The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

createFaq_languageCode :: Lens' CreateFaq (Maybe Text) Source #

The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

createFaq_tags :: Lens' CreateFaq (Maybe [Tag]) Source #

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

createFaq_indexId :: Lens' CreateFaq Text Source #

The identifier of the index for the FAQ.

createFaq_name :: Lens' CreateFaq Text Source #

A name for the FAQ.

createFaq_s3Path :: Lens' CreateFaq S3Path Source #

The path to the FAQ file in S3.

createFaq_roleArn :: Lens' CreateFaq Text Source #

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

Destructuring the Response

data CreateFaqResponse Source #

See: newCreateFaqResponse smart constructor.

Constructors

CreateFaqResponse'
Fields id :: Maybe Text The identifier of the FAQ. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateFaqResponse Source #
Instance details Defined in Amazonka.Kendra.CreateFaq Associated Types type Rep CreateFaqResponse :: Type -> Type # Methods from :: CreateFaqResponse -> Rep CreateFaqResponse x # to :: Rep CreateFaqResponse x -> CreateFaqResponse #
Read CreateFaqResponse Source #
Instance details Defined in Amazonka.Kendra.CreateFaq Methods readsPrec :: Int -> ReadS CreateFaqResponse # readList :: ReadS [CreateFaqResponse] # readPrec :: ReadPrec CreateFaqResponse # readListPrec :: ReadPrec [CreateFaqResponse] #
Show CreateFaqResponse Source #
Instance details Defined in Amazonka.Kendra.CreateFaq Methods showsPrec :: Int -> CreateFaqResponse -> ShowS # show :: CreateFaqResponse -> String # showList :: [CreateFaqResponse] -> ShowS #
NFData CreateFaqResponse Source #
Instance details Defined in Amazonka.Kendra.CreateFaq Methods rnf :: CreateFaqResponse -> () #
Eq CreateFaqResponse Source #
Instance details Defined in Amazonka.Kendra.CreateFaq Methods (==) :: CreateFaqResponse -> CreateFaqResponse -> Bool # (/=) :: CreateFaqResponse -> CreateFaqResponse -> Bool #
type Rep CreateFaqResponse Source #
Instance details Defined in Amazonka.Kendra.CreateFaq type Rep CreateFaqResponse = D1 ('MetaData "CreateFaqResponse" "Amazonka.Kendra.CreateFaq" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CreateFaqResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateFaqResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateFaqResponse'`
-> CreateFaqResponse

Create a value of CreateFaqResponse 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:

CreateFaqResponse, createFaqResponse_id - The identifier of the FAQ.

$sel:httpStatus:CreateFaqResponse', createFaqResponse_httpStatus - The response's http status code.

Response Lenses

createFaqResponse_id :: Lens' CreateFaqResponse (Maybe Text) Source #

The identifier of the FAQ.

createFaqResponse_httpStatus :: Lens' CreateFaqResponse Int Source #

The response's http status code.