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 |
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' {}
- 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.
CreateThesaurus' | |
|
Instances
:: Text | |
-> Text | |
-> Text | |
-> S3Path | |
-> 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.
CreateThesaurusResponse' | |
|
Instances
newCreateThesaurusResponse Source #
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.