# CreateThesaurus 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](https://docs.aws.amazon.com/kendra/latest/dg/index-synonyms-adding-thesaurus-file.html). ## Request Syntax ``` { "ClientToken": "string", "Description": "string", "IndexId": "string", "Name": "string", "RoleArn": "string", "SourceS3Path": { "Bucket": "string", "Key": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClientToken](#API_CreateThesaurus_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: No ** [Description](#API_CreateThesaurus_RequestSyntax) ** A description for the thesaurus. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: `^\P{C}*$` Required: No ** [IndexId](#API_CreateThesaurus_RequestSyntax) ** The identifier of the index for the thesaurus. Type: String Length Constraints: Fixed length of 36. Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*` Required: Yes ** [Name](#API_CreateThesaurus_RequestSyntax) ** A name for the thesaurus. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*` Required: Yes ** [RoleArn](#API_CreateThesaurus_RequestSyntax) ** The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the thesaurus file. For more information, see [IAM access roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). Type: String Length Constraints: Minimum length of 0. Maximum length of 1284. Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}` Required: Yes ** [SourceS3Path](#API_CreateThesaurus_RequestSyntax) ** The path to the thesaurus file in S3. Type: [S3Path](API_S3Path.md) object Required: Yes ** [Tags](#API_CreateThesaurus_RequestSyntax) ** A list of key-value pairs that identify or categorize the thesaurus. You can also use tags to help control access to the thesaurus. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` { "Id": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Id](#API_CreateThesaurus_ResponseSyntax) ** The identifier of the thesaurus. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again. HTTP Status Code: 400 ** ConflictException ** A conflict occurred with the request. Please fix any inconsistences with your resources and try again. HTTP Status Code: 400 ** InternalServerException ** An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help. HTTP Status Code: 500 ** ResourceNotFoundException ** The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again. HTTP Status Code: 400 ** ServiceQuotaExceededException ** You have exceeded the set limits for your Amazon Kendra service. Please see [Quotas](https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact [Support](http://aws.amazon.com/contact-us/) to inquire about an increase of limits. HTTP Status Code: 400 ** ThrottlingException ** The request was denied due to request throttling. Please reduce the number of requests and try again. HTTP Status Code: 400 ** ValidationException ** The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kendra-2019-02-03/CreateThesaurus) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/CreateThesaurus) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/CreateThesaurus) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/CreateThesaurus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/CreateThesaurus) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/CreateThesaurus) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/CreateThesaurus) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/CreateThesaurus) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/CreateThesaurus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/CreateThesaurus)