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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.

For an example of adding a thesaurus file to an index, see Adding custom synonyms to an index.

Synopsis

data CreateThesaurus = CreateThesaurus' {
- clientToken :: Maybe Text
- description :: Maybe Text
- tags :: Maybe [Tag]
- indexId :: Text
- name :: Text
- roleArn :: Text
- sourceS3Path :: S3Path
}
newCreateThesaurus :: Text -> Text -> Text -> S3Path -> CreateThesaurus
createThesaurus_clientToken :: Lens' CreateThesaurus (Maybe Text)
createThesaurus_description :: Lens' CreateThesaurus (Maybe Text)
createThesaurus_tags :: Lens' CreateThesaurus (Maybe [Tag])
createThesaurus_indexId :: Lens' CreateThesaurus Text
createThesaurus_name :: Lens' CreateThesaurus Text
createThesaurus_roleArn :: Lens' CreateThesaurus Text
createThesaurus_sourceS3Path :: Lens' CreateThesaurus S3Path
data CreateThesaurusResponse = CreateThesaurusResponse' {
- id :: Maybe Text
- httpStatus :: Int
}
newCreateThesaurusResponse :: Int -> CreateThesaurusResponse
createThesaurusResponse_id :: Lens' CreateThesaurusResponse (Maybe Text)
createThesaurusResponse_httpStatus :: Lens' CreateThesaurusResponse Int

Creating a Request

data CreateThesaurus Source #

See: newCreateThesaurus smart constructor.

Constructors

CreateThesaurus'

Fields

clientToken :: Maybe Text
A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus API with the same client token will create only one thesaurus.
description :: Maybe Text
A description for the thesaurus.
tags :: Maybe [Tag]
A list of key-value pairs that identify the thesaurus. 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 thesaurus.
name :: Text
A name for the thesaurus.
roleArn :: Text
An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.
sourceS3Path :: S3Path
The path to the thesaurus file in S3.

Instances

Instances details

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

newCreateThesaurus Source #

Arguments

:: Text	`$sel:indexId:CreateThesaurus'`
-> Text	`CreateThesaurus`
-> Text	`CreateThesaurus`
-> S3Path	`$sel:sourceS3Path:CreateThesaurus'`
-> CreateThesaurus

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

$sel:description:CreateThesaurus', createThesaurus_description - A description for the thesaurus.

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

$sel:indexId:CreateThesaurus', createThesaurus_indexId - The identifier of the index for the thesaurus.

CreateThesaurus, createThesaurus_name - A name for the thesaurus.

CreateThesaurus, createThesaurus_roleArn - An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

$sel:sourceS3Path:CreateThesaurus', createThesaurus_sourceS3Path - The path to the thesaurus file in S3.

Request Lenses

createThesaurus_clientToken :: Lens' CreateThesaurus (Maybe Text) Source #

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

createThesaurus_description :: Lens' CreateThesaurus (Maybe Text) Source #

A description for the thesaurus.

createThesaurus_tags :: Lens' CreateThesaurus (Maybe [Tag]) Source #

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

createThesaurus_indexId :: Lens' CreateThesaurus Text Source #

The identifier of the index for the thesaurus.

createThesaurus_name :: Lens' CreateThesaurus Text Source #

A name for the thesaurus.

createThesaurus_roleArn :: Lens' CreateThesaurus Text Source #

An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

createThesaurus_sourceS3Path :: Lens' CreateThesaurus S3Path Source #

The path to the thesaurus file in S3.

Destructuring the Response

data CreateThesaurusResponse Source #

See: newCreateThesaurusResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateThesaurusResponse Source #

Arguments

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

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

CreateThesaurusResponse, createThesaurusResponse_id - The identifier of the thesaurus.

$sel:httpStatus:CreateThesaurusResponse', createThesaurusResponse_httpStatus - The response's http status code.

Response Lenses

createThesaurusResponse_id :: Lens' CreateThesaurusResponse (Maybe Text) Source #

The identifier of the thesaurus.

createThesaurusResponse_httpStatus :: Lens' CreateThesaurusResponse Int Source #

The response's http status code.