# Amazon Kendra API Reference
This API reference includes operations and types for both Amazon Kendra APIs and Amazon Kendra Intelligent Ranking APIs.
Amazon Kendra is an intelligent search service that uses natural language processing and advanced machine learning algorithms to return specific answers to questions using your data.
You must create AWS Identity and Access Management (IAM) permissions before you can create an Amazon Kendra/Amazon Kendra Intelligent Ranking resource, such as an index and data source connector. For information about the IAM access control permissions that you need to use this API, see [IAM roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html) in the *Amazon Kendra Developer Guide*.
Amazon Kendra APIs and Amazon Kendra Intelligent Ranking APIs are designed to be used with language-specific AWS SDKs, such as the Python and Java SDK. You can also use the APIs with the AWS CLI. For information about setting up the CLI and Python SDK, see [Setting up Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/setup.html). For information on how to get started with the CLI, Python SDK, and Java SDK to create an Amazon Kendra index and data source connector, see [Getting started with Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html).
You must also take note of your Amazon Kendra account region and endpoint when using the APIs. An endpoint is a URL that is the entry point for a web service. Each endpoint is associated with a specific AWS region. For more information, see [Amazon Kendra Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/kendra.html).
The following resources provide additional information about the Amazon Kendra API:
+ *[Amazon Kendra CLI Reference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/index.html)*
+ *[AWS General Reference](https://docs.aws.amazon.com/general/latest/gr/kendra.html)*
**Topics**
+ [
# Actions
](API_Operations.md)
+ [
# Data Types
](API_Types.md)
+ [
# Common Parameters
](CommonParameters.md)
+ [
# Common Error Types
](CommonErrors.md)
# Actions
The following actions are supported by Amazon Kendra:
+ [AssociateEntitiesToExperience](API_AssociateEntitiesToExperience.md)
+ [AssociatePersonasToEntities](API_AssociatePersonasToEntities.md)
+ [BatchDeleteDocument](API_BatchDeleteDocument.md)
+ [BatchDeleteFeaturedResultsSet](API_BatchDeleteFeaturedResultsSet.md)
+ [BatchGetDocumentStatus](API_BatchGetDocumentStatus.md)
+ [BatchPutDocument](API_BatchPutDocument.md)
+ [ClearQuerySuggestions](API_ClearQuerySuggestions.md)
+ [CreateAccessControlConfiguration](API_CreateAccessControlConfiguration.md)
+ [CreateDataSource](API_CreateDataSource.md)
+ [CreateExperience](API_CreateExperience.md)
+ [CreateFaq](API_CreateFaq.md)
+ [CreateFeaturedResultsSet](API_CreateFeaturedResultsSet.md)
+ [CreateIndex](API_CreateIndex.md)
+ [CreateQuerySuggestionsBlockList](API_CreateQuerySuggestionsBlockList.md)
+ [CreateThesaurus](API_CreateThesaurus.md)
+ [DeleteAccessControlConfiguration](API_DeleteAccessControlConfiguration.md)
+ [DeleteDataSource](API_DeleteDataSource.md)
+ [DeleteExperience](API_DeleteExperience.md)
+ [DeleteFaq](API_DeleteFaq.md)
+ [DeleteIndex](API_DeleteIndex.md)
+ [DeletePrincipalMapping](API_DeletePrincipalMapping.md)
+ [DeleteQuerySuggestionsBlockList](API_DeleteQuerySuggestionsBlockList.md)
+ [DeleteThesaurus](API_DeleteThesaurus.md)
+ [DescribeAccessControlConfiguration](API_DescribeAccessControlConfiguration.md)
+ [DescribeDataSource](API_DescribeDataSource.md)
+ [DescribeExperience](API_DescribeExperience.md)
+ [DescribeFaq](API_DescribeFaq.md)
+ [DescribeFeaturedResultsSet](API_DescribeFeaturedResultsSet.md)
+ [DescribeIndex](API_DescribeIndex.md)
+ [DescribePrincipalMapping](API_DescribePrincipalMapping.md)
+ [DescribeQuerySuggestionsBlockList](API_DescribeQuerySuggestionsBlockList.md)
+ [DescribeQuerySuggestionsConfig](API_DescribeQuerySuggestionsConfig.md)
+ [DescribeThesaurus](API_DescribeThesaurus.md)
+ [DisassociateEntitiesFromExperience](API_DisassociateEntitiesFromExperience.md)
+ [DisassociatePersonasFromEntities](API_DisassociatePersonasFromEntities.md)
+ [GetQuerySuggestions](API_GetQuerySuggestions.md)
+ [GetSnapshots](API_GetSnapshots.md)
+ [ListAccessControlConfigurations](API_ListAccessControlConfigurations.md)
+ [ListDataSources](API_ListDataSources.md)
+ [ListDataSourceSyncJobs](API_ListDataSourceSyncJobs.md)
+ [ListEntityPersonas](API_ListEntityPersonas.md)
+ [ListExperienceEntities](API_ListExperienceEntities.md)
+ [ListExperiences](API_ListExperiences.md)
+ [ListFaqs](API_ListFaqs.md)
+ [ListFeaturedResultsSets](API_ListFeaturedResultsSets.md)
+ [ListGroupsOlderThanOrderingId](API_ListGroupsOlderThanOrderingId.md)
+ [ListIndices](API_ListIndices.md)
+ [ListQuerySuggestionsBlockLists](API_ListQuerySuggestionsBlockLists.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [ListThesauri](API_ListThesauri.md)
+ [PutPrincipalMapping](API_PutPrincipalMapping.md)
+ [Query](API_Query.md)
+ [Retrieve](API_Retrieve.md)
+ [StartDataSourceSyncJob](API_StartDataSourceSyncJob.md)
+ [StopDataSourceSyncJob](API_StopDataSourceSyncJob.md)
+ [SubmitFeedback](API_SubmitFeedback.md)
+ [TagResource](API_TagResource.md)
+ [UntagResource](API_UntagResource.md)
+ [UpdateAccessControlConfiguration](API_UpdateAccessControlConfiguration.md)
+ [UpdateDataSource](API_UpdateDataSource.md)
+ [UpdateExperience](API_UpdateExperience.md)
+ [UpdateFeaturedResultsSet](API_UpdateFeaturedResultsSet.md)
+ [UpdateIndex](API_UpdateIndex.md)
+ [UpdateQuerySuggestionsBlockList](API_UpdateQuerySuggestionsBlockList.md)
+ [UpdateQuerySuggestionsConfig](API_UpdateQuerySuggestionsConfig.md)
+ [UpdateThesaurus](API_UpdateThesaurus.md)
The following actions are supported by Amazon Kendra Intelligent Ranking:
+ [CreateRescoreExecutionPlan](API_Ranking_CreateRescoreExecutionPlan.md)
+ [DeleteRescoreExecutionPlan](API_Ranking_DeleteRescoreExecutionPlan.md)
+ [DescribeRescoreExecutionPlan](API_Ranking_DescribeRescoreExecutionPlan.md)
+ [ListRescoreExecutionPlans](API_Ranking_ListRescoreExecutionPlans.md)
+ [ListTagsForResource](API_Ranking_ListTagsForResource.md)
+ [Rescore](API_Ranking_Rescore.md)
+ [TagResource](API_Ranking_TagResource.md)
+ [UntagResource](API_Ranking_UntagResource.md)
+ [UpdateRescoreExecutionPlan](API_Ranking_UpdateRescoreExecutionPlan.md)
# Amazon Kendra
The following actions are supported by Amazon Kendra:
+ [AssociateEntitiesToExperience](API_AssociateEntitiesToExperience.md)
+ [AssociatePersonasToEntities](API_AssociatePersonasToEntities.md)
+ [BatchDeleteDocument](API_BatchDeleteDocument.md)
+ [BatchDeleteFeaturedResultsSet](API_BatchDeleteFeaturedResultsSet.md)
+ [BatchGetDocumentStatus](API_BatchGetDocumentStatus.md)
+ [BatchPutDocument](API_BatchPutDocument.md)
+ [ClearQuerySuggestions](API_ClearQuerySuggestions.md)
+ [CreateAccessControlConfiguration](API_CreateAccessControlConfiguration.md)
+ [CreateDataSource](API_CreateDataSource.md)
+ [CreateExperience](API_CreateExperience.md)
+ [CreateFaq](API_CreateFaq.md)
+ [CreateFeaturedResultsSet](API_CreateFeaturedResultsSet.md)
+ [CreateIndex](API_CreateIndex.md)
+ [CreateQuerySuggestionsBlockList](API_CreateQuerySuggestionsBlockList.md)
+ [CreateThesaurus](API_CreateThesaurus.md)
+ [DeleteAccessControlConfiguration](API_DeleteAccessControlConfiguration.md)
+ [DeleteDataSource](API_DeleteDataSource.md)
+ [DeleteExperience](API_DeleteExperience.md)
+ [DeleteFaq](API_DeleteFaq.md)
+ [DeleteIndex](API_DeleteIndex.md)
+ [DeletePrincipalMapping](API_DeletePrincipalMapping.md)
+ [DeleteQuerySuggestionsBlockList](API_DeleteQuerySuggestionsBlockList.md)
+ [DeleteThesaurus](API_DeleteThesaurus.md)
+ [DescribeAccessControlConfiguration](API_DescribeAccessControlConfiguration.md)
+ [DescribeDataSource](API_DescribeDataSource.md)
+ [DescribeExperience](API_DescribeExperience.md)
+ [DescribeFaq](API_DescribeFaq.md)
+ [DescribeFeaturedResultsSet](API_DescribeFeaturedResultsSet.md)
+ [DescribeIndex](API_DescribeIndex.md)
+ [DescribePrincipalMapping](API_DescribePrincipalMapping.md)
+ [DescribeQuerySuggestionsBlockList](API_DescribeQuerySuggestionsBlockList.md)
+ [DescribeQuerySuggestionsConfig](API_DescribeQuerySuggestionsConfig.md)
+ [DescribeThesaurus](API_DescribeThesaurus.md)
+ [DisassociateEntitiesFromExperience](API_DisassociateEntitiesFromExperience.md)
+ [DisassociatePersonasFromEntities](API_DisassociatePersonasFromEntities.md)
+ [GetQuerySuggestions](API_GetQuerySuggestions.md)
+ [GetSnapshots](API_GetSnapshots.md)
+ [ListAccessControlConfigurations](API_ListAccessControlConfigurations.md)
+ [ListDataSources](API_ListDataSources.md)
+ [ListDataSourceSyncJobs](API_ListDataSourceSyncJobs.md)
+ [ListEntityPersonas](API_ListEntityPersonas.md)
+ [ListExperienceEntities](API_ListExperienceEntities.md)
+ [ListExperiences](API_ListExperiences.md)
+ [ListFaqs](API_ListFaqs.md)
+ [ListFeaturedResultsSets](API_ListFeaturedResultsSets.md)
+ [ListGroupsOlderThanOrderingId](API_ListGroupsOlderThanOrderingId.md)
+ [ListIndices](API_ListIndices.md)
+ [ListQuerySuggestionsBlockLists](API_ListQuerySuggestionsBlockLists.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [ListThesauri](API_ListThesauri.md)
+ [PutPrincipalMapping](API_PutPrincipalMapping.md)
+ [Query](API_Query.md)
+ [Retrieve](API_Retrieve.md)
+ [StartDataSourceSyncJob](API_StartDataSourceSyncJob.md)
+ [StopDataSourceSyncJob](API_StopDataSourceSyncJob.md)
+ [SubmitFeedback](API_SubmitFeedback.md)
+ [TagResource](API_TagResource.md)
+ [UntagResource](API_UntagResource.md)
+ [UpdateAccessControlConfiguration](API_UpdateAccessControlConfiguration.md)
+ [UpdateDataSource](API_UpdateDataSource.md)
+ [UpdateExperience](API_UpdateExperience.md)
+ [UpdateFeaturedResultsSet](API_UpdateFeaturedResultsSet.md)
+ [UpdateIndex](API_UpdateIndex.md)
+ [UpdateQuerySuggestionsBlockList](API_UpdateQuerySuggestionsBlockList.md)
+ [UpdateQuerySuggestionsConfig](API_UpdateQuerySuggestionsConfig.md)
+ [UpdateThesaurus](API_UpdateThesaurus.md)
# AssociateEntitiesToExperience
Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see [Building a search experience with no code](https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).
## Request Syntax
```
{
"EntityList": [
{
"EntityId": "string",
"EntityType": "string"
}
],
"Id": "string",
"IndexId": "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.
** [EntityList](#API_AssociateEntitiesToExperience_RequestSyntax) **
Lists users or groups in your IAM Identity Center identity source.
Type: Array of [EntityConfiguration](API_EntityConfiguration.md) objects
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required: Yes
** [Id](#API_AssociateEntitiesToExperience_RequestSyntax) **
The identifier of your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_AssociateEntitiesToExperience_RequestSyntax) **
The identifier of the index for your Amazon Kendra experience.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Syntax
```
{
"FailedEntityList": [
{
"EntityId": "string",
"ErrorMessage": "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.
** [FailedEntityList](#API_AssociateEntitiesToExperience_ResponseSyntax) **
Lists the users or groups in your IAM Identity Center identity source that failed to properly configure with your Amazon Kendra experience.
Type: Array of [FailedEntity](API_FailedEntity.md) objects
Array Members: Minimum number of 1 item. Maximum number of 20 items.
## 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
** 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
** ResourceAlreadyExistException **
The resource you want to use already exists. Please check you have provided the correct resource and try again.
HTTP Status Code: 400
** 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
** 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/AssociateEntitiesToExperience)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/AssociateEntitiesToExperience)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/AssociateEntitiesToExperience)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/AssociateEntitiesToExperience)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/AssociateEntitiesToExperience)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/AssociateEntitiesToExperience)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/AssociateEntitiesToExperience)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/AssociateEntitiesToExperience)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/AssociateEntitiesToExperience)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/AssociateEntitiesToExperience)
# AssociatePersonasToEntities
Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see [Building a search experience with no code](https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).
## Request Syntax
```
{
"Id": "string",
"IndexId": "string",
"Personas": [
{
"EntityId": "string",
"Persona": "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.
** [Id](#API_AssociatePersonasToEntities_RequestSyntax) **
The identifier of your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_AssociatePersonasToEntities_RequestSyntax) **
The identifier of the index for your Amazon Kendra experience.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [Personas](#API_AssociatePersonasToEntities_RequestSyntax) **
The personas that define the specific permissions of users or groups in your IAM Identity Center identity source. The available personas or access roles are `Owner` and `Viewer`. For more information on these personas, see [Providing access to your search page](https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience).
Type: Array of [EntityPersonaConfiguration](API_EntityPersonaConfiguration.md) objects
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Required: Yes
## Response Syntax
```
{
"FailedEntityList": [
{
"EntityId": "string",
"ErrorMessage": "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.
** [FailedEntityList](#API_AssociatePersonasToEntities_ResponseSyntax) **
Lists the users or groups in your IAM Identity Center identity source that failed to properly configure with your Amazon Kendra experience.
Type: Array of [FailedEntity](API_FailedEntity.md) objects
Array Members: Minimum number of 1 item. Maximum number of 25 items.
## 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
** 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
** ResourceAlreadyExistException **
The resource you want to use already exists. Please check you have provided the correct resource and try again.
HTTP Status Code: 400
** 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
** 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/AssociatePersonasToEntities)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/AssociatePersonasToEntities)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/AssociatePersonasToEntities)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/AssociatePersonasToEntities)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/AssociatePersonasToEntities)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/AssociatePersonasToEntities)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/AssociatePersonasToEntities)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/AssociatePersonasToEntities)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/AssociatePersonasToEntities)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/AssociatePersonasToEntities)
# BatchDeleteDocument
Removes one or more documents from an index. The documents must have been added with the `BatchPutDocument` API.
The documents are deleted asynchronously. You can see the progress of the deletion by using AWS CloudWatch. Any error messages related to the processing of the batch are sent to your AWS CloudWatch log. You can also use the `BatchGetDocumentStatus` API to monitor the progress of deleting your documents.
Deleting documents from an index using `BatchDeleteDocument` could take up to an hour or more, depending on the number of documents you want to delete.
## Request Syntax
```
{
"DataSourceSyncJobMetricTarget": {
"DataSourceId": "string",
"DataSourceSyncJobId": "string"
},
"DocumentIdList": [ "string" ],
"IndexId": "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.
** [DataSourceSyncJobMetricTarget](#API_BatchDeleteDocument_RequestSyntax) **
Maps a particular data source sync job to a particular data source.
Type: [DataSourceSyncJobMetricTarget](API_DataSourceSyncJobMetricTarget.md) object
Required: No
** [DocumentIdList](#API_BatchDeleteDocument_RequestSyntax) **
One or more identifiers for documents to delete from the index.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
** [IndexId](#API_BatchDeleteDocument_RequestSyntax) **
The identifier of the index that contains the documents to delete.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Syntax
```
{
"FailedDocuments": [
{
"DataSourceId": "string",
"ErrorCode": "string",
"ErrorMessage": "string",
"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.
** [FailedDocuments](#API_BatchDeleteDocument_ResponseSyntax) **
A list of documents that could not be removed from the index. Each entry contains an error message that indicates why the document couldn't be removed from the index.
Type: Array of [BatchDeleteDocumentResponseFailedDocument](API_BatchDeleteDocumentResponseFailedDocument.md) objects
## 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
** 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/BatchDeleteDocument)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/BatchDeleteDocument)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/BatchDeleteDocument)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/BatchDeleteDocument)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/BatchDeleteDocument)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/BatchDeleteDocument)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/BatchDeleteDocument)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/BatchDeleteDocument)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/BatchDeleteDocument)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/BatchDeleteDocument)
# BatchDeleteFeaturedResultsSet
Removes one or more sets of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
## Request Syntax
```
{
"FeaturedResultsSetIds": [ "string" ],
"IndexId": "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.
** [FeaturedResultsSetIds](#API_BatchDeleteFeaturedResultsSet_RequestSyntax) **
The identifiers of the featured results sets that you want to delete.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Length Constraints: Fixed length of 36.
Pattern: `^[a-zA-Z-0-9]*`
Required: Yes
** [IndexId](#API_BatchDeleteFeaturedResultsSet_RequestSyntax) **
The identifier of the index used for featuring results.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Syntax
```
{
"Errors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"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.
** [Errors](#API_BatchDeleteFeaturedResultsSet_ResponseSyntax) **
The list of errors for the featured results set IDs, explaining why they couldn't be removed from the index.
Type: Array of [BatchDeleteFeaturedResultsSetError](API_BatchDeleteFeaturedResultsSetError.md) objects
## 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
** 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
** 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/BatchDeleteFeaturedResultsSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/BatchDeleteFeaturedResultsSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/BatchDeleteFeaturedResultsSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/BatchDeleteFeaturedResultsSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/BatchDeleteFeaturedResultsSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/BatchDeleteFeaturedResultsSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/BatchDeleteFeaturedResultsSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/BatchDeleteFeaturedResultsSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/BatchDeleteFeaturedResultsSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/BatchDeleteFeaturedResultsSet)
# BatchGetDocumentStatus
Returns the indexing status for one or more documents submitted with the [ BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) API.
When you use the `BatchPutDocument` API, documents are indexed asynchronously. You can use the `BatchGetDocumentStatus` API to get the current status of a list of documents so that you can determine if they have been successfully indexed.
You can also use the `BatchGetDocumentStatus` API to check the status of the [ BatchDeleteDocument](https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html) API. When a document is deleted from the index, Amazon Kendra returns `NOT_FOUND` as the status.
## Request Syntax
```
{
"DocumentInfoList": [
{
"Attributes": [
{
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
}
],
"DocumentId": "string"
}
],
"IndexId": "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.
** [DocumentInfoList](#API_BatchGetDocumentStatus_RequestSyntax) **
A list of `DocumentInfo` objects that identify the documents for which to get the status. You identify the documents by their document ID and optional attributes.
Type: Array of [DocumentInfo](API_DocumentInfo.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
** [IndexId](#API_BatchGetDocumentStatus_RequestSyntax) **
The identifier of the index to add documents to. The index ID is returned by the [CreateIndex ](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html) API.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Syntax
```
{
"DocumentStatusList": [
{
"DocumentId": "string",
"DocumentStatus": "string",
"FailureCode": "string",
"FailureReason": "string"
}
],
"Errors": [
{
"DataSourceId": "string",
"DocumentId": "string",
"ErrorCode": "string",
"ErrorMessage": "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.
** [DocumentStatusList](#API_BatchGetDocumentStatus_ResponseSyntax) **
The status of documents. The status indicates if the document is waiting to be indexed, is in the process of indexing, has completed indexing, or failed indexing. If a document failed indexing, the status provides the reason why.
Type: Array of [Status](API_Status.md) objects
** [Errors](#API_BatchGetDocumentStatus_ResponseSyntax) **
A list of documents that Amazon Kendra couldn't get the status for. The list includes the ID of the document and the reason that the status couldn't be found.
Type: Array of [BatchGetDocumentStatusResponseError](API_BatchGetDocumentStatusResponseError.md) objects
## 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
** 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/BatchGetDocumentStatus)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/BatchGetDocumentStatus)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/BatchGetDocumentStatus)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/BatchGetDocumentStatus)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/BatchGetDocumentStatus)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/BatchGetDocumentStatus)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/BatchGetDocumentStatus)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/BatchGetDocumentStatus)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/BatchGetDocumentStatus)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/BatchGetDocumentStatus)
# BatchPutDocument
Adds one or more documents to an index.
The `BatchPutDocument` API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.
The documents are indexed asynchronously. You can see the progress of the batch using AWS CloudWatch. Any error messages related to processing the batch are sent to your AWS CloudWatch log. You can also use the `BatchGetDocumentStatus` API to monitor the progress of indexing your documents.
For an example of ingesting inline documents using Python and Java SDKs, see [Adding files directly to an index](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-binary-doc.html).
## Request Syntax
```
{
"CustomDocumentEnrichmentConfiguration": {
"InlineConfigurations": [
{
"Condition": {
"ConditionDocumentAttributeKey": "string",
"ConditionOnValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"Operator": "string"
},
"DocumentContentDeletion": boolean,
"Target": {
"TargetDocumentAttributeKey": "string",
"TargetDocumentAttributeValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"TargetDocumentAttributeValueDeletion": boolean
}
}
],
"PostExtractionHookConfiguration": {
"InvocationCondition": {
"ConditionDocumentAttributeKey": "string",
"ConditionOnValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"Operator": "string"
},
"LambdaArn": "string",
"S3Bucket": "string"
},
"PreExtractionHookConfiguration": {
"InvocationCondition": {
"ConditionDocumentAttributeKey": "string",
"ConditionOnValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"Operator": "string"
},
"LambdaArn": "string",
"S3Bucket": "string"
},
"RoleArn": "string"
},
"Documents": [
{
"AccessControlConfigurationId": "string",
"AccessControlList": [
{
"Access": "string",
"DataSourceId": "string",
"Name": "string",
"Type": "string"
}
],
"Attributes": [
{
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
}
],
"Blob": blob,
"ContentType": "string",
"HierarchicalAccessControlList": [
{
"PrincipalList": [
{
"Access": "string",
"DataSourceId": "string",
"Name": "string",
"Type": "string"
}
]
}
],
"Id": "string",
"S3Path": {
"Bucket": "string",
"Key": "string"
},
"Title": "string"
}
],
"IndexId": "string",
"RoleArn": "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.
** [CustomDocumentEnrichmentConfiguration](#API_BatchPutDocument_RequestSyntax) **
Configuration information for altering your document metadata and content during the document ingestion process when you use the `BatchPutDocument` API.
For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see [Customizing document metadata during the ingestion process](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).
Type: [CustomDocumentEnrichmentConfiguration](API_CustomDocumentEnrichmentConfiguration.md) object
Required: No
** [Documents](#API_BatchPutDocument_RequestSyntax) **
One or more documents to add to the index.
Documents have the following file size limits.
+ 50 MB total size for any file
+ 5 MB extracted text for any file
For more information, see [Quotas](https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
Type: Array of [Document](API_Document.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
** [IndexId](#API_BatchPutDocument_RequestSyntax) **
The identifier of the index to add the documents to. You need to create the index first using the `CreateIndex` API.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [RoleArn](#API_BatchPutDocument_RequestSyntax) **
The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket. 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: No
## Response Syntax
```
{
"FailedDocuments": [
{
"DataSourceId": "string",
"ErrorCode": "string",
"ErrorMessage": "string",
"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.
** [FailedDocuments](#API_BatchPutDocument_ResponseSyntax) **
A list of documents that were not added to the index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.
If there was an error adding a document to an index the error is reported in your AWS CloudWatch log. For more information, see [Monitoring Amazon Kendra with Amazon CloudWatch logs](https://docs.aws.amazon.com/kendra/latest/dg/cloudwatch-logs.html).
Type: Array of [BatchPutDocumentResponseFailedDocument](API_BatchPutDocumentResponseFailedDocument.md) objects
## 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/BatchPutDocument)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/BatchPutDocument)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/BatchPutDocument)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/BatchPutDocument)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/BatchPutDocument)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/BatchPutDocument)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/BatchPutDocument)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/BatchPutDocument)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/BatchPutDocument)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/BatchPutDocument)
# ClearQuerySuggestions
Clears existing query suggestions from an index.
This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.
`ClearQuerySuggestions` is currently not supported in the AWS GovCloud (US-West) region.
## Request Syntax
```
{
"IndexId": "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.
** [IndexId](#API_ClearQuerySuggestions_RequestSyntax) **
The identifier of the index you want to clear query suggestions from.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** 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/ClearQuerySuggestions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/ClearQuerySuggestions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ClearQuerySuggestions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/ClearQuerySuggestions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ClearQuerySuggestions)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/ClearQuerySuggestions)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/ClearQuerySuggestions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/ClearQuerySuggestions)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/ClearQuerySuggestions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ClearQuerySuggestions)
# CreateAccessControlConfiguration
Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change.
To apply your access control configuration to certain documents, you call the [BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) API with the `AccessControlConfigurationId` included in the [Document](https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html) object. If you use an S3 bucket as a data source, you update the `.metadata.json` with the `AccessControlConfigurationId` and synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the `BatchPutDocument` API.
**Important**
You can't configure access control using `CreateAccessControlConfiguration` for an Amazon Kendra Gen AI Enterprise Edition index. Amazon Kendra will return a `ValidationException` error for a `Gen_AI_ENTERPRISE_EDITION` index.
## Request Syntax
```
{
"AccessControlList": [
{
"Access": "string",
"DataSourceId": "string",
"Name": "string",
"Type": "string"
}
],
"ClientToken": "string",
"Description": "string",
"HierarchicalAccessControlList": [
{
"PrincipalList": [
{
"Access": "string",
"DataSourceId": "string",
"Name": "string",
"Type": "string"
}
]
}
],
"IndexId": "string",
"Name": "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.
** [AccessControlList](#API_CreateAccessControlConfiguration_RequestSyntax) **
Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
Type: Array of [Principal](API_Principal.md) objects
Required: No
** [ClientToken](#API_CreateAccessControlConfiguration_RequestSyntax) **
A token that you provide to identify the request to create an access control configuration. Multiple calls to the `CreateAccessControlConfiguration` API with the same client token will create only one access control configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** [Description](#API_CreateAccessControlConfiguration_RequestSyntax) **
A description for the access control configuration.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
Required: No
** [HierarchicalAccessControlList](#API_CreateAccessControlConfiguration_RequestSyntax) **
The list of [principal](https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) lists that define the hierarchy for which documents users should have access to.
Type: Array of [HierarchicalPrincipal](API_HierarchicalPrincipal.md) objects
Array Members: Minimum number of 1 item. Maximum number of 30 items.
Required: No
** [IndexId](#API_CreateAccessControlConfiguration_RequestSyntax) **
The identifier of the index to create an access control configuration for your documents.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [Name](#API_CreateAccessControlConfiguration_RequestSyntax) **
A name for the access control configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `[\S\s]*`
Required: Yes
## 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_CreateAccessControlConfiguration_ResponseSyntax) **
The identifier of the access control configuration for your documents in an index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[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/CreateAccessControlConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/CreateAccessControlConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/CreateAccessControlConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/CreateAccessControlConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/CreateAccessControlConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/CreateAccessControlConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/CreateAccessControlConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/CreateAccessControlConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/CreateAccessControlConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/CreateAccessControlConfiguration)
# CreateDataSource
Creates a data source connector that you want to use with an Amazon Kendra index.
You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.
`CreateDataSource` is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
For an example of creating an index and data source using the Python SDK, see [Getting started with Python SDK](https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html). For an example of creating an index and data source using the Java SDK, see [Getting started with Java SDK](https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html).
## Request Syntax
```
{
"ClientToken": "string",
"Configuration": {
"AlfrescoConfiguration": {
"BlogFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"CrawlComments": boolean,
"CrawlSystemFolders": boolean,
"DocumentLibraryFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"EntityFilter": [ "string" ],
"ExclusionPatterns": [ "string" ],
"InclusionPatterns": [ "string" ],
"SecretArn": "string",
"SiteId": "string",
"SiteUrl": "string",
"SslCertificateS3Path": {
"Bucket": "string",
"Key": "string"
},
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
},
"WikiFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"BoxConfiguration": {
"CommentFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"CrawlComments": boolean,
"CrawlTasks": boolean,
"CrawlWebLinks": boolean,
"EnterpriseId": "string",
"ExclusionPatterns": [ "string" ],
"FileFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"SecretArn": "string",
"TaskFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"UseChangeLog": boolean,
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
},
"WebLinkFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"ConfluenceConfiguration": {
"AttachmentConfiguration": {
"AttachmentFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"CrawlAttachments": boolean
},
"AuthenticationType": "string",
"BlogConfiguration": {
"BlogFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"ExclusionPatterns": [ "string" ],
"InclusionPatterns": [ "string" ],
"PageConfiguration": {
"PageFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"ProxyConfiguration": {
"Credentials": "string",
"Host": "string",
"Port": number
},
"SecretArn": "string",
"ServerUrl": "string",
"SpaceConfiguration": {
"CrawlArchivedSpaces": boolean,
"CrawlPersonalSpaces": boolean,
"ExcludeSpaces": [ "string" ],
"IncludeSpaces": [ "string" ],
"SpaceFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"Version": "string",
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"DatabaseConfiguration": {
"AclConfiguration": {
"AllowedGroupsColumnName": "string"
},
"ColumnConfiguration": {
"ChangeDetectingColumns": [ "string" ],
"DocumentDataColumnName": "string",
"DocumentIdColumnName": "string",
"DocumentTitleColumnName": "string",
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"ConnectionConfiguration": {
"DatabaseHost": "string",
"DatabaseName": "string",
"DatabasePort": number,
"SecretArn": "string",
"TableName": "string"
},
"DatabaseEngineType": "string",
"SqlConfiguration": {
"QueryIdentifiersEnclosingOption": "string"
},
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"FsxConfiguration": {
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"FileSystemId": "string",
"FileSystemType": "string",
"InclusionPatterns": [ "string" ],
"SecretArn": "string",
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"GitHubConfiguration": {
"ExclusionFileNamePatterns": [ "string" ],
"ExclusionFileTypePatterns": [ "string" ],
"ExclusionFolderNamePatterns": [ "string" ],
"GitHubCommitConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubDocumentCrawlProperties": {
"CrawlIssue": boolean,
"CrawlIssueComment": boolean,
"CrawlIssueCommentAttachment": boolean,
"CrawlPullRequest": boolean,
"CrawlPullRequestComment": boolean,
"CrawlPullRequestCommentAttachment": boolean,
"CrawlRepositoryDocuments": boolean
},
"GitHubIssueAttachmentConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubIssueCommentConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubIssueDocumentConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubPullRequestCommentConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubPullRequestDocumentAttachmentConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubPullRequestDocumentConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubRepositoryConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionFileNamePatterns": [ "string" ],
"InclusionFileTypePatterns": [ "string" ],
"InclusionFolderNamePatterns": [ "string" ],
"OnPremiseConfiguration": {
"HostUrl": "string",
"OrganizationName": "string",
"SslCertificateS3Path": {
"Bucket": "string",
"Key": "string"
}
},
"RepositoryFilter": [ "string" ],
"SaaSConfiguration": {
"HostUrl": "string",
"OrganizationName": "string"
},
"SecretArn": "string",
"Type": "string",
"UseChangeLog": boolean,
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"GoogleDriveConfiguration": {
"ExcludeMimeTypes": [ "string" ],
"ExcludeSharedDrives": [ "string" ],
"ExcludeUserAccounts": [ "string" ],
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"SecretArn": "string"
},
"JiraConfiguration": {
"AttachmentFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"CommentFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"ExclusionPatterns": [ "string" ],
"InclusionPatterns": [ "string" ],
"IssueFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"IssueSubEntityFilter": [ "string" ],
"IssueType": [ "string" ],
"JiraAccountUrl": "string",
"Project": [ "string" ],
"ProjectFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"SecretArn": "string",
"Status": [ "string" ],
"UseChangeLog": boolean,
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
},
"WorkLogFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"OneDriveConfiguration": {
"DisableLocalGroups": boolean,
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"OneDriveUsers": {
"OneDriveUserList": [ "string" ],
"OneDriveUserS3Path": {
"Bucket": "string",
"Key": "string"
}
},
"SecretArn": "string",
"TenantDomain": "string"
},
"QuipConfiguration": {
"AttachmentFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"CrawlAttachments": boolean,
"CrawlChatRooms": boolean,
"CrawlFileComments": boolean,
"Domain": "string",
"ExclusionPatterns": [ "string" ],
"FolderIds": [ "string" ],
"InclusionPatterns": [ "string" ],
"MessageFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"SecretArn": "string",
"ThreadFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"S3Configuration": {
"AccessControlListConfiguration": {
"KeyPath": "string"
},
"BucketName": "string",
"DocumentsMetadataConfiguration": {
"S3Prefix": "string"
},
"ExclusionPatterns": [ "string" ],
"InclusionPatterns": [ "string" ],
"InclusionPrefixes": [ "string" ]
},
"SalesforceConfiguration": {
"ChatterFeedConfiguration": {
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"IncludeFilterTypes": [ "string" ]
},
"CrawlAttachments": boolean,
"ExcludeAttachmentFilePatterns": [ "string" ],
"IncludeAttachmentFilePatterns": [ "string" ],
"KnowledgeArticleConfiguration": {
"CustomKnowledgeArticleTypeConfigurations": [
{
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"Name": "string"
}
],
"IncludedStates": [ "string" ],
"StandardKnowledgeArticleTypeConfiguration": {
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
}
},
"SecretArn": "string",
"ServerUrl": "string",
"StandardObjectAttachmentConfiguration": {
"DocumentTitleFieldName": "string",
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"StandardObjectConfigurations": [
{
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"Name": "string"
}
]
},
"ServiceNowConfiguration": {
"AuthenticationType": "string",
"HostUrl": "string",
"KnowledgeArticleConfiguration": {
"CrawlAttachments": boolean,
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"ExcludeAttachmentFilePatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"FilterQuery": "string",
"IncludeAttachmentFilePatterns": [ "string" ]
},
"SecretArn": "string",
"ServiceCatalogConfiguration": {
"CrawlAttachments": boolean,
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"ExcludeAttachmentFilePatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"IncludeAttachmentFilePatterns": [ "string" ]
},
"ServiceNowBuildVersion": "string"
},
"SharePointConfiguration": {
"AuthenticationType": "string",
"CrawlAttachments": boolean,
"DisableLocalGroups": boolean,
"DocumentTitleFieldName": "string",
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"ProxyConfiguration": {
"Credentials": "string",
"Host": "string",
"Port": number
},
"SecretArn": "string",
"SharePointVersion": "string",
"SslCertificateS3Path": {
"Bucket": "string",
"Key": "string"
},
"Urls": [ "string" ],
"UseChangeLog": boolean,
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"SlackConfiguration": {
"CrawlBotMessage": boolean,
"ExcludeArchived": boolean,
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"LookBackPeriod": number,
"PrivateChannelFilter": [ "string" ],
"PublicChannelFilter": [ "string" ],
"SecretArn": "string",
"SinceCrawlDate": "string",
"SlackEntityList": [ "string" ],
"TeamId": "string",
"UseChangeLog": boolean,
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"TemplateConfiguration": {
"Template": JSON value
},
"WebCrawlerConfiguration": {
"AuthenticationConfiguration": {
"BasicAuthentication": [
{
"Credentials": "string",
"Host": "string",
"Port": number
}
]
},
"CrawlDepth": number,
"MaxContentSizePerPageInMegaBytes": number,
"MaxLinksPerPage": number,
"MaxUrlsPerMinuteCrawlRate": number,
"ProxyConfiguration": {
"Credentials": "string",
"Host": "string",
"Port": number
},
"UrlExclusionPatterns": [ "string" ],
"UrlInclusionPatterns": [ "string" ],
"Urls": {
"SeedUrlConfiguration": {
"SeedUrls": [ "string" ],
"WebCrawlerMode": "string"
},
"SiteMapsConfiguration": {
"SiteMaps": [ "string" ]
}
}
},
"WorkDocsConfiguration": {
"CrawlComments": boolean,
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"OrganizationId": "string",
"UseChangeLog": boolean
}
},
"CustomDocumentEnrichmentConfiguration": {
"InlineConfigurations": [
{
"Condition": {
"ConditionDocumentAttributeKey": "string",
"ConditionOnValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"Operator": "string"
},
"DocumentContentDeletion": boolean,
"Target": {
"TargetDocumentAttributeKey": "string",
"TargetDocumentAttributeValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"TargetDocumentAttributeValueDeletion": boolean
}
}
],
"PostExtractionHookConfiguration": {
"InvocationCondition": {
"ConditionDocumentAttributeKey": "string",
"ConditionOnValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"Operator": "string"
},
"LambdaArn": "string",
"S3Bucket": "string"
},
"PreExtractionHookConfiguration": {
"InvocationCondition": {
"ConditionDocumentAttributeKey": "string",
"ConditionOnValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"Operator": "string"
},
"LambdaArn": "string",
"S3Bucket": "string"
},
"RoleArn": "string"
},
"Description": "string",
"IndexId": "string",
"LanguageCode": "string",
"Name": "string",
"RoleArn": "string",
"Schedule": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"Type": "string",
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "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_CreateDataSource_RequestSyntax) **
A token that you provide to identify the request to create a data source connector. Multiple calls to the `CreateDataSource` API with the same client token will create only one data source connector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** [Configuration](#API_CreateDataSource_RequestSyntax) **
Configuration information to connect to your data source repository.
You can't specify the `Configuration` parameter when the `Type` parameter is set to `CUSTOM`. If you do, you receive a `ValidationException` exception.
The `Configuration` parameter is required for all other data sources.
Type: [DataSourceConfiguration](API_DataSourceConfiguration.md) object
Required: No
** [CustomDocumentEnrichmentConfiguration](#API_CreateDataSource_RequestSyntax) **
Configuration information for altering document metadata and content during the document ingestion process.
For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see [Customizing document metadata during the ingestion process](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).
Type: [CustomDocumentEnrichmentConfiguration](API_CustomDocumentEnrichmentConfiguration.md) object
Required: No
** [Description](#API_CreateDataSource_RequestSyntax) **
A description for the data source connector.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
Required: No
** [IndexId](#API_CreateDataSource_RequestSyntax) **
The identifier of the index you want to use with the data source connector.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [LanguageCode](#API_CreateDataSource_RequestSyntax) **
The code for a language. This allows you to support a language for all documents when creating the data source connector. English is supported by default. For more information on supported languages, including their codes, see [Adding documents in languages other than English](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
Type: String
Length Constraints: Minimum length of 2. Maximum length of 10.
Pattern: `[a-zA-Z-]*`
Required: No
** [Name](#API_CreateDataSource_RequestSyntax) **
A name for the data source connector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [RoleArn](#API_CreateDataSource_RequestSyntax) **
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see [IAM access roles for Amazon Kendra.](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
You can't specify the `RoleArn` parameter when the `Type` parameter is set to `CUSTOM`. If you do, you receive a `ValidationException` exception.
The `RoleArn` parameter is required for all other data sources.
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: No
** [Schedule](#API_CreateDataSource_RequestSyntax) **
Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the `StartDataSourceSyncJob` API to update the index.
Specify a `cron-` format schedule string or an empty string to indicate that the index is updated on demand.
You can't specify the `Schedule` parameter when the `Type` parameter is set to `CUSTOM`. If you do, you receive a `ValidationException` exception.
Type: String
Required: No
** [Tags](#API_CreateDataSource_RequestSyntax) **
A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. 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
** [Type](#API_CreateDataSource_RequestSyntax) **
The type of data source repository. For example, `SHAREPOINT`.
Type: String
Valid Values: `S3 | SHAREPOINT | DATABASE | SALESFORCE | ONEDRIVE | SERVICENOW | CUSTOM | CONFLUENCE | GOOGLEDRIVE | WEBCRAWLER | WORKDOCS | FSX | SLACK | BOX | QUIP | JIRA | GITHUB | ALFRESCO | TEMPLATE`
Required: Yes
** [VpcConfiguration](#API_CreateDataSource_RequestSyntax) **
Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see [Configuring a VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
Type: [DataSourceVpcConfiguration](API_DataSourceVpcConfiguration.md) object
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_CreateDataSource_ResponseSyntax) **
The identifier of the data source connector.
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
** ResourceAlreadyExistException **
The resource you want to use already exists. Please check you have provided the correct resource and try again.
HTTP Status Code: 400
** 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/CreateDataSource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/CreateDataSource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/CreateDataSource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/CreateDataSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/CreateDataSource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/CreateDataSource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/CreateDataSource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/CreateDataSource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/CreateDataSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/CreateDataSource)
# CreateExperience
Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see [Building a search experience with no code](https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).
## Request Syntax
```
{
"ClientToken": "string",
"Configuration": {
"ContentSourceConfiguration": {
"DataSourceIds": [ "string" ],
"DirectPutContent": boolean,
"FaqIds": [ "string" ]
},
"UserIdentityConfiguration": {
"IdentityAttributeName": "string"
}
},
"Description": "string",
"IndexId": "string",
"Name": "string",
"RoleArn": "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_CreateExperience_RequestSyntax) **
A token that you provide to identify the request to create your Amazon Kendra experience. Multiple calls to the `CreateExperience` API with the same client token creates only one Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** [Configuration](#API_CreateExperience_RequestSyntax) **
Configuration information for your Amazon Kendra experience. This includes `ContentSourceConfiguration`, which specifies the data source IDs and/or FAQ IDs, and `UserIdentityConfiguration`, which specifies the user or group information to grant access to your Amazon Kendra experience.
Type: [ExperienceConfiguration](API_ExperienceConfiguration.md) object
Required: No
** [Description](#API_CreateExperience_RequestSyntax) **
A description for your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
Required: No
** [IndexId](#API_CreateExperience_RequestSyntax) **
The identifier of the index for your Amazon Kendra experience.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [Name](#API_CreateExperience_RequestSyntax) **
A name for your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [RoleArn](#API_CreateExperience_RequestSyntax) **
The Amazon Resource Name (ARN) of an IAM role with permission to access `Query` API, `GetQuerySuggestions` API, and other required APIs. The role also must include permission to access AWS IAM Identity Center that stores your user and group information. 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: 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_CreateExperience_ResponseSyntax) **
The identifier of your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
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/CreateExperience)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/CreateExperience)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/CreateExperience)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/CreateExperience)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/CreateExperience)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/CreateExperience)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/CreateExperience)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/CreateExperience)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/CreateExperience)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/CreateExperience)
# CreateFaq
Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.
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](https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file).
## Request Syntax
```
{
"ClientToken": "string",
"Description": "string",
"FileFormat": "string",
"IndexId": "string",
"LanguageCode": "string",
"Name": "string",
"RoleArn": "string",
"S3Path": {
"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_CreateFaq_RequestSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** [Description](#API_CreateFaq_RequestSyntax) **
A description for the FAQ.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
Required: No
** [FileFormat](#API_CreateFaq_RequestSyntax) **
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 default format is CSV.
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](https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html).
Type: String
Valid Values: `CSV | CSV_WITH_HEADER | JSON`
Required: No
** [IndexId](#API_CreateFaq_RequestSyntax) **
The identifier of the index for the FAQ.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [LanguageCode](#API_CreateFaq_RequestSyntax) **
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](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
Type: String
Length Constraints: Minimum length of 2. Maximum length of 10.
Pattern: `[a-zA-Z-]*`
Required: No
** [Name](#API_CreateFaq_RequestSyntax) **
A name for the FAQ.
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_CreateFaq_RequestSyntax) **
The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQ 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
** [S3Path](#API_CreateFaq_RequestSyntax) **
The path to the FAQ file in S3.
Type: [S3Path](API_S3Path.md) object
Required: Yes
** [Tags](#API_CreateFaq_RequestSyntax) **
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.
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_CreateFaq_ResponseSyntax) **
The identifier of the FAQ.
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/CreateFaq)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/CreateFaq)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/CreateFaq)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/CreateFaq)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/CreateFaq)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/CreateFaq)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/CreateFaq)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/CreateFaq)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/CreateFaq)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/CreateFaq)
# CreateFeaturedResultsSet
Creates a set of featured results to display at the top of the search results page. Featured results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the search results.
You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting [Support](http://aws.amazon.com/contact-us/).
## Request Syntax
```
{
"ClientToken": "string",
"Description": "string",
"FeaturedDocuments": [
{
"Id": "string"
}
],
"FeaturedResultsSetName": "string",
"IndexId": "string",
"QueryTexts": [ "string" ],
"Status": "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_CreateFeaturedResultsSet_RequestSyntax) **
A token that you provide to identify the request to create a set of featured results. Multiple calls to the `CreateFeaturedResultsSet` API with the same client token will create only one featured results set.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** [Description](#API_CreateFeaturedResultsSet_RequestSyntax) **
A description for the set of featured results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
Required: No
** [FeaturedDocuments](#API_CreateFeaturedResultsSet_RequestSyntax) **
A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see [FeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html).
Type: Array of [FeaturedDocument](API_FeaturedDocument.md) objects
Required: No
** [FeaturedResultsSetName](#API_CreateFeaturedResultsSet_RequestSyntax) **
A name for the set of featured results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][ a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_CreateFeaturedResultsSet_RequestSyntax) **
The identifier of the index that you want to use for featuring results.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [QueryTexts](#API_CreateFeaturedResultsSet_RequestSyntax) **
A list of queries for featuring results. For more information on the list of queries, see [FeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html).
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 49 items.
Required: No
** [Status](#API_CreateFeaturedResultsSet_RequestSyntax) **
The current status of the set of featured results. When the value is `ACTIVE`, featured results are ready for use. You can still configure your settings before setting the status to `ACTIVE`. You can set the status to `ACTIVE` or `INACTIVE` using the [UpdateFeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html) API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is `ACTIVE` or `INACTIVE`.
Type: String
Valid Values: `ACTIVE | INACTIVE`
Required: No
** [Tags](#API_CreateFeaturedResultsSet_RequestSyntax) **
A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. 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
```
{
"FeaturedResultsSet": {
"CreationTimestamp": number,
"Description": "string",
"FeaturedDocuments": [
{
"Id": "string"
}
],
"FeaturedResultsSetId": "string",
"FeaturedResultsSetName": "string",
"LastUpdatedTimestamp": number,
"QueryTexts": [ "string" ],
"Status": "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.
** [FeaturedResultsSet](#API_CreateFeaturedResultsSet_ResponseSyntax) **
Information on the set of featured results. This includes the identifier of the featured results set, whether the featured results set is active or inactive, when the featured results set was created, and more.
Type: [FeaturedResultsSet](API_FeaturedResultsSet.md) object
## 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
** FeaturedResultsConflictException **
An error message with a list of conflicting queries used across different sets of featured results. This occurred with the request for a new featured results set. Check that the queries you specified for featured results are unique per featured results set for each index.
** ConflictingItems **
A list of the conflicting queries, including the query text, the name for the featured results set, and the identifier of the featured results set.
** Message **
An explanation for the conflicting queries.
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
** 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/CreateFeaturedResultsSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/CreateFeaturedResultsSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/CreateFeaturedResultsSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/CreateFeaturedResultsSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/CreateFeaturedResultsSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/CreateFeaturedResultsSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/CreateFeaturedResultsSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/CreateFeaturedResultsSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/CreateFeaturedResultsSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/CreateFeaturedResultsSet)
# CreateIndex
Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the `Status` field returned from a call to `DescribeIndex`. The `Status` field is set to `ACTIVE` when the index is ready to use.
Once the index is active, you can index your documents using the `BatchPutDocument` API or using one of the supported [data sources](https://docs.aws.amazon.com/kendra/latest/dg/data-sources.html).
For an example of creating an index and data source using the Python SDK, see [Getting started with Python SDK](https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html). For an example of creating an index and data source using the Java SDK, see [Getting started with Java SDK](https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html).
## Request Syntax
```
{
"ClientToken": "string",
"Description": "string",
"Edition": "string",
"Name": "string",
"RoleArn": "string",
"ServerSideEncryptionConfiguration": {
"KmsKeyId": "string"
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"UserContextPolicy": "string",
"UserGroupResolutionConfiguration": {
"UserGroupResolutionMode": "string"
},
"UserTokenConfigurations": [
{
"JsonTokenTypeConfiguration": {
"GroupAttributeField": "string",
"UserNameAttributeField": "string"
},
"JwtTokenTypeConfiguration": {
"ClaimRegex": "string",
"GroupAttributeField": "string",
"Issuer": "string",
"KeyLocation": "string",
"SecretManagerArn": "string",
"URL": "string",
"UserNameAttributeField": "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_CreateIndex_RequestSyntax) **
A token that you provide to identify the request to create an index. Multiple calls to the `CreateIndex` API with the same client token will create only one index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** [Description](#API_CreateIndex_RequestSyntax) **
A description for the index.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
Required: No
** [Edition](#API_CreateIndex_RequestSyntax) **
The Amazon Kendra edition to use for the index. Choose `DEVELOPER_EDITION` for indexes intended for development, testing, or proof of concept. Use `ENTERPRISE_EDITION` for production. Use `GEN_AI_ENTERPRISE_EDITION` for creating generative AI applications. Once you set the edition for an index, it can't be changed.
The `Edition` parameter is optional. If you don't supply a value, the default is `ENTERPRISE_EDITION`.
For more information on quota limits for Gen AI Enterprise Edition, Enterprise Edition, and Developer Edition indices, see [Quotas](https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
Type: String
Valid Values: `DEVELOPER_EDITION | ENTERPRISE_EDITION | GEN_AI_ENTERPRISE_EDITION`
Required: No
** [Name](#API_CreateIndex_RequestSyntax) **
A name for the index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [RoleArn](#API_CreateIndex_RequestSyntax) **
The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. 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
** [ServerSideEncryptionConfiguration](#API_CreateIndex_RequestSyntax) **
The identifier of the AWS KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.
Type: [ServerSideEncryptionConfiguration](API_ServerSideEncryptionConfiguration.md) object
Required: No
** [Tags](#API_CreateIndex_RequestSyntax) **
A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. 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
** [UserContextPolicy](#API_CreateIndex_RequestSyntax) **
The user context policy.
If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use `ATTRIBUTE_FILTER` to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use `USER_TOKEN` to configure user context policy, Amazon Kendra returns a `ValidationException` error.
ATTRIBUTE\$1FILTER
All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of `_user_id` and `_group_ids` or you can provide user and group information in `UserContext`.
USER\$1TOKEN
Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.
Type: String
Valid Values: `ATTRIBUTE_FILTER | USER_TOKEN`
Required: No
** [UserGroupResolutionConfiguration](#API_CreateIndex_RequestSyntax) **
Gets users and groups from AWS IAM Identity Center identity source. To configure this, see [UserGroupResolutionConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html). This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
If you're using an Amazon Kendra Gen AI Enterprise Edition index, `UserGroupResolutionConfiguration` isn't supported.
Type: [UserGroupResolutionConfiguration](API_UserGroupResolutionConfiguration.md) object
Required: No
** [UserTokenConfigurations](#API_CreateIndex_RequestSyntax) **
The user token configuration.
If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use `UserTokenConfigurations` to configure user context policy, Amazon Kendra returns a `ValidationException` error.
Type: Array of [UserTokenConfiguration](API_UserTokenConfiguration.md) objects
Array Members: Maximum number of 1 item.
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_CreateIndex_ResponseSyntax) **
The identifier of the index. Use this identifier when you query an index, set up a data source, or index a document.
Type: String
Length Constraints: Fixed length of 36.
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
** ResourceAlreadyExistException **
The resource you want to use already exists. 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/CreateIndex)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/CreateIndex)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/CreateIndex)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/CreateIndex)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/CreateIndex)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/CreateIndex)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/CreateIndex)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/CreateIndex)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/CreateIndex)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/CreateIndex)
# CreateQuerySuggestionsBlockList
Creates a block list to exlcude certain queries from suggestions.
Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.
You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.
For information on the current quota limits for block lists, see [Quotas for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
`CreateQuerySuggestionsBlockList` is currently not supported in the AWS GovCloud (US-West) region.
For an example of creating a block list for query suggestions using the Python SDK, see [Query suggestions block list](https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist).
## 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_CreateQuerySuggestionsBlockList_RequestSyntax) **
A token that you provide to identify the request to create a query suggestions block list.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** [Description](#API_CreateQuerySuggestionsBlockList_RequestSyntax) **
A description for the block list.
For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
Required: No
** [IndexId](#API_CreateQuerySuggestionsBlockList_RequestSyntax) **
The identifier of the index you want to create a query suggestions block list for.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [Name](#API_CreateQuerySuggestionsBlockList_RequestSyntax) **
A name for the block list.
For example, the name 'offensive-words', which includes all offensive words that could appear in user queries and need to be blocked from suggestions.
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_CreateQuerySuggestionsBlockList_RequestSyntax) **
The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the block list text 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_CreateQuerySuggestionsBlockList_RequestSyntax) **
The S3 path to your block list text file in your S3 bucket.
Each block word or phrase should be on a separate line in a text file.
For information on the current quota limits for block lists, see [Quotas for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
Type: [S3Path](API_S3Path.md) object
Required: Yes
** [Tags](#API_CreateQuerySuggestionsBlockList_RequestSyntax) **
A list of key-value pairs that identify or categorize the block list. 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_CreateQuerySuggestionsBlockList_ResponseSyntax) **
The identifier of the block list.
Type: String
Length Constraints: Fixed length of 36.
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/CreateQuerySuggestionsBlockList)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/CreateQuerySuggestionsBlockList)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/CreateQuerySuggestionsBlockList)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/CreateQuerySuggestionsBlockList)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/CreateQuerySuggestionsBlockList)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/CreateQuerySuggestionsBlockList)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/CreateQuerySuggestionsBlockList)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/CreateQuerySuggestionsBlockList)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/CreateQuerySuggestionsBlockList)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/CreateQuerySuggestionsBlockList)
# 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)
# DeleteAccessControlConfiguration
Deletes an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
## Request Syntax
```
{
"Id": "string",
"IndexId": "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.
** [Id](#API_DeleteAccessControlConfiguration_RequestSyntax) **
The identifier of the access control configuration you want to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9-]+`
Required: Yes
** [IndexId](#API_DeleteAccessControlConfiguration_RequestSyntax) **
The identifier of the index for an access control configuration.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** 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/DeleteAccessControlConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DeleteAccessControlConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DeleteAccessControlConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DeleteAccessControlConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DeleteAccessControlConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DeleteAccessControlConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DeleteAccessControlConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DeleteAccessControlConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DeleteAccessControlConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DeleteAccessControlConfiguration)
# DeleteDataSource
Deletes an Amazon Kendra data source connector. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the `Status` field returned by a call to the `DescribeDataSource` API is set to `DELETING`. For more information, see [Deleting Data Sources](https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html).
Deleting an entire data source or re-syncing your index after deleting specific documents from a data source could take up to an hour or more, depending on the number of documents you want to delete.
## Request Syntax
```
{
"Id": "string",
"IndexId": "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.
** [Id](#API_DeleteDataSource_RequestSyntax) **
The identifier of the data source connector you want to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_DeleteDataSource_RequestSyntax) **
The identifier of the index used with the data source connector.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** 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/DeleteDataSource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DeleteDataSource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DeleteDataSource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DeleteDataSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DeleteDataSource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DeleteDataSource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DeleteDataSource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DeleteDataSource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DeleteDataSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DeleteDataSource)
# DeleteExperience
Deletes your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see [Building a search experience with no code](https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).
## Request Syntax
```
{
"Id": "string",
"IndexId": "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.
** [Id](#API_DeleteExperience_RequestSyntax) **
The identifier of your Amazon Kendra experience you want to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_DeleteExperience_RequestSyntax) **
The identifier of the index for your Amazon Kendra experience.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** 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/DeleteExperience)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DeleteExperience)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DeleteExperience)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DeleteExperience)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DeleteExperience)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DeleteExperience)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DeleteExperience)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DeleteExperience)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DeleteExperience)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DeleteExperience)
# DeleteFaq
Removes a FAQ from an index.
## Request Syntax
```
{
"Id": "string",
"IndexId": "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.
** [Id](#API_DeleteFaq_RequestSyntax) **
The identifier of the FAQ you want to remove.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_DeleteFaq_RequestSyntax) **
The identifier of the index for the FAQ.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** 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/DeleteFaq)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DeleteFaq)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DeleteFaq)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DeleteFaq)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DeleteFaq)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DeleteFaq)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DeleteFaq)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DeleteFaq)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DeleteFaq)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DeleteFaq)
# DeleteIndex
Deletes an Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the `Status` field returned by a call to the `DescribeIndex` API is set to `DELETING`.
## Request Syntax
```
{
"Id": "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.
** [Id](#API_DeleteIndex_RequestSyntax) **
The identifier of the index you want to delete.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** 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/DeleteIndex)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DeleteIndex)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DeleteIndex)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DeleteIndex)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DeleteIndex)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DeleteIndex)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DeleteIndex)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DeleteIndex)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DeleteIndex)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DeleteIndex)
# DeletePrincipalMapping
Deletes a group so that all users that belong to the group can no longer access documents only available to that group.
For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results.
If you want to delete or replace users or sub groups of a group, you need to use the `PutPrincipalMapping` operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling `PutPrincipalMapping`. You can update your internal list of users or sub groups and input this list when calling `PutPrincipalMapping`.
`DeletePrincipalMapping` is currently not supported in the AWS GovCloud (US-West) region.
## Request Syntax
```
{
"DataSourceId": "string",
"GroupId": "string",
"IndexId": "string",
"OrderingId": number
}
```
## 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.
** [DataSourceId](#API_DeletePrincipalMapping_RequestSyntax) **
The identifier of the data source you want to delete a group from.
A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** [GroupId](#API_DeletePrincipalMapping_RequestSyntax) **
The identifier of the group you want to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `^\P{C}*$`
Required: Yes
** [IndexId](#API_DeletePrincipalMapping_RequestSyntax) **
The identifier of the index you want to delete a group from.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [OrderingId](#API_DeletePrincipalMapping_RequestSyntax) **
The timestamp identifier you specify to ensure Amazon Kendra does not override the latest `DELETE` action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.
The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling `PutPrincipalMapping`. This ensures your `DELETE` action for that updated group with the latest members list doesn't get overwritten by earlier `DELETE` actions for the same group which are yet to be processed.
The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.
Type: Long
Valid Range: Minimum value of 0. Maximum value of 32535158400000.
Required: No
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** 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/DeletePrincipalMapping)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DeletePrincipalMapping)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DeletePrincipalMapping)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DeletePrincipalMapping)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DeletePrincipalMapping)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DeletePrincipalMapping)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DeletePrincipalMapping)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DeletePrincipalMapping)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DeletePrincipalMapping)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DeletePrincipalMapping)
# DeleteQuerySuggestionsBlockList
Deletes a block list used for query suggestions for an index.
A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.
`DeleteQuerySuggestionsBlockList` is currently not supported in the AWS GovCloud (US-West) region.
## Request Syntax
```
{
"Id": "string",
"IndexId": "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.
** [Id](#API_DeleteQuerySuggestionsBlockList_RequestSyntax) **
The identifier of the block list you want to delete.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [IndexId](#API_DeleteQuerySuggestionsBlockList_RequestSyntax) **
The identifier of the index for the block list.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** 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/DeleteQuerySuggestionsBlockList)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DeleteQuerySuggestionsBlockList)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DeleteQuerySuggestionsBlockList)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DeleteQuerySuggestionsBlockList)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DeleteQuerySuggestionsBlockList)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DeleteQuerySuggestionsBlockList)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DeleteQuerySuggestionsBlockList)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DeleteQuerySuggestionsBlockList)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DeleteQuerySuggestionsBlockList)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DeleteQuerySuggestionsBlockList)
# DeleteThesaurus
Deletes an Amazon Kendra thesaurus.
## Request Syntax
```
{
"Id": "string",
"IndexId": "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.
** [Id](#API_DeleteThesaurus_RequestSyntax) **
The identifier of the thesaurus you want to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_DeleteThesaurus_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
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** 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/DeleteThesaurus)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DeleteThesaurus)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DeleteThesaurus)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DeleteThesaurus)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DeleteThesaurus)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DeleteThesaurus)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DeleteThesaurus)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DeleteThesaurus)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DeleteThesaurus)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DeleteThesaurus)
# DescribeAccessControlConfiguration
Gets information about an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
## Request Syntax
```
{
"Id": "string",
"IndexId": "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.
** [Id](#API_DescribeAccessControlConfiguration_RequestSyntax) **
The identifier of the access control configuration you want to get information on.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9-]+`
Required: Yes
** [IndexId](#API_DescribeAccessControlConfiguration_RequestSyntax) **
The identifier of the index for an access control configuration.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Syntax
```
{
"AccessControlList": [
{
"Access": "string",
"DataSourceId": "string",
"Name": "string",
"Type": "string"
}
],
"Description": "string",
"ErrorMessage": "string",
"HierarchicalAccessControlList": [
{
"PrincipalList": [
{
"Access": "string",
"DataSourceId": "string",
"Name": "string",
"Type": "string"
}
]
}
],
"Name": "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.
** [AccessControlList](#API_DescribeAccessControlConfiguration_ResponseSyntax) **
Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
Type: Array of [Principal](API_Principal.md) objects
** [Description](#API_DescribeAccessControlConfiguration_ResponseSyntax) **
The description for the access control configuration.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
** [ErrorMessage](#API_DescribeAccessControlConfiguration_ResponseSyntax) **
The error message containing details if there are issues processing the access control configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
** [HierarchicalAccessControlList](#API_DescribeAccessControlConfiguration_ResponseSyntax) **
The list of [principal](https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) lists that define the hierarchy for which documents users should have access to.
Type: Array of [HierarchicalPrincipal](API_HierarchicalPrincipal.md) objects
Array Members: Minimum number of 1 item. Maximum number of 30 items.
** [Name](#API_DescribeAccessControlConfiguration_ResponseSyntax) **
The name for the access control configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `[\S\s]*`
## 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
** 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
** 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/DescribeAccessControlConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DescribeAccessControlConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DescribeAccessControlConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DescribeAccessControlConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DescribeAccessControlConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DescribeAccessControlConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DescribeAccessControlConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DescribeAccessControlConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DescribeAccessControlConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DescribeAccessControlConfiguration)
# DescribeDataSource
Gets information about an Amazon Kendra data source connector.
## Request Syntax
```
{
"Id": "string",
"IndexId": "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.
** [Id](#API_DescribeDataSource_RequestSyntax) **
The identifier of the data source connector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_DescribeDataSource_RequestSyntax) **
The identifier of the index used with the data source connector.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Syntax
```
{
"Configuration": {
"AlfrescoConfiguration": {
"BlogFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"CrawlComments": boolean,
"CrawlSystemFolders": boolean,
"DocumentLibraryFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"EntityFilter": [ "string" ],
"ExclusionPatterns": [ "string" ],
"InclusionPatterns": [ "string" ],
"SecretArn": "string",
"SiteId": "string",
"SiteUrl": "string",
"SslCertificateS3Path": {
"Bucket": "string",
"Key": "string"
},
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
},
"WikiFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"BoxConfiguration": {
"CommentFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"CrawlComments": boolean,
"CrawlTasks": boolean,
"CrawlWebLinks": boolean,
"EnterpriseId": "string",
"ExclusionPatterns": [ "string" ],
"FileFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"SecretArn": "string",
"TaskFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"UseChangeLog": boolean,
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
},
"WebLinkFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"ConfluenceConfiguration": {
"AttachmentConfiguration": {
"AttachmentFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"CrawlAttachments": boolean
},
"AuthenticationType": "string",
"BlogConfiguration": {
"BlogFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"ExclusionPatterns": [ "string" ],
"InclusionPatterns": [ "string" ],
"PageConfiguration": {
"PageFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"ProxyConfiguration": {
"Credentials": "string",
"Host": "string",
"Port": number
},
"SecretArn": "string",
"ServerUrl": "string",
"SpaceConfiguration": {
"CrawlArchivedSpaces": boolean,
"CrawlPersonalSpaces": boolean,
"ExcludeSpaces": [ "string" ],
"IncludeSpaces": [ "string" ],
"SpaceFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"Version": "string",
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"DatabaseConfiguration": {
"AclConfiguration": {
"AllowedGroupsColumnName": "string"
},
"ColumnConfiguration": {
"ChangeDetectingColumns": [ "string" ],
"DocumentDataColumnName": "string",
"DocumentIdColumnName": "string",
"DocumentTitleColumnName": "string",
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"ConnectionConfiguration": {
"DatabaseHost": "string",
"DatabaseName": "string",
"DatabasePort": number,
"SecretArn": "string",
"TableName": "string"
},
"DatabaseEngineType": "string",
"SqlConfiguration": {
"QueryIdentifiersEnclosingOption": "string"
},
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"FsxConfiguration": {
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"FileSystemId": "string",
"FileSystemType": "string",
"InclusionPatterns": [ "string" ],
"SecretArn": "string",
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"GitHubConfiguration": {
"ExclusionFileNamePatterns": [ "string" ],
"ExclusionFileTypePatterns": [ "string" ],
"ExclusionFolderNamePatterns": [ "string" ],
"GitHubCommitConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubDocumentCrawlProperties": {
"CrawlIssue": boolean,
"CrawlIssueComment": boolean,
"CrawlIssueCommentAttachment": boolean,
"CrawlPullRequest": boolean,
"CrawlPullRequestComment": boolean,
"CrawlPullRequestCommentAttachment": boolean,
"CrawlRepositoryDocuments": boolean
},
"GitHubIssueAttachmentConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubIssueCommentConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubIssueDocumentConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubPullRequestCommentConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubPullRequestDocumentAttachmentConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubPullRequestDocumentConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubRepositoryConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionFileNamePatterns": [ "string" ],
"InclusionFileTypePatterns": [ "string" ],
"InclusionFolderNamePatterns": [ "string" ],
"OnPremiseConfiguration": {
"HostUrl": "string",
"OrganizationName": "string",
"SslCertificateS3Path": {
"Bucket": "string",
"Key": "string"
}
},
"RepositoryFilter": [ "string" ],
"SaaSConfiguration": {
"HostUrl": "string",
"OrganizationName": "string"
},
"SecretArn": "string",
"Type": "string",
"UseChangeLog": boolean,
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"GoogleDriveConfiguration": {
"ExcludeMimeTypes": [ "string" ],
"ExcludeSharedDrives": [ "string" ],
"ExcludeUserAccounts": [ "string" ],
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"SecretArn": "string"
},
"JiraConfiguration": {
"AttachmentFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"CommentFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"ExclusionPatterns": [ "string" ],
"InclusionPatterns": [ "string" ],
"IssueFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"IssueSubEntityFilter": [ "string" ],
"IssueType": [ "string" ],
"JiraAccountUrl": "string",
"Project": [ "string" ],
"ProjectFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"SecretArn": "string",
"Status": [ "string" ],
"UseChangeLog": boolean,
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
},
"WorkLogFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"OneDriveConfiguration": {
"DisableLocalGroups": boolean,
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"OneDriveUsers": {
"OneDriveUserList": [ "string" ],
"OneDriveUserS3Path": {
"Bucket": "string",
"Key": "string"
}
},
"SecretArn": "string",
"TenantDomain": "string"
},
"QuipConfiguration": {
"AttachmentFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"CrawlAttachments": boolean,
"CrawlChatRooms": boolean,
"CrawlFileComments": boolean,
"Domain": "string",
"ExclusionPatterns": [ "string" ],
"FolderIds": [ "string" ],
"InclusionPatterns": [ "string" ],
"MessageFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"SecretArn": "string",
"ThreadFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"S3Configuration": {
"AccessControlListConfiguration": {
"KeyPath": "string"
},
"BucketName": "string",
"DocumentsMetadataConfiguration": {
"S3Prefix": "string"
},
"ExclusionPatterns": [ "string" ],
"InclusionPatterns": [ "string" ],
"InclusionPrefixes": [ "string" ]
},
"SalesforceConfiguration": {
"ChatterFeedConfiguration": {
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"IncludeFilterTypes": [ "string" ]
},
"CrawlAttachments": boolean,
"ExcludeAttachmentFilePatterns": [ "string" ],
"IncludeAttachmentFilePatterns": [ "string" ],
"KnowledgeArticleConfiguration": {
"CustomKnowledgeArticleTypeConfigurations": [
{
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"Name": "string"
}
],
"IncludedStates": [ "string" ],
"StandardKnowledgeArticleTypeConfiguration": {
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
}
},
"SecretArn": "string",
"ServerUrl": "string",
"StandardObjectAttachmentConfiguration": {
"DocumentTitleFieldName": "string",
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"StandardObjectConfigurations": [
{
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"Name": "string"
}
]
},
"ServiceNowConfiguration": {
"AuthenticationType": "string",
"HostUrl": "string",
"KnowledgeArticleConfiguration": {
"CrawlAttachments": boolean,
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"ExcludeAttachmentFilePatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"FilterQuery": "string",
"IncludeAttachmentFilePatterns": [ "string" ]
},
"SecretArn": "string",
"ServiceCatalogConfiguration": {
"CrawlAttachments": boolean,
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"ExcludeAttachmentFilePatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"IncludeAttachmentFilePatterns": [ "string" ]
},
"ServiceNowBuildVersion": "string"
},
"SharePointConfiguration": {
"AuthenticationType": "string",
"CrawlAttachments": boolean,
"DisableLocalGroups": boolean,
"DocumentTitleFieldName": "string",
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"ProxyConfiguration": {
"Credentials": "string",
"Host": "string",
"Port": number
},
"SecretArn": "string",
"SharePointVersion": "string",
"SslCertificateS3Path": {
"Bucket": "string",
"Key": "string"
},
"Urls": [ "string" ],
"UseChangeLog": boolean,
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"SlackConfiguration": {
"CrawlBotMessage": boolean,
"ExcludeArchived": boolean,
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"LookBackPeriod": number,
"PrivateChannelFilter": [ "string" ],
"PublicChannelFilter": [ "string" ],
"SecretArn": "string",
"SinceCrawlDate": "string",
"SlackEntityList": [ "string" ],
"TeamId": "string",
"UseChangeLog": boolean,
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"TemplateConfiguration": {
"Template": JSON value
},
"WebCrawlerConfiguration": {
"AuthenticationConfiguration": {
"BasicAuthentication": [
{
"Credentials": "string",
"Host": "string",
"Port": number
}
]
},
"CrawlDepth": number,
"MaxContentSizePerPageInMegaBytes": number,
"MaxLinksPerPage": number,
"MaxUrlsPerMinuteCrawlRate": number,
"ProxyConfiguration": {
"Credentials": "string",
"Host": "string",
"Port": number
},
"UrlExclusionPatterns": [ "string" ],
"UrlInclusionPatterns": [ "string" ],
"Urls": {
"SeedUrlConfiguration": {
"SeedUrls": [ "string" ],
"WebCrawlerMode": "string"
},
"SiteMapsConfiguration": {
"SiteMaps": [ "string" ]
}
}
},
"WorkDocsConfiguration": {
"CrawlComments": boolean,
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"OrganizationId": "string",
"UseChangeLog": boolean
}
},
"CreatedAt": number,
"CustomDocumentEnrichmentConfiguration": {
"InlineConfigurations": [
{
"Condition": {
"ConditionDocumentAttributeKey": "string",
"ConditionOnValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"Operator": "string"
},
"DocumentContentDeletion": boolean,
"Target": {
"TargetDocumentAttributeKey": "string",
"TargetDocumentAttributeValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"TargetDocumentAttributeValueDeletion": boolean
}
}
],
"PostExtractionHookConfiguration": {
"InvocationCondition": {
"ConditionDocumentAttributeKey": "string",
"ConditionOnValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"Operator": "string"
},
"LambdaArn": "string",
"S3Bucket": "string"
},
"PreExtractionHookConfiguration": {
"InvocationCondition": {
"ConditionDocumentAttributeKey": "string",
"ConditionOnValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"Operator": "string"
},
"LambdaArn": "string",
"S3Bucket": "string"
},
"RoleArn": "string"
},
"Description": "string",
"ErrorMessage": "string",
"Id": "string",
"IndexId": "string",
"LanguageCode": "string",
"Name": "string",
"RoleArn": "string",
"Schedule": "string",
"Status": "string",
"Type": "string",
"UpdatedAt": number,
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "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.
** [Configuration](#API_DescribeDataSource_ResponseSyntax) **
Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.
Type: [DataSourceConfiguration](API_DataSourceConfiguration.md) object
** [CreatedAt](#API_DescribeDataSource_ResponseSyntax) **
The Unix timestamp when the data source connector was created.
Type: Timestamp
** [CustomDocumentEnrichmentConfiguration](#API_DescribeDataSource_ResponseSyntax) **
Configuration information for altering document metadata and content during the document ingestion process when you describe a data source.
For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see [Customizing document metadata during the ingestion process](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).
Type: [CustomDocumentEnrichmentConfiguration](API_CustomDocumentEnrichmentConfiguration.md) object
** [Description](#API_DescribeDataSource_ResponseSyntax) **
The description for the data source connector.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
** [ErrorMessage](#API_DescribeDataSource_ResponseSyntax) **
When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a description of the error that caused the data source to fail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
** [Id](#API_DescribeDataSource_ResponseSyntax) **
The identifier of the data source connector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
** [IndexId](#API_DescribeDataSource_ResponseSyntax) **
The identifier of the index used with the data source connector.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
** [LanguageCode](#API_DescribeDataSource_ResponseSyntax) **
The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see [Adding documents in languages other than English](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
Type: String
Length Constraints: Minimum length of 2. Maximum length of 10.
Pattern: `[a-zA-Z-]*`
** [Name](#API_DescribeDataSource_ResponseSyntax) **
The name for the data source connector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
** [RoleArn](#API_DescribeDataSource_ResponseSyntax) **
The Amazon Resource Name (ARN) of the IAM role with permission to access the data source and required resources.
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}`
** [Schedule](#API_DescribeDataSource_ResponseSyntax) **
The schedule for Amazon Kendra to update the index.
Type: String
** [Status](#API_DescribeDataSource_ResponseSyntax) **
The current status of the data source connector. When the status is `ACTIVE` the data source is ready to use. When the status is `FAILED`, the `ErrorMessage` field contains the reason that the data source failed.
Type: String
Valid Values: `CREATING | DELETING | FAILED | UPDATING | ACTIVE`
** [Type](#API_DescribeDataSource_ResponseSyntax) **
The type of the data source. For example, `SHAREPOINT`.
Type: String
Valid Values: `S3 | SHAREPOINT | DATABASE | SALESFORCE | ONEDRIVE | SERVICENOW | CUSTOM | CONFLUENCE | GOOGLEDRIVE | WEBCRAWLER | WORKDOCS | FSX | SLACK | BOX | QUIP | JIRA | GITHUB | ALFRESCO | TEMPLATE`
** [UpdatedAt](#API_DescribeDataSource_ResponseSyntax) **
The Unix timestamp when the data source connector was last updated.
Type: Timestamp
** [VpcConfiguration](#API_DescribeDataSource_ResponseSyntax) **
Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see [Configuring a VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
Type: [DataSourceVpcConfiguration](API_DataSourceVpcConfiguration.md) object
## 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
** 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
** 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/DescribeDataSource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DescribeDataSource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DescribeDataSource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DescribeDataSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DescribeDataSource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DescribeDataSource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DescribeDataSource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DescribeDataSource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DescribeDataSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DescribeDataSource)
# DescribeExperience
Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see [Building a search experience with no code](https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).
## Request Syntax
```
{
"Id": "string",
"IndexId": "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.
** [Id](#API_DescribeExperience_RequestSyntax) **
The identifier of your Amazon Kendra experience you want to get information on.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_DescribeExperience_RequestSyntax) **
The identifier of the index for your Amazon Kendra experience.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Syntax
```
{
"Configuration": {
"ContentSourceConfiguration": {
"DataSourceIds": [ "string" ],
"DirectPutContent": boolean,
"FaqIds": [ "string" ]
},
"UserIdentityConfiguration": {
"IdentityAttributeName": "string"
}
},
"CreatedAt": number,
"Description": "string",
"Endpoints": [
{
"Endpoint": "string",
"EndpointType": "string"
}
],
"ErrorMessage": "string",
"Id": "string",
"IndexId": "string",
"Name": "string",
"RoleArn": "string",
"Status": "string",
"UpdatedAt": number
}
```
## 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.
** [Configuration](#API_DescribeExperience_ResponseSyntax) **
Shows the configuration information for your Amazon Kendra experience. This includes `ContentSourceConfiguration`, which specifies the data source IDs and/or FAQ IDs, and `UserIdentityConfiguration`, which specifies the user or group information to grant access to your Amazon Kendra experience.
Type: [ExperienceConfiguration](API_ExperienceConfiguration.md) object
** [CreatedAt](#API_DescribeExperience_ResponseSyntax) **
The Unix timestamp when your Amazon Kendra experience was created.
Type: Timestamp
** [Description](#API_DescribeExperience_ResponseSyntax) **
Shows the description for your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
** [Endpoints](#API_DescribeExperience_ResponseSyntax) **
Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
Type: Array of [ExperienceEndpoint](API_ExperienceEndpoint.md) objects
Array Members: Minimum number of 1 item. Maximum number of 2 items.
** [ErrorMessage](#API_DescribeExperience_ResponseSyntax) **
The reason your Amazon Kendra experience could not properly process.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
** [Id](#API_DescribeExperience_ResponseSyntax) **
Shows the identifier of your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
** [IndexId](#API_DescribeExperience_ResponseSyntax) **
Shows the identifier of the index for your Amazon Kendra experience.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
** [Name](#API_DescribeExperience_ResponseSyntax) **
Shows the name of your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
** [RoleArn](#API_DescribeExperience_ResponseSyntax) **
The Amazon Resource Name (ARN) of the IAM role with permission to access the `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and IAM Identity Center that stores your users and groups information.
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}`
** [Status](#API_DescribeExperience_ResponseSyntax) **
The current processing status of your Amazon Kendra experience. When the status is `ACTIVE`, your Amazon Kendra experience is ready to use. When the status is `FAILED`, the `ErrorMessage` field contains the reason that this failed.
Type: String
Valid Values: `CREATING | ACTIVE | DELETING | FAILED`
** [UpdatedAt](#API_DescribeExperience_ResponseSyntax) **
The Unix timestamp when your Amazon Kendra experience was last updated.
Type: Timestamp
## 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
** 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
** 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/DescribeExperience)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DescribeExperience)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DescribeExperience)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DescribeExperience)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DescribeExperience)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DescribeExperience)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DescribeExperience)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DescribeExperience)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DescribeExperience)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DescribeExperience)
# DescribeFaq
Gets information about a FAQ.
## Request Syntax
```
{
"Id": "string",
"IndexId": "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.
** [Id](#API_DescribeFaq_RequestSyntax) **
The identifier of the FAQ you want to get information on.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_DescribeFaq_RequestSyntax) **
The identifier of the index for the FAQ.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Syntax
```
{
"CreatedAt": number,
"Description": "string",
"ErrorMessage": "string",
"FileFormat": "string",
"Id": "string",
"IndexId": "string",
"LanguageCode": "string",
"Name": "string",
"RoleArn": "string",
"S3Path": {
"Bucket": "string",
"Key": "string"
},
"Status": "string",
"UpdatedAt": number
}
```
## 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.
** [CreatedAt](#API_DescribeFaq_ResponseSyntax) **
The Unix timestamp when the FAQ was created.
Type: Timestamp
** [Description](#API_DescribeFaq_ResponseSyntax) **
The description of the FAQ that you provided when it was created.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
** [ErrorMessage](#API_DescribeFaq_ResponseSyntax) **
If the `Status` field is `FAILED`, the `ErrorMessage` field contains the reason why the FAQ failed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
** [FileFormat](#API_DescribeFaq_ResponseSyntax) **
The file format used for the FAQ file.
Type: String
Valid Values: `CSV | CSV_WITH_HEADER | JSON`
** [Id](#API_DescribeFaq_ResponseSyntax) **
The identifier of the FAQ.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
** [IndexId](#API_DescribeFaq_ResponseSyntax) **
The identifier of the index for the FAQ.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
** [LanguageCode](#API_DescribeFaq_ResponseSyntax) **
The code for a language. This shows a supported 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](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
Type: String
Length Constraints: Minimum length of 2. Maximum length of 10.
Pattern: `[a-zA-Z-]*`
** [Name](#API_DescribeFaq_ResponseSyntax) **
The name that you gave the FAQ when it was created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
** [RoleArn](#API_DescribeFaq_ResponseSyntax) **
The Amazon Resource Name (ARN) of the IAM role that provides access to the S3 bucket containing the FAQ file.
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}`
** [S3Path](#API_DescribeFaq_ResponseSyntax) **
Information required to find a specific file in an Amazon S3 bucket.
Type: [S3Path](API_S3Path.md) object
** [Status](#API_DescribeFaq_ResponseSyntax) **
The status of the FAQ. It is ready to use when the status is `ACTIVE`.
Type: String
Valid Values: `CREATING | UPDATING | ACTIVE | DELETING | FAILED`
** [UpdatedAt](#API_DescribeFaq_ResponseSyntax) **
The Unix timestamp when the FAQ was last updated.
Type: Timestamp
## 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
** 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
** 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/DescribeFaq)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DescribeFaq)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DescribeFaq)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DescribeFaq)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DescribeFaq)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DescribeFaq)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DescribeFaq)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DescribeFaq)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DescribeFaq)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DescribeFaq)
# DescribeFeaturedResultsSet
Gets information about a set of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
## Request Syntax
```
{
"FeaturedResultsSetId": "string",
"IndexId": "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.
** [FeaturedResultsSetId](#API_DescribeFeaturedResultsSet_RequestSyntax) **
The identifier of the set of featured results that you want to get information on.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `^[a-zA-Z-0-9]*`
Required: Yes
** [IndexId](#API_DescribeFeaturedResultsSet_RequestSyntax) **
The identifier of the index used for featuring results.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Syntax
```
{
"CreationTimestamp": number,
"Description": "string",
"FeaturedDocumentsMissing": [
{
"Id": "string"
}
],
"FeaturedDocumentsWithMetadata": [
{
"Id": "string",
"Title": "string",
"URI": "string"
}
],
"FeaturedResultsSetId": "string",
"FeaturedResultsSetName": "string",
"LastUpdatedTimestamp": number,
"QueryTexts": [ "string" ],
"Status": "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.
** [CreationTimestamp](#API_DescribeFeaturedResultsSet_ResponseSyntax) **
The Unix timestamp when the set of the featured results was created.
Type: Long
** [Description](#API_DescribeFeaturedResultsSet_ResponseSyntax) **
The description for the set of featured results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
** [FeaturedDocumentsMissing](#API_DescribeFeaturedResultsSet_ResponseSyntax) **
The list of document IDs that don't exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the [BatchGetDocumentStatus](https://docs.aws.amazon.com/kendra/latest/dg/API_BatchGetDocumentStatus.html) API.
Type: Array of [FeaturedDocumentMissing](API_FeaturedDocumentMissing.md) objects
** [FeaturedDocumentsWithMetadata](#API_DescribeFeaturedResultsSet_ResponseSyntax) **
The list of document IDs for the documents you want to feature with their metadata information. For more information on the list of featured documents, see [FeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html).
Type: Array of [FeaturedDocumentWithMetadata](API_FeaturedDocumentWithMetadata.md) objects
** [FeaturedResultsSetId](#API_DescribeFeaturedResultsSet_ResponseSyntax) **
The identifier of the set of featured results.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `^[a-zA-Z-0-9]*`
** [FeaturedResultsSetName](#API_DescribeFeaturedResultsSet_ResponseSyntax) **
The name for the set of featured results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][ a-zA-Z0-9_-]*`
** [LastUpdatedTimestamp](#API_DescribeFeaturedResultsSet_ResponseSyntax) **
The timestamp when the set of featured results was last updated.
Type: Long
** [QueryTexts](#API_DescribeFeaturedResultsSet_ResponseSyntax) **
The list of queries for featuring results. For more information on the list of queries, see [FeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html).
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 49 items.
** [Status](#API_DescribeFeaturedResultsSet_ResponseSyntax) **
The current status of the set of featured results. When the value is `ACTIVE`, featured results are ready for use. You can still configure your settings before setting the status to `ACTIVE`. You can set the status to `ACTIVE` or `INACTIVE` using the [UpdateFeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html) API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is `ACTIVE` or `INACTIVE`.
Type: String
Valid Values: `ACTIVE | INACTIVE`
## 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
** 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
** 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/DescribeFeaturedResultsSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DescribeFeaturedResultsSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DescribeFeaturedResultsSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DescribeFeaturedResultsSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DescribeFeaturedResultsSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DescribeFeaturedResultsSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DescribeFeaturedResultsSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DescribeFeaturedResultsSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DescribeFeaturedResultsSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DescribeFeaturedResultsSet)
# DescribeIndex
Gets information about an Amazon Kendra index.
## Request Syntax
```
{
"Id": "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.
** [Id](#API_DescribeIndex_RequestSyntax) **
The identifier of the index you want to get information on.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Syntax
```
{
"CapacityUnits": {
"QueryCapacityUnits": number,
"StorageCapacityUnits": number
},
"CreatedAt": number,
"Description": "string",
"DocumentMetadataConfigurations": [
{
"Name": "string",
"Relevance": {
"Duration": "string",
"Freshness": boolean,
"Importance": number,
"RankOrder": "string",
"ValueImportanceMap": {
"string" : number
}
},
"Search": {
"Displayable": boolean,
"Facetable": boolean,
"Searchable": boolean,
"Sortable": boolean
},
"Type": "string"
}
],
"Edition": "string",
"ErrorMessage": "string",
"Id": "string",
"IndexStatistics": {
"FaqStatistics": {
"IndexedQuestionAnswersCount": number
},
"TextDocumentStatistics": {
"IndexedTextBytes": number,
"IndexedTextDocumentsCount": number
}
},
"Name": "string",
"RoleArn": "string",
"ServerSideEncryptionConfiguration": {
"KmsKeyId": "string"
},
"Status": "string",
"UpdatedAt": number,
"UserContextPolicy": "string",
"UserGroupResolutionConfiguration": {
"UserGroupResolutionMode": "string"
},
"UserTokenConfigurations": [
{
"JsonTokenTypeConfiguration": {
"GroupAttributeField": "string",
"UserNameAttributeField": "string"
},
"JwtTokenTypeConfiguration": {
"ClaimRegex": "string",
"GroupAttributeField": "string",
"Issuer": "string",
"KeyLocation": "string",
"SecretManagerArn": "string",
"URL": "string",
"UserNameAttributeField": "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.
** [CapacityUnits](#API_DescribeIndex_ResponseSyntax) **
For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see [Adjusting capacity](https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html).
Type: [CapacityUnitsConfiguration](API_CapacityUnitsConfiguration.md) object
** [CreatedAt](#API_DescribeIndex_ResponseSyntax) **
The Unix timestamp when the index was created.
Type: Timestamp
** [Description](#API_DescribeIndex_ResponseSyntax) **
The description for the index.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
** [DocumentMetadataConfigurations](#API_DescribeIndex_ResponseSyntax) **
Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
Type: Array of [DocumentMetadataConfiguration](API_DocumentMetadataConfiguration.md) objects
Array Members: Minimum number of 0 items. Maximum number of 500 items.
** [Edition](#API_DescribeIndex_ResponseSyntax) **
The Amazon Kendra edition used for the index. You decide the edition when you create the index.
Type: String
Valid Values: `DEVELOPER_EDITION | ENTERPRISE_EDITION | GEN_AI_ENTERPRISE_EDITION`
** [ErrorMessage](#API_DescribeIndex_ResponseSyntax) **
When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a message that explains why.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
** [Id](#API_DescribeIndex_ResponseSyntax) **
The identifier of the index.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
** [IndexStatistics](#API_DescribeIndex_ResponseSyntax) **
Provides information about the number of FAQ questions and answers and the number of text documents indexed.
Type: [IndexStatistics](API_IndexStatistics.md) object
** [Name](#API_DescribeIndex_ResponseSyntax) **
The name of the index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
** [RoleArn](#API_DescribeIndex_ResponseSyntax) **
The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.
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}`
** [ServerSideEncryptionConfiguration](#API_DescribeIndex_ResponseSyntax) **
The identifier of the AWS KMS customer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
Type: [ServerSideEncryptionConfiguration](API_ServerSideEncryptionConfiguration.md) object
** [Status](#API_DescribeIndex_ResponseSyntax) **
The current status of the index. When the value is `ACTIVE`, the index is ready for use. If the `Status` field value is `FAILED`, the `ErrorMessage` field contains a message that explains why.
Type: String
Valid Values: `CREATING | ACTIVE | DELETING | FAILED | UPDATING | SYSTEM_UPDATING`
** [UpdatedAt](#API_DescribeIndex_ResponseSyntax) **
The Unix timestamp when the index was last updated.
Type: Timestamp
** [UserContextPolicy](#API_DescribeIndex_ResponseSyntax) **
The user context policy for the Amazon Kendra index.
Type: String
Valid Values: `ATTRIBUTE_FILTER | USER_TOKEN`
** [UserGroupResolutionConfiguration](#API_DescribeIndex_ResponseSyntax) **
Whether you have enabled AWS IAM Identity Center identity source for your users and groups. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
Type: [UserGroupResolutionConfiguration](API_UserGroupResolutionConfiguration.md) object
** [UserTokenConfigurations](#API_DescribeIndex_ResponseSyntax) **
The user token configuration for the Amazon Kendra index.
Type: Array of [UserTokenConfiguration](API_UserTokenConfiguration.md) objects
Array Members: Maximum number of 1 item.
## 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
** 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
** 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/DescribeIndex)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DescribeIndex)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DescribeIndex)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DescribeIndex)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DescribeIndex)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DescribeIndex)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DescribeIndex)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DescribeIndex)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DescribeIndex)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DescribeIndex)
# DescribePrincipalMapping
Describes the processing of `PUT` and `DELETE` actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed.
`DescribePrincipalMapping` is currently not supported in the AWS GovCloud (US-West) region.
## Request Syntax
```
{
"DataSourceId": "string",
"GroupId": "string",
"IndexId": "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.
** [DataSourceId](#API_DescribePrincipalMapping_RequestSyntax) **
The identifier of the data source to check the processing of `PUT` and `DELETE` actions for mapping users to their groups.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** [GroupId](#API_DescribePrincipalMapping_RequestSyntax) **
The identifier of the group required to check the processing of `PUT` and `DELETE` actions for mapping users to their groups.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `^\P{C}*$`
Required: Yes
** [IndexId](#API_DescribePrincipalMapping_RequestSyntax) **
The identifier of the index required to check the processing of `PUT` and `DELETE` actions for mapping users to their groups.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Syntax
```
{
"DataSourceId": "string",
"GroupId": "string",
"GroupOrderingIdSummaries": [
{
"FailureReason": "string",
"LastUpdatedAt": number,
"OrderingId": number,
"ReceivedAt": number,
"Status": "string"
}
],
"IndexId": "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.
** [DataSourceId](#API_DescribePrincipalMapping_ResponseSyntax) **
Shows the identifier of the data source to see information on the processing of `PUT` and `DELETE` actions for mapping users to their groups.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
** [GroupId](#API_DescribePrincipalMapping_ResponseSyntax) **
Shows the identifier of the group to see information on the processing of `PUT` and `DELETE` actions for mapping users to their groups.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `^\P{C}*$`
** [GroupOrderingIdSummaries](#API_DescribePrincipalMapping_ResponseSyntax) **
Shows the following information on the processing of `PUT` and `DELETE` actions for mapping users to their groups:
+ Status—the status can be either `PROCESSING`, `SUCCEEDED`, `DELETING`, `DELETED`, or `FAILED`.
+ Last updated—the last date-time an action was updated.
+ Received—the last date-time an action was received or submitted.
+ Ordering ID—the latest action that should process and apply after other actions.
+ Failure reason—the reason an action could not be processed.
Type: Array of [GroupOrderingIdSummary](API_GroupOrderingIdSummary.md) objects
Array Members: Maximum number of 10 items.
** [IndexId](#API_DescribePrincipalMapping_ResponseSyntax) **
Shows the identifier of the index to see information on the processing of `PUT` and `DELETE` actions for mapping users to their groups.
Type: String
Length Constraints: Fixed length of 36.
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
** 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
** 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/DescribePrincipalMapping)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DescribePrincipalMapping)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DescribePrincipalMapping)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DescribePrincipalMapping)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DescribePrincipalMapping)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DescribePrincipalMapping)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DescribePrincipalMapping)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DescribePrincipalMapping)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DescribePrincipalMapping)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DescribePrincipalMapping)
# DescribeQuerySuggestionsBlockList
Gets information about a block list used for query suggestions for an index.
This is used to check the current settings that are applied to a block list.
`DescribeQuerySuggestionsBlockList` is currently not supported in the AWS GovCloud (US-West) region.
## Request Syntax
```
{
"Id": "string",
"IndexId": "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.
** [Id](#API_DescribeQuerySuggestionsBlockList_RequestSyntax) **
The identifier of the block list you want to get information on.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [IndexId](#API_DescribeQuerySuggestionsBlockList_RequestSyntax) **
The identifier of the index for the block list.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Syntax
```
{
"CreatedAt": number,
"Description": "string",
"ErrorMessage": "string",
"FileSizeBytes": number,
"Id": "string",
"IndexId": "string",
"ItemCount": number,
"Name": "string",
"RoleArn": "string",
"SourceS3Path": {
"Bucket": "string",
"Key": "string"
},
"Status": "string",
"UpdatedAt": number
}
```
## 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.
** [CreatedAt](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **
The Unix timestamp when a block list for query suggestions was created.
Type: Timestamp
** [Description](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **
The description for the block list.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
** [ErrorMessage](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **
The error message containing details if there are issues processing the block list.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
** [FileSizeBytes](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **
The current size of the block list text file in S3.
Type: Long
** [Id](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **
The identifier of the block list.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
** [IndexId](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **
The identifier of the index for the block list.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
** [ItemCount](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **
The current number of valid, non-empty words or phrases in the block list text file.
Type: Integer
** [Name](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **
The name of the block list.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*`
** [RoleArn](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **
The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.
The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.
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}`
** [SourceS3Path](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **
Shows the current S3 path to your block list text file in your S3 bucket.
Each block word or phrase should be on a separate line in a text file.
For information on the current quota limits for block lists, see [Quotas for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
Type: [S3Path](API_S3Path.md) object
** [Status](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **
The current status of the block list. When the value is `ACTIVE`, the block list is ready for use.
Type: String
Valid Values: `ACTIVE | CREATING | DELETING | UPDATING | ACTIVE_BUT_UPDATE_FAILED | FAILED`
** [UpdatedAt](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **
The Unix timestamp when a block list for query suggestions was last updated.
Type: Timestamp
## 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
** 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
** 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/DescribeQuerySuggestionsBlockList)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DescribeQuerySuggestionsBlockList)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DescribeQuerySuggestionsBlockList)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DescribeQuerySuggestionsBlockList)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DescribeQuerySuggestionsBlockList)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DescribeQuerySuggestionsBlockList)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DescribeQuerySuggestionsBlockList)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DescribeQuerySuggestionsBlockList)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DescribeQuerySuggestionsBlockList)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DescribeQuerySuggestionsBlockList)
# DescribeQuerySuggestionsConfig
Gets information on the settings of query suggestions for an index.
This is used to check the current settings applied to query suggestions.
`DescribeQuerySuggestionsConfig` is currently not supported in the AWS GovCloud (US-West) region.
## Request Syntax
```
{
"IndexId": "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.
** [IndexId](#API_DescribeQuerySuggestionsConfig_RequestSyntax) **
The identifier of the index with query suggestions that you want to get information on.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Syntax
```
{
"AttributeSuggestionsConfig": {
"AttributeSuggestionsMode": "string",
"SuggestableConfigList": [
{
"AttributeName": "string",
"Suggestable": boolean
}
]
},
"IncludeQueriesWithoutUserInformation": boolean,
"LastClearTime": number,
"LastSuggestionsBuildTime": number,
"MinimumNumberOfQueryingUsers": number,
"MinimumQueryCount": number,
"Mode": "string",
"QueryLogLookBackWindowInDays": number,
"Status": "string",
"TotalSuggestionsCount": number
}
```
## 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.
** [AttributeSuggestionsConfig](#API_DescribeQuerySuggestionsConfig_ResponseSyntax) **
Configuration information for the document fields/attributes that you want to base query suggestions on.
Type: [AttributeSuggestionsDescribeConfig](API_AttributeSuggestionsDescribeConfig.md) object
** [IncludeQueriesWithoutUserInformation](#API_DescribeQuerySuggestionsConfig_ResponseSyntax) **
`TRUE` to use all queries, otherwise use only queries that include user information to generate the query suggestions.
Type: Boolean
** [LastClearTime](#API_DescribeQuerySuggestionsConfig_ResponseSyntax) **
The Unix timestamp when query suggestions for an index was last cleared.
After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. Amazon Kendra only considers re-occurences of a query from the time you cleared suggestions.
Type: Timestamp
** [LastSuggestionsBuildTime](#API_DescribeQuerySuggestionsConfig_ResponseSyntax) **
The Unix timestamp when query suggestions for an index was last updated.
Amazon Kendra automatically updates suggestions every 24 hours, after you change a setting or after you apply a [block list](https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist).
Type: Timestamp
** [MinimumNumberOfQueryingUsers](#API_DescribeQuerySuggestionsConfig_ResponseSyntax) **
The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10000.
** [MinimumQueryCount](#API_DescribeQuerySuggestionsConfig_ResponseSyntax) **
The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10000.
** [Mode](#API_DescribeQuerySuggestionsConfig_ResponseSyntax) **
Whether query suggestions are currently in `ENABLED` mode or `LEARN_ONLY` mode.
By default, Amazon Kendra enables query suggestions.`LEARN_ONLY` turns off query suggestions for your users. You can change the mode using the [UpdateQuerySuggestionsConfig](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html) API.
Type: String
Valid Values: `ENABLED | LEARN_ONLY`
** [QueryLogLookBackWindowInDays](#API_DescribeQuerySuggestionsConfig_ResponseSyntax) **
How recent your queries are in your query log time window (in days).
Type: Integer
** [Status](#API_DescribeQuerySuggestionsConfig_ResponseSyntax) **
Whether the status of query suggestions settings is currently `ACTIVE` or `UPDATING`.
Active means the current settings apply and Updating means your changed settings are in the process of applying.
Type: String
Valid Values: `ACTIVE | UPDATING`
** [TotalSuggestionsCount](#API_DescribeQuerySuggestionsConfig_ResponseSyntax) **
The current total count of query suggestions for an index.
This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.
If the count is much lower than you expected, it could be because Amazon Kendra needs more queries in the query history to learn from or your current query suggestions settings are too strict.
Type: Integer
## 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
** 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
** 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/DescribeQuerySuggestionsConfig)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DescribeQuerySuggestionsConfig)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DescribeQuerySuggestionsConfig)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DescribeQuerySuggestionsConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DescribeQuerySuggestionsConfig)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DescribeQuerySuggestionsConfig)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DescribeQuerySuggestionsConfig)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DescribeQuerySuggestionsConfig)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DescribeQuerySuggestionsConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DescribeQuerySuggestionsConfig)
# DescribeThesaurus
Gets information about an Amazon Kendra thesaurus.
## Request Syntax
```
{
"Id": "string",
"IndexId": "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.
** [Id](#API_DescribeThesaurus_RequestSyntax) **
The identifier of the thesaurus you want to get information on.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_DescribeThesaurus_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
## Response Syntax
```
{
"CreatedAt": number,
"Description": "string",
"ErrorMessage": "string",
"FileSizeBytes": number,
"Id": "string",
"IndexId": "string",
"Name": "string",
"RoleArn": "string",
"SourceS3Path": {
"Bucket": "string",
"Key": "string"
},
"Status": "string",
"SynonymRuleCount": number,
"TermCount": number,
"UpdatedAt": number
}
```
## 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.
** [CreatedAt](#API_DescribeThesaurus_ResponseSyntax) **
The Unix timestamp when the thesaurus was created.
Type: Timestamp
** [Description](#API_DescribeThesaurus_ResponseSyntax) **
The thesaurus description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
** [ErrorMessage](#API_DescribeThesaurus_ResponseSyntax) **
When the `Status` field value is `FAILED`, the `ErrorMessage` field provides more information.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
** [FileSizeBytes](#API_DescribeThesaurus_ResponseSyntax) **
The size of the thesaurus file in bytes.
Type: Long
** [Id](#API_DescribeThesaurus_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_-]*`
** [IndexId](#API_DescribeThesaurus_ResponseSyntax) **
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-]*`
** [Name](#API_DescribeThesaurus_ResponseSyntax) **
The thesaurus name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
** [RoleArn](#API_DescribeThesaurus_ResponseSyntax) **
An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in `SourceS3Path`.
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}`
** [SourceS3Path](#API_DescribeThesaurus_ResponseSyntax) **
Information required to find a specific file in an Amazon S3 bucket.
Type: [S3Path](API_S3Path.md) object
** [Status](#API_DescribeThesaurus_ResponseSyntax) **
The current status of the thesaurus. When the value is `ACTIVE`, queries are able to use the thesaurus. If the `Status` field value is `FAILED`, the `ErrorMessage` field provides more information.
If the status is `ACTIVE_BUT_UPDATE_FAILED`, it means that Amazon Kendra could not ingest the new thesaurus file. The old thesaurus file is still active.
Type: String
Valid Values: `CREATING | ACTIVE | DELETING | UPDATING | ACTIVE_BUT_UPDATE_FAILED | FAILED`
** [SynonymRuleCount](#API_DescribeThesaurus_ResponseSyntax) **
The number of synonym rules in the thesaurus file.
Type: Long
** [TermCount](#API_DescribeThesaurus_ResponseSyntax) **
The number of unique terms in the thesaurus file. For example, the synonyms `a,b,c` and `a=>d`, the term count would be 4.
Type: Long
** [UpdatedAt](#API_DescribeThesaurus_ResponseSyntax) **
The Unix timestamp when the thesaurus was last updated.
Type: Timestamp
## 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
** 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
** 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/DescribeThesaurus)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DescribeThesaurus)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DescribeThesaurus)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DescribeThesaurus)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DescribeThesaurus)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DescribeThesaurus)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DescribeThesaurus)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DescribeThesaurus)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DescribeThesaurus)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DescribeThesaurus)
# DisassociateEntitiesFromExperience
Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see [Building a search experience with no code](https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).
## Request Syntax
```
{
"EntityList": [
{
"EntityId": "string",
"EntityType": "string"
}
],
"Id": "string",
"IndexId": "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.
** [EntityList](#API_DisassociateEntitiesFromExperience_RequestSyntax) **
Lists users or groups in your IAM Identity Center identity source.
Type: Array of [EntityConfiguration](API_EntityConfiguration.md) objects
Array Members: Minimum number of 1 item. Maximum number of 40 items.
Required: Yes
** [Id](#API_DisassociateEntitiesFromExperience_RequestSyntax) **
The identifier of your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_DisassociateEntitiesFromExperience_RequestSyntax) **
The identifier of the index for your Amazon Kendra experience.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Syntax
```
{
"FailedEntityList": [
{
"EntityId": "string",
"ErrorMessage": "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.
** [FailedEntityList](#API_DisassociateEntitiesFromExperience_ResponseSyntax) **
Lists the users or groups in your IAM Identity Center identity source that failed to properly remove access to your Amazon Kendra experience.
Type: Array of [FailedEntity](API_FailedEntity.md) objects
Array Members: Minimum number of 1 item. Maximum number of 25 items.
## 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
** 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
** 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/DisassociateEntitiesFromExperience)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DisassociateEntitiesFromExperience)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DisassociateEntitiesFromExperience)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DisassociateEntitiesFromExperience)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DisassociateEntitiesFromExperience)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DisassociateEntitiesFromExperience)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DisassociateEntitiesFromExperience)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DisassociateEntitiesFromExperience)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DisassociateEntitiesFromExperience)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DisassociateEntitiesFromExperience)
# DisassociatePersonasFromEntities
Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see [Building a search experience with no code](https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).
## Request Syntax
```
{
"EntityIds": [ "string" ],
"Id": "string",
"IndexId": "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.
** [EntityIds](#API_DisassociatePersonasFromEntities_RequestSyntax) **
The identifiers of users or groups in your IAM Identity Center identity source. For example, user IDs could be user emails.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Length Constraints: Minimum length of 1. Maximum length of 47.
Pattern: `^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$`
Required: Yes
** [Id](#API_DisassociatePersonasFromEntities_RequestSyntax) **
The identifier of your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_DisassociatePersonasFromEntities_RequestSyntax) **
The identifier of the index for your Amazon Kendra experience.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Syntax
```
{
"FailedEntityList": [
{
"EntityId": "string",
"ErrorMessage": "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.
** [FailedEntityList](#API_DisassociatePersonasFromEntities_ResponseSyntax) **
Lists the users or groups in your IAM Identity Center identity source that failed to properly remove access to your Amazon Kendra experience.
Type: Array of [FailedEntity](API_FailedEntity.md) objects
Array Members: Minimum number of 1 item. Maximum number of 25 items.
## 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
** 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
** 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/DisassociatePersonasFromEntities)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DisassociatePersonasFromEntities)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DisassociatePersonasFromEntities)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DisassociatePersonasFromEntities)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DisassociatePersonasFromEntities)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DisassociatePersonasFromEntities)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DisassociatePersonasFromEntities)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DisassociatePersonasFromEntities)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DisassociatePersonasFromEntities)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DisassociatePersonasFromEntities)
# GetQuerySuggestions
Fetches the queries that are suggested to your users.
`GetQuerySuggestions` is currently not supported in the AWS GovCloud (US-West) region.
## Request Syntax
```
{
"AttributeSuggestionsConfig": {
"AdditionalResponseAttributes": [ "string" ],
"AttributeFilter": {
"AndAllFilters": [
"AttributeFilter"
],
"ContainsAll": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"ContainsAny": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"EqualsTo": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"GreaterThan": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"GreaterThanOrEquals": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"LessThan": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"LessThanOrEquals": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"NotFilter": "AttributeFilter",
"OrAllFilters": [
"AttributeFilter"
]
},
"SuggestionAttributes": [ "string" ],
"UserContext": {
"DataSourceGroups": [
{
"DataSourceId": "string",
"GroupId": "string"
}
],
"Groups": [ "string" ],
"Token": "string",
"UserId": "string"
}
},
"IndexId": "string",
"MaxSuggestionsCount": number,
"QueryText": "string",
"SuggestionTypes": [ "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.
** [AttributeSuggestionsConfig](#API_GetQuerySuggestions_RequestSyntax) **
Configuration information for the document fields/attributes that you want to base query suggestions on.
Type: [AttributeSuggestionsGetConfig](API_AttributeSuggestionsGetConfig.md) object
Required: No
** [IndexId](#API_GetQuerySuggestions_RequestSyntax) **
The identifier of the index you want to get query suggestions from.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [MaxSuggestionsCount](#API_GetQuerySuggestions_RequestSyntax) **
The maximum number of query suggestions you want to show to your users.
Type: Integer
Required: No
** [QueryText](#API_GetQuerySuggestions_RequestSyntax) **
The text of a user's query to generate query suggestions.
A query is suggested if the query prefix matches what a user starts to type as their query.
Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.
Type: String
Pattern: `^\P{C}*$`
Required: Yes
** [SuggestionTypes](#API_GetQuerySuggestions_RequestSyntax) **
The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.
If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.
If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.
Type: Array of strings
Valid Values: `QUERY | DOCUMENT_ATTRIBUTES`
Required: No
## Response Syntax
```
{
"QuerySuggestionsId": "string",
"Suggestions": [
{
"Id": "string",
"SourceDocuments": [
{
"AdditionalAttributes": [
{
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
}
],
"DocumentId": "string",
"SuggestionAttributes": [ "string" ]
}
],
"Value": {
"Text": {
"Highlights": [
{
"BeginOffset": number,
"EndOffset": number
}
],
"Text": "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.
** [QuerySuggestionsId](#API_GetQuerySuggestions_ResponseSyntax) **
The identifier for a list of query suggestions for an index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
** [Suggestions](#API_GetQuerySuggestions_ResponseSyntax) **
A list of query suggestions for an index.
Type: Array of [Suggestion](API_Suggestion.md) objects
## 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/GetQuerySuggestions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/GetQuerySuggestions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/GetQuerySuggestions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/GetQuerySuggestions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/GetQuerySuggestions)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/GetQuerySuggestions)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/GetQuerySuggestions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/GetQuerySuggestions)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/GetQuerySuggestions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/GetQuerySuggestions)
# GetSnapshots
Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.
## Request Syntax
```
{
"IndexId": "string",
"Interval": "string",
"MaxResults": number,
"MetricType": "string",
"NextToken": "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.
** [IndexId](#API_GetSnapshots_RequestSyntax) **
The identifier of the index to get search metrics data.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [Interval](#API_GetSnapshots_RequestSyntax) **
The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows:
+ `THIS_WEEK`: The current week, starting on the Sunday and ending on the day before the current date.
+ `ONE_WEEK_AGO`: The previous week, starting on the Sunday and ending on the following Saturday.
+ `TWO_WEEKS_AGO`: The week before the previous week, starting on the Sunday and ending on the following Saturday.
+ `THIS_MONTH`: The current month, starting on the first day of the month and ending on the day before the current date.
+ `ONE_MONTH_AGO`: The previous month, starting on the first day of the month and ending on the last day of the month.
+ `TWO_MONTHS_AGO`: The month before the previous month, starting on the first day of the month and ending on last day of the month.
Type: String
Valid Values: `THIS_MONTH | THIS_WEEK | ONE_WEEK_AGO | TWO_WEEKS_AGO | ONE_MONTH_AGO | TWO_MONTHS_AGO`
Required: Yes
** [MaxResults](#API_GetSnapshots_RequestSyntax) **
The maximum number of returned data for the metric.
Type: Integer
Required: No
** [MetricType](#API_GetSnapshots_RequestSyntax) **
The metric you want to retrieve. You can specify only one metric per call.
For more information about the metrics you can view, see [Gaining insights with search analytics](https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html).
Type: String
Valid Values: `QUERIES_BY_COUNT | QUERIES_BY_ZERO_CLICK_RATE | QUERIES_BY_ZERO_RESULT_RATE | DOCS_BY_CLICK_COUNT | AGG_QUERY_DOC_METRICS | TREND_QUERY_DOC_METRICS`
Required: Yes
** [NextToken](#API_GetSnapshots_RequestSyntax) **
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of search metrics data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
Required: No
## Response Syntax
```
{
"NextToken": "string",
"SnapshotsData": [
[ "string" ]
],
"SnapshotsDataHeader": [ "string" ],
"SnapShotTimeFilter": {
"EndTime": number,
"StartTime": number
}
}
```
## 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.
** [NextToken](#API_GetSnapshots_ResponseSyntax) **
If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of search metrics data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
** [SnapshotsData](#API_GetSnapshots_ResponseSyntax) **
The search metrics data. The data returned depends on the metric type you requested.
Type: Array of arrays of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
** [SnapshotsDataHeader](#API_GetSnapshots_ResponseSyntax) **
The column headers for the search metrics data.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
** [SnapShotTimeFilter](#API_GetSnapshots_ResponseSyntax) **
The Unix timestamp for the beginning and end of the time window for the search metrics data.
Type: [TimeRange](API_TimeRange.md) object
## 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
** 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
** InvalidRequestException **
The input to the request is not valid. Please provide the correct input and try again.
HTTP Status Code: 400
** 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
## 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/GetSnapshots)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/GetSnapshots)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/GetSnapshots)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/GetSnapshots)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/GetSnapshots)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/GetSnapshots)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/GetSnapshots)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/GetSnapshots)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/GetSnapshots)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/GetSnapshots)
# ListAccessControlConfigurations
Lists one or more access control configurations for an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
## Request Syntax
```
{
"IndexId": "string",
"MaxResults": number,
"NextToken": "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.
** [IndexId](#API_ListAccessControlConfigurations_RequestSyntax) **
The identifier of the index for the access control configuration.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [MaxResults](#API_ListAccessControlConfigurations_RequestSyntax) **
The maximum number of access control configurations to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_ListAccessControlConfigurations_RequestSyntax) **
If the previous response was incomplete (because there's more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of access control configurations.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
## Response Syntax
```
{
"AccessControlConfigurations": [
{
"Id": "string"
}
],
"NextToken": "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.
** [AccessControlConfigurations](#API_ListAccessControlConfigurations_ResponseSyntax) **
The details of your access control configurations.
Type: Array of [AccessControlConfigurationSummary](API_AccessControlConfigurationSummary.md) objects
** [NextToken](#API_ListAccessControlConfigurations_ResponseSyntax) **
If the response is truncated, Amazon Kendra returns this token, which you can use in the subsequent request to retrieve the next set of access control configurations.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
## 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
** 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
** 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/ListAccessControlConfigurations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/ListAccessControlConfigurations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ListAccessControlConfigurations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/ListAccessControlConfigurations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ListAccessControlConfigurations)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/ListAccessControlConfigurations)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/ListAccessControlConfigurations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/ListAccessControlConfigurations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/ListAccessControlConfigurations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ListAccessControlConfigurations)
# ListDataSources
Lists the data source connectors that you have created.
## Request Syntax
```
{
"IndexId": "string",
"MaxResults": number,
"NextToken": "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.
** [IndexId](#API_ListDataSources_RequestSyntax) **
The identifier of the index used with one or more data source connectors.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [MaxResults](#API_ListDataSources_RequestSyntax) **
The maximum number of data source connectors to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_ListDataSources_RequestSyntax) **
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of data source connectors.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
Required: No
## Response Syntax
```
{
"NextToken": "string",
"SummaryItems": [
{
"CreatedAt": number,
"Id": "string",
"LanguageCode": "string",
"Name": "string",
"Status": "string",
"Type": "string",
"UpdatedAt": number
}
]
}
```
## 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.
** [NextToken](#API_ListDataSources_ResponseSyntax) **
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of data source connectors.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
** [SummaryItems](#API_ListDataSources_ResponseSyntax) **
An array of summary information for one or more data source connector.
Type: Array of [DataSourceSummary](API_DataSourceSummary.md) objects
## 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
** 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
** 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/ListDataSources)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/ListDataSources)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ListDataSources)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/ListDataSources)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ListDataSources)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/ListDataSources)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/ListDataSources)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/ListDataSources)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/ListDataSources)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ListDataSources)
# ListDataSourceSyncJobs
Gets statistics about synchronizing a data source connector.
## Request Syntax
```
{
"Id": "string",
"IndexId": "string",
"MaxResults": number,
"NextToken": "string",
"StartTimeFilter": {
"EndTime": number,
"StartTime": number
},
"StatusFilter": "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.
** [Id](#API_ListDataSourceSyncJobs_RequestSyntax) **
The identifier of the data source connector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_ListDataSourceSyncJobs_RequestSyntax) **
The identifier of the index used with the data source connector.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [MaxResults](#API_ListDataSourceSyncJobs_RequestSyntax) **
The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No
** [NextToken](#API_ListDataSourceSyncJobs_RequestSyntax) **
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
Required: No
** [StartTimeFilter](#API_ListDataSourceSyncJobs_RequestSyntax) **
When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
Type: [TimeRange](API_TimeRange.md) object
Required: No
** [StatusFilter](#API_ListDataSourceSyncJobs_RequestSyntax) **
Only returns synchronization jobs with the `Status` field equal to the specified status.
Type: String
Valid Values: `FAILED | SUCCEEDED | SYNCING | INCOMPLETE | STOPPING | ABORTED | SYNCING_INDEXING`
Required: No
## Response Syntax
```
{
"History": [
{
"DataSourceErrorCode": "string",
"EndTime": number,
"ErrorCode": "string",
"ErrorMessage": "string",
"ExecutionId": "string",
"Metrics": {
"DocumentsAdded": "string",
"DocumentsDeleted": "string",
"DocumentsFailed": "string",
"DocumentsModified": "string",
"DocumentsScanned": "string"
},
"StartTime": number,
"Status": "string"
}
],
"NextToken": "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.
** [History](#API_ListDataSourceSyncJobs_ResponseSyntax) **
A history of synchronization jobs for the data source connector.
Type: Array of [DataSourceSyncJob](API_DataSourceSyncJob.md) objects
** [NextToken](#API_ListDataSourceSyncJobs_ResponseSyntax) **
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of jobs.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
## 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
** 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/ListDataSourceSyncJobs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/ListDataSourceSyncJobs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ListDataSourceSyncJobs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/ListDataSourceSyncJobs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ListDataSourceSyncJobs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/ListDataSourceSyncJobs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/ListDataSourceSyncJobs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/ListDataSourceSyncJobs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/ListDataSourceSyncJobs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ListDataSourceSyncJobs)
# ListEntityPersonas
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
## Request Syntax
```
{
"Id": "string",
"IndexId": "string",
"MaxResults": number,
"NextToken": "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.
** [Id](#API_ListEntityPersonas_RequestSyntax) **
The identifier of your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_ListEntityPersonas_RequestSyntax) **
The identifier of the index for your Amazon Kendra experience.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [MaxResults](#API_ListEntityPersonas_RequestSyntax) **
The maximum number of returned users or groups.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_ListEntityPersonas_RequestSyntax) **
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of users or groups.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
Required: No
## Response Syntax
```
{
"NextToken": "string",
"SummaryItems": [
{
"CreatedAt": number,
"EntityId": "string",
"Persona": "string",
"UpdatedAt": number
}
]
}
```
## 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.
** [NextToken](#API_ListEntityPersonas_ResponseSyntax) **
If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of users or groups.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
** [SummaryItems](#API_ListEntityPersonas_ResponseSyntax) **
An array of summary information for one or more users or groups.
Type: Array of [PersonasSummary](API_PersonasSummary.md) objects
## 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
** 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
** 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/ListEntityPersonas)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/ListEntityPersonas)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ListEntityPersonas)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/ListEntityPersonas)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ListEntityPersonas)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/ListEntityPersonas)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/ListEntityPersonas)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/ListEntityPersonas)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/ListEntityPersonas)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ListEntityPersonas)
# ListExperienceEntities
Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see [Building a search experience with no code](https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).
## Request Syntax
```
{
"Id": "string",
"IndexId": "string",
"NextToken": "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.
** [Id](#API_ListExperienceEntities_RequestSyntax) **
The identifier of your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_ListExperienceEntities_RequestSyntax) **
The identifier of the index for your Amazon Kendra experience.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [NextToken](#API_ListExperienceEntities_RequestSyntax) **
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of users or groups.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
Required: No
## Response Syntax
```
{
"NextToken": "string",
"SummaryItems": [
{
"DisplayData": {
"FirstName": "string",
"GroupName": "string",
"IdentifiedUserName": "string",
"LastName": "string",
"UserName": "string"
},
"EntityId": "string",
"EntityType": "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.
** [NextToken](#API_ListExperienceEntities_ResponseSyntax) **
If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of users or groups.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
** [SummaryItems](#API_ListExperienceEntities_ResponseSyntax) **
An array of summary information for one or more users or groups.
Type: Array of [ExperienceEntitiesSummary](API_ExperienceEntitiesSummary.md) objects
## 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
** 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
** 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/ListExperienceEntities)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/ListExperienceEntities)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ListExperienceEntities)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/ListExperienceEntities)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ListExperienceEntities)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/ListExperienceEntities)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/ListExperienceEntities)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/ListExperienceEntities)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/ListExperienceEntities)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ListExperienceEntities)
# ListExperiences
Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see [Building a search experience with no code](https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).
## Request Syntax
```
{
"IndexId": "string",
"MaxResults": number,
"NextToken": "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.
** [IndexId](#API_ListExperiences_RequestSyntax) **
The identifier of the index for your Amazon Kendra experience.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [MaxResults](#API_ListExperiences_RequestSyntax) **
The maximum number of returned Amazon Kendra experiences.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_ListExperiences_RequestSyntax) **
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Kendra experiences.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
Required: No
## Response Syntax
```
{
"NextToken": "string",
"SummaryItems": [
{
"CreatedAt": number,
"Endpoints": [
{
"Endpoint": "string",
"EndpointType": "string"
}
],
"Id": "string",
"Name": "string",
"Status": "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.
** [NextToken](#API_ListExperiences_ResponseSyntax) **
If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of Amazon Kendra experiences.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
** [SummaryItems](#API_ListExperiences_ResponseSyntax) **
An array of summary information for one or more Amazon Kendra experiences.
Type: Array of [ExperiencesSummary](API_ExperiencesSummary.md) objects
## 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
** 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
** 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/ListExperiences)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/ListExperiences)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ListExperiences)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/ListExperiences)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ListExperiences)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/ListExperiences)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/ListExperiences)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/ListExperiences)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/ListExperiences)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ListExperiences)
# ListFaqs
Gets a list of FAQs associated with an index.
## Request Syntax
```
{
"IndexId": "string",
"MaxResults": number,
"NextToken": "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.
** [IndexId](#API_ListFaqs_RequestSyntax) **
The index for the FAQs.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [MaxResults](#API_ListFaqs_RequestSyntax) **
The maximum number of FAQs to return in the response. If there are fewer results in the list, this response contains only the actual results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_ListFaqs_RequestSyntax) **
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of FAQs.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
Required: No
## Response Syntax
```
{
"FaqSummaryItems": [
{
"CreatedAt": number,
"FileFormat": "string",
"Id": "string",
"LanguageCode": "string",
"Name": "string",
"Status": "string",
"UpdatedAt": number
}
],
"NextToken": "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.
** [FaqSummaryItems](#API_ListFaqs_ResponseSyntax) **
Summary information about the FAQs for a specified index.
Type: Array of [FaqSummary](API_FaqSummary.md) objects
** [NextToken](#API_ListFaqs_ResponseSyntax) **
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of FAQs.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
## 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
** 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
** 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/ListFaqs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/ListFaqs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ListFaqs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/ListFaqs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ListFaqs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/ListFaqs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/ListFaqs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/ListFaqs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/ListFaqs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ListFaqs)
# ListFeaturedResultsSets
Lists all your sets of featured results for a given index. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
## Request Syntax
```
{
"IndexId": "string",
"MaxResults": number,
"NextToken": "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.
** [IndexId](#API_ListFeaturedResultsSets_RequestSyntax) **
The identifier of the index used for featuring results.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [MaxResults](#API_ListFeaturedResultsSets_RequestSyntax) **
The maximum number of featured results sets to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_ListFeaturedResultsSets_RequestSyntax) **
If the response is truncated, Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of featured results sets.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
Required: No
## Response Syntax
```
{
"FeaturedResultsSetSummaryItems": [
{
"CreationTimestamp": number,
"FeaturedResultsSetId": "string",
"FeaturedResultsSetName": "string",
"LastUpdatedTimestamp": number,
"Status": "string"
}
],
"NextToken": "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.
** [FeaturedResultsSetSummaryItems](#API_ListFeaturedResultsSets_ResponseSyntax) **
An array of summary information for one or more featured results sets.
Type: Array of [FeaturedResultsSetSummary](API_FeaturedResultsSetSummary.md) objects
** [NextToken](#API_ListFeaturedResultsSets_ResponseSyntax) **
If the response is truncated, Amazon Kendra returns a pagination token in the response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
## 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
** 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
** 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/ListFeaturedResultsSets)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/ListFeaturedResultsSets)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ListFeaturedResultsSets)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/ListFeaturedResultsSets)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ListFeaturedResultsSets)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/ListFeaturedResultsSets)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/ListFeaturedResultsSets)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/ListFeaturedResultsSets)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/ListFeaturedResultsSets)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ListFeaturedResultsSets)
# ListGroupsOlderThanOrderingId
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
`ListGroupsOlderThanOrderingId` is currently not supported in the AWS GovCloud (US-West) region.
## Request Syntax
```
{
"DataSourceId": "string",
"IndexId": "string",
"MaxResults": number,
"NextToken": "string",
"OrderingId": number
}
```
## 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.
** [DataSourceId](#API_ListGroupsOlderThanOrderingId_RequestSyntax) **
The identifier of the data source for getting a list of groups mapped to users before a given ordering timestamp identifier.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** [IndexId](#API_ListGroupsOlderThanOrderingId_RequestSyntax) **
The identifier of the index for getting a list of groups mapped to users before a given ordering or timestamp identifier.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [MaxResults](#API_ListGroupsOlderThanOrderingId_RequestSyntax) **
The maximum number of returned groups that are mapped to users before a given ordering or timestamp identifier.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No
** [NextToken](#API_ListGroupsOlderThanOrderingId_RequestSyntax) **
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users before a given ordering or timestamp identifier.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
Required: No
** [OrderingId](#API_ListGroupsOlderThanOrderingId_RequestSyntax) **
The timestamp identifier used for the latest `PUT` or `DELETE` action for mapping users to their groups.
Type: Long
Valid Range: Minimum value of 0. Maximum value of 32535158400000.
Required: Yes
## Response Syntax
```
{
"GroupsSummaries": [
{
"GroupId": "string",
"OrderingId": number
}
],
"NextToken": "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.
** [GroupsSummaries](#API_ListGroupsOlderThanOrderingId_ResponseSyntax) **
Summary information for list of groups that are mapped to users before a given ordering or timestamp identifier.
Type: Array of [GroupSummary](API_GroupSummary.md) objects
** [NextToken](#API_ListGroupsOlderThanOrderingId_ResponseSyntax) **
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users before a given ordering or timestamp identifier.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
## 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
** 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/ListGroupsOlderThanOrderingId)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/ListGroupsOlderThanOrderingId)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ListGroupsOlderThanOrderingId)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/ListGroupsOlderThanOrderingId)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ListGroupsOlderThanOrderingId)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/ListGroupsOlderThanOrderingId)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/ListGroupsOlderThanOrderingId)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/ListGroupsOlderThanOrderingId)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/ListGroupsOlderThanOrderingId)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ListGroupsOlderThanOrderingId)
# ListIndices
Lists the Amazon Kendra indexes that you created.
## Request Syntax
```
{
"MaxResults": number,
"NextToken": "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.
** [MaxResults](#API_ListIndices_RequestSyntax) **
The maximum number of indices to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_ListIndices_RequestSyntax) **
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of indexes.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
Required: No
## Response Syntax
```
{
"IndexConfigurationSummaryItems": [
{
"CreatedAt": number,
"Edition": "string",
"Id": "string",
"Name": "string",
"Status": "string",
"UpdatedAt": number
}
],
"NextToken": "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.
** [IndexConfigurationSummaryItems](#API_ListIndices_ResponseSyntax) **
An array of summary information on the configuration of one or more indexes.
Type: Array of [IndexConfigurationSummary](API_IndexConfigurationSummary.md) objects
** [NextToken](#API_ListIndices_ResponseSyntax) **
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of indexes.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
## 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
** 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
** 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/ListIndices)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/ListIndices)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ListIndices)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/ListIndices)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ListIndices)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/ListIndices)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/ListIndices)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/ListIndices)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/ListIndices)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ListIndices)
# ListQuerySuggestionsBlockLists
Lists the block lists used for query suggestions for an index.
For information on the current quota limits for block lists, see [Quotas for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
`ListQuerySuggestionsBlockLists` is currently not supported in the AWS GovCloud (US-West) region.
## Request Syntax
```
{
"IndexId": "string",
"MaxResults": number,
"NextToken": "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.
** [IndexId](#API_ListQuerySuggestionsBlockLists_RequestSyntax) **
The identifier of the index for a list of all block lists that exist for that index.
For information on the current quota limits for block lists, see [Quotas for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [MaxResults](#API_ListQuerySuggestionsBlockLists_RequestSyntax) **
The maximum number of block lists to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_ListQuerySuggestionsBlockLists_RequestSyntax) **
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of block lists (`BlockListSummaryItems`).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
Required: No
## Response Syntax
```
{
"BlockListSummaryItems": [
{
"CreatedAt": number,
"Id": "string",
"ItemCount": number,
"Name": "string",
"Status": "string",
"UpdatedAt": number
}
],
"NextToken": "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.
** [BlockListSummaryItems](#API_ListQuerySuggestionsBlockLists_ResponseSyntax) **
Summary items for a block list.
This includes summary items on the block list ID, block list name, when the block list was created, when the block list was last updated, and the count of block words/phrases in the block list.
For information on the current quota limits for block lists, see [Quotas for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
Type: Array of [QuerySuggestionsBlockListSummary](API_QuerySuggestionsBlockListSummary.md) objects
** [NextToken](#API_ListQuerySuggestionsBlockLists_ResponseSyntax) **
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of block lists.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
## 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
** 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
** 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/ListQuerySuggestionsBlockLists)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/ListQuerySuggestionsBlockLists)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ListQuerySuggestionsBlockLists)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/ListQuerySuggestionsBlockLists)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ListQuerySuggestionsBlockLists)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/ListQuerySuggestionsBlockLists)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/ListQuerySuggestionsBlockLists)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/ListQuerySuggestionsBlockLists)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/ListQuerySuggestionsBlockLists)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ListQuerySuggestionsBlockLists)
# ListTagsForResource
Gets a list of tags associated with a resource. Indexes, FAQs, data sources, and other resources can have tags associated with them.
## Request Syntax
```
{
"ResourceARN": "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.
** [ResourceARN](#API_ListTagsForResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to get a list of tags for. For example, the ARN of an index is constructed as follows: *arn:aws:kendra:your-region:your-account-id:index/index-id* For information on how to construct an ARN for all types of Amazon Kendra resources, see [Resource types](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendra.html#amazonkendra-resources-for-iam-policies).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
## Response Syntax
```
{
"Tags": [
{
"Key": "string",
"Value": "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.
** [Tags](#API_ListTagsForResource_ResponseSyntax) **
A list of tags associated with the index, FAQ, data source, or other resource.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
## 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
** 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
** ResourceUnavailableException **
The resource you want to use isn't available. Please check you have provided the correct resource and try again.
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/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ListTagsForResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/ListTagsForResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/ListTagsForResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ListTagsForResource)
# ListThesauri
Lists the thesauri for an index.
## Request Syntax
```
{
"IndexId": "string",
"MaxResults": number,
"NextToken": "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.
** [IndexId](#API_ListThesauri_RequestSyntax) **
The identifier of the index with one or more thesauri.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [MaxResults](#API_ListThesauri_RequestSyntax) **
The maximum number of thesauri to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [NextToken](#API_ListThesauri_RequestSyntax) **
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of thesauri (`ThesaurusSummaryItems`).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
Required: No
## Response Syntax
```
{
"NextToken": "string",
"ThesaurusSummaryItems": [
{
"CreatedAt": number,
"Id": "string",
"Name": "string",
"Status": "string",
"UpdatedAt": number
}
]
}
```
## 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.
** [NextToken](#API_ListThesauri_ResponseSyntax) **
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of thesauri.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
** [ThesaurusSummaryItems](#API_ListThesauri_ResponseSyntax) **
An array of summary information for a thesaurus or multiple thesauri.
Type: Array of [ThesaurusSummary](API_ThesaurusSummary.md) objects
## 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
** 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
** 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/ListThesauri)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/ListThesauri)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ListThesauri)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/ListThesauri)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ListThesauri)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/ListThesauri)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/ListThesauri)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/ListThesauri)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/ListThesauri)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ListThesauri)
# PutPrincipalMapping
Maps users to their groups so that you only need to provide the user ID when you issue the query.
You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results.
This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. For more information, see [Filtering on user context](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html).
If more than five `PUT` actions for a group are currently processing, a validation exception is thrown.
## Request Syntax
```
{
"DataSourceId": "string",
"GroupId": "string",
"GroupMembers": {
"MemberGroups": [
{
"DataSourceId": "string",
"GroupId": "string"
}
],
"MemberUsers": [
{
"UserId": "string"
}
],
"S3PathforGroupMembers": {
"Bucket": "string",
"Key": "string"
}
},
"IndexId": "string",
"OrderingId": number,
"RoleArn": "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.
** [DataSourceId](#API_PutPrincipalMapping_RequestSyntax) **
The identifier of the data source you want to map users to their groups.
This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** [GroupId](#API_PutPrincipalMapping_RequestSyntax) **
The identifier of the group you want to map its users to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `^\P{C}*$`
Required: Yes
** [GroupMembers](#API_PutPrincipalMapping_RequestSyntax) **
The list that contains your users that belong the same group. This can include sub groups that belong to a group.
For example, the group "Company A" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".
If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.
Type: [GroupMembers](API_GroupMembers.md) object
Required: Yes
** [IndexId](#API_PutPrincipalMapping_RequestSyntax) **
The identifier of the index you want to map users to their groups.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [OrderingId](#API_PutPrincipalMapping_RequestSyntax) **
The timestamp identifier you specify to ensure Amazon Kendra doesn't override the latest `PUT` action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.
The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling `PutPrincipalMapping`. This ensures your `PUT` action for that updated group with the latest members list doesn't get overwritten by earlier `PUT` actions for the same group which are yet to be processed.
The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.
Type: Long
Valid Range: Minimum value of 0. Maximum value of 32535158400000.
Required: No
** [RoleArn](#API_PutPrincipalMapping_RequestSyntax) **
The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.
For more information, see [IAM roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
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: No
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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/PutPrincipalMapping)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/PutPrincipalMapping)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/PutPrincipalMapping)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/PutPrincipalMapping)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/PutPrincipalMapping)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/PutPrincipalMapping)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/PutPrincipalMapping)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/PutPrincipalMapping)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/PutPrincipalMapping)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/PutPrincipalMapping)
# Query
Searches an index given an input query.
**Note**
If you are working with large language models (LLMs) or implementing retrieval augmented generation (RAG) systems, you can use Amazon Kendra's [Retrieve](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Retrieve.html) API, which can return longer semantically relevant passages. We recommend using the `Retrieve` API instead of filing a service limit increase to increase the `Query` API document excerpt length.
You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter based on document fields/attributes and faceted search, and filter based on the user or their group access to documents. You can also include certain fields in the response that might provide useful additional information.
A query response contains three types of results.
+ Relevant suggested answers. The answers can be either a text excerpt or table excerpt. The answer can be highlighted in the excerpt.
+ Matching FAQs or questions-answer from your FAQ file.
+ Relevant documents. This result type includes an excerpt of the document with the document title. The searched terms can be highlighted in the excerpt.
You can specify that the query return only one type of result using the `QueryResultTypeFilter` parameter. Each query returns the 100 most relevant results. If you filter result type to only question-answers, a maximum of four results are returned. If you filter result type to only answers, a maximum of three results are returned.
**Important**
If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use `ATTRIBUTE_FILTER` to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use `USER_TOKEN` to configure user context policy, Amazon Kendra returns a `ValidationException` error.
## Request Syntax
```
{
"AttributeFilter": {
"AndAllFilters": [
"AttributeFilter"
],
"ContainsAll": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"ContainsAny": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"EqualsTo": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"GreaterThan": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"GreaterThanOrEquals": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"LessThan": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"LessThanOrEquals": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"NotFilter": "AttributeFilter",
"OrAllFilters": [
"AttributeFilter"
]
},
"CollapseConfiguration": {
"DocumentAttributeKey": "string",
"Expand": boolean,
"ExpandConfiguration": {
"MaxExpandedResultsPerItem": number,
"MaxResultItemsToExpand": number
},
"MissingAttributeKeyStrategy": "string",
"SortingConfigurations": [
{
"DocumentAttributeKey": "string",
"SortOrder": "string"
}
]
},
"DocumentRelevanceOverrideConfigurations": [
{
"Name": "string",
"Relevance": {
"Duration": "string",
"Freshness": boolean,
"Importance": number,
"RankOrder": "string",
"ValueImportanceMap": {
"string" : number
}
}
}
],
"Facets": [
{
"DocumentAttributeKey": "string",
"Facets": [
"Facet"
],
"MaxResults": number
}
],
"IndexId": "string",
"PageNumber": number,
"PageSize": number,
"QueryResultTypeFilter": "string",
"QueryText": "string",
"RequestedDocumentAttributes": [ "string" ],
"SortingConfiguration": {
"DocumentAttributeKey": "string",
"SortOrder": "string"
},
"SortingConfigurations": [
{
"DocumentAttributeKey": "string",
"SortOrder": "string"
}
],
"SpellCorrectionConfiguration": {
"IncludeQuerySpellCheckSuggestions": boolean
},
"UserContext": {
"DataSourceGroups": [
{
"DataSourceId": "string",
"GroupId": "string"
}
],
"Groups": [ "string" ],
"Token": "string",
"UserId": "string"
},
"VisitorId": "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.
** [AttributeFilter](#API_Query_RequestSyntax) **
Filters search results by document fields/attributes. You can only provide one attribute filter; however, the `AndAllFilters`, `NotFilter`, and `OrAllFilters` parameters contain a list of other filters.
The `AttributeFilter` parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results.
For Amazon Kendra Gen AI Enterprise Edition indices use `AttributeFilter` to enable document filtering for end users using `_email_id` or include public documents (`_email_id=null`).
Type: [AttributeFilter](API_AttributeFilter.md) object
Required: No
** [CollapseConfiguration](#API_Query_RequestSyntax) **
Provides configuration to determine how to group results by document attribute value, and how to display them (collapsed or expanded) under a designated primary document for each group.
Type: [CollapseConfiguration](API_CollapseConfiguration.md) object
Required: No
** [DocumentRelevanceOverrideConfigurations](#API_Query_RequestSyntax) **
Overrides relevance tuning configurations of fields/attributes set at the index level.
If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.
If there is relevance tuning configured for fields at the index level, and you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.
Type: Array of [DocumentRelevanceConfiguration](API_DocumentRelevanceConfiguration.md) objects
Array Members: Minimum number of 0 items. Maximum number of 500 items.
Required: No
** [Facets](#API_Query_RequestSyntax) **
An array of documents fields/attributes for faceted search. Amazon Kendra returns a count for each field key specified. This helps your users narrow their search.
Type: Array of [Facet](API_Facet.md) objects
Required: No
** [IndexId](#API_Query_RequestSyntax) **
The identifier of the index for the search.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [PageNumber](#API_Query_RequestSyntax) **
Query results are returned in pages the size of the `PageSize` parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.
Type: Integer
Required: No
** [PageSize](#API_Query_RequestSyntax) **
Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.
Type: Integer
Required: No
** [QueryResultTypeFilter](#API_Query_RequestSyntax) **
Sets the type of query result or response. Only results for the specified type are returned.
Type: String
Valid Values: `DOCUMENT | QUESTION_ANSWER | ANSWER`
Required: No
** [QueryText](#API_Query_RequestSyntax) **
The input query text for the search. Amazon Kendra truncates queries at 30 token words, which excludes punctuation and stop words. Truncation still applies if you use Boolean or more advanced, complex queries. For example, `Timeoff AND October AND Category:HR` is counted as 3 tokens: `timeoff`, `october`, `hr`. For more information, see [Searching with advanced query syntax](https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax) in the Amazon Kendra Developer Guide.
Type: String
Required: No
** [RequestedDocumentAttributes](#API_Query_RequestSyntax) **
An array of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document attributes are included in the response.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `[a-zA-Z0-9_][a-zA-Z0-9_-]*`
Required: No
** [SortingConfiguration](#API_Query_RequestSyntax) **
Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.
If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.
Type: [SortingConfiguration](API_SortingConfiguration.md) object
Required: No
** [SortingConfigurations](#API_Query_RequestSyntax) **
Provides configuration information to determine how the results of a query are sorted.
You can set upto 3 fields that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. The sort field quota can be increased.
If you don't provide a sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result. In the case of ties in sorting the results, the results are sorted by relevance.
Type: Array of [SortingConfiguration](API_SortingConfiguration.md) objects
Array Members: Minimum number of 1 item.
Required: No
** [SpellCorrectionConfiguration](#API_Query_RequestSyntax) **
Enables suggested spell corrections for queries.
Type: [SpellCorrectionConfiguration](API_SpellCorrectionConfiguration.md) object
Required: No
** [UserContext](#API_Query_RequestSyntax) **
The user context token or user and group information.
Type: [UserContext](API_UserContext.md) object
Required: No
** [VisitorId](#API_Query_RequestSyntax) **
Provides an identifier for a specific user. The `VisitorId` should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the `VisitorId`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
## Response Syntax
```
{
"FacetResults": [
{
"DocumentAttributeKey": "string",
"DocumentAttributeValueCountPairs": [
{
"Count": number,
"DocumentAttributeValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"FacetResults": [
"FacetResult"
]
}
],
"DocumentAttributeValueType": "string"
}
],
"FeaturedResultsItems": [
{
"AdditionalAttributes": [
{
"Key": "string",
"Value": {
"TextWithHighlightsValue": {
"Highlights": [
{
"BeginOffset": number,
"EndOffset": number,
"TopAnswer": boolean,
"Type": "string"
}
],
"Text": "string"
}
},
"ValueType": "string"
}
],
"DocumentAttributes": [
{
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
}
],
"DocumentExcerpt": {
"Highlights": [
{
"BeginOffset": number,
"EndOffset": number,
"TopAnswer": boolean,
"Type": "string"
}
],
"Text": "string"
},
"DocumentId": "string",
"DocumentTitle": {
"Highlights": [
{
"BeginOffset": number,
"EndOffset": number,
"TopAnswer": boolean,
"Type": "string"
}
],
"Text": "string"
},
"DocumentURI": "string",
"FeedbackToken": "string",
"Id": "string",
"Type": "string"
}
],
"QueryId": "string",
"ResultItems": [
{
"AdditionalAttributes": [
{
"Key": "string",
"Value": {
"TextWithHighlightsValue": {
"Highlights": [
{
"BeginOffset": number,
"EndOffset": number,
"TopAnswer": boolean,
"Type": "string"
}
],
"Text": "string"
}
},
"ValueType": "string"
}
],
"CollapsedResultDetail": {
"DocumentAttribute": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"ExpandedResults": [
{
"DocumentAttributes": [
{
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
}
],
"DocumentExcerpt": {
"Highlights": [
{
"BeginOffset": number,
"EndOffset": number,
"TopAnswer": boolean,
"Type": "string"
}
],
"Text": "string"
},
"DocumentId": "string",
"DocumentTitle": {
"Highlights": [
{
"BeginOffset": number,
"EndOffset": number,
"TopAnswer": boolean,
"Type": "string"
}
],
"Text": "string"
},
"DocumentURI": "string",
"Id": "string"
}
]
},
"DocumentAttributes": [
{
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
}
],
"DocumentExcerpt": {
"Highlights": [
{
"BeginOffset": number,
"EndOffset": number,
"TopAnswer": boolean,
"Type": "string"
}
],
"Text": "string"
},
"DocumentId": "string",
"DocumentTitle": {
"Highlights": [
{
"BeginOffset": number,
"EndOffset": number,
"TopAnswer": boolean,
"Type": "string"
}
],
"Text": "string"
},
"DocumentURI": "string",
"FeedbackToken": "string",
"Format": "string",
"Id": "string",
"ScoreAttributes": {
"ScoreConfidence": "string"
},
"TableExcerpt": {
"Rows": [
{
"Cells": [
{
"Header": boolean,
"Highlighted": boolean,
"TopAnswer": boolean,
"Value": "string"
}
]
}
],
"TotalNumberOfRows": number
},
"Type": "string"
}
],
"SpellCorrectedQueries": [
{
"Corrections": [
{
"BeginOffset": number,
"CorrectedTerm": "string",
"EndOffset": number,
"Term": "string"
}
],
"SuggestedQueryText": "string"
}
],
"TotalNumberOfResults": number,
"Warnings": [
{
"Code": "string",
"Message": "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.
** [FacetResults](#API_Query_ResponseSyntax) **
Contains the facet results. A `FacetResult` contains the counts for each field/attribute key that was specified in the `Facets` input parameter.
Type: Array of [FacetResult](API_FacetResult.md) objects
** [FeaturedResultsItems](#API_Query_ResponseSyntax) **
The list of featured result items. Featured results are displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then certain documents are featured in the search results.
Type: Array of [FeaturedResultsItem](API_FeaturedResultsItem.md) objects
** [QueryId](#API_Query_ResponseSyntax) **
The identifier for the search. You also use `QueryId` to identify the search when using the [SubmitFeedback](https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html) API.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
** [ResultItems](#API_Query_ResponseSyntax) **
The results of the search.
Type: Array of [QueryResultItem](API_QueryResultItem.md) objects
** [SpellCorrectedQueries](#API_Query_ResponseSyntax) **
A list of information related to suggested spell corrections for a query.
Type: Array of [SpellCorrectedQuery](API_SpellCorrectedQuery.md) objects
** [TotalNumberOfResults](#API_Query_ResponseSyntax) **
The total number of items found by the search. However, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.
Type: Integer
** [Warnings](#API_Query_ResponseSyntax) **
A list of warning codes and their messages on problems with your query.
Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in the query. For examples of invalid query syntax, see [Searching with advanced query syntax](https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax).
Type: Array of [Warning](API_Warning.md) objects
Array Members: Fixed number of 1 item.
## 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/Query)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/Query)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/Query)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/Query)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/Query)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/Query)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/Query)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/Query)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/Query)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/Query)
# Retrieve
Retrieves relevant passages or text excerpts given an input query.
This API is similar to the [Query](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) API. However, by default, the `Query` API only returns excerpt passages of up to 100 token words. With the `Retrieve` API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be semantically extracted from multiple documents and multiple parts of the same document. If in extreme cases your documents produce zero passages using the `Retrieve` API, you can alternatively use the `Query` API and its types of responses.
You can also do the following:
+ Override boosting at the index level
+ Filter based on document fields or attributes
+ Filter based on the user or their group access to documents
+ View the confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.
**Note**
Confidence score buckets are currently available only for English.
You can also include certain fields in the response that might provide useful additional information.
The `Retrieve` API shares the number of [query capacity units](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CapacityUnitsConfiguration.html) that you set for your index. For more information on what's included in a single capacity unit and the default base capacity for an index, see [Adjusting capacity](https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html).
**Important**
If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use `ATTRIBUTE_FILTER` to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use `USER_TOKEN` to configure user context policy, Amazon Kendra returns a `ValidationException` error.
## Request Syntax
```
{
"AttributeFilter": {
"AndAllFilters": [
"AttributeFilter"
],
"ContainsAll": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"ContainsAny": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"EqualsTo": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"GreaterThan": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"GreaterThanOrEquals": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"LessThan": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"LessThanOrEquals": {
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
},
"NotFilter": "AttributeFilter",
"OrAllFilters": [
"AttributeFilter"
]
},
"DocumentRelevanceOverrideConfigurations": [
{
"Name": "string",
"Relevance": {
"Duration": "string",
"Freshness": boolean,
"Importance": number,
"RankOrder": "string",
"ValueImportanceMap": {
"string" : number
}
}
}
],
"IndexId": "string",
"PageNumber": number,
"PageSize": number,
"QueryText": "string",
"RequestedDocumentAttributes": [ "string" ],
"UserContext": {
"DataSourceGroups": [
{
"DataSourceId": "string",
"GroupId": "string"
}
],
"Groups": [ "string" ],
"Token": "string",
"UserId": "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.
** [AttributeFilter](#API_Retrieve_RequestSyntax) **
Filters search results by document fields/attributes. You can only provide one attribute filter; however, the `AndAllFilters`, `NotFilter`, and `OrAllFilters` parameters contain a list of other filters.
The `AttributeFilter` parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results.
For Amazon Kendra Gen AI Enterprise Edition indices use `AttributeFilter` to enable document filtering for end users using `_email_id` or include public documents (`_email_id=null`).
Type: [AttributeFilter](API_AttributeFilter.md) object
Required: No
** [DocumentRelevanceOverrideConfigurations](#API_Retrieve_RequestSyntax) **
Overrides relevance tuning configurations of fields/attributes set at the index level.
If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.
If there is relevance tuning configured for fields at the index level, and you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.
Type: Array of [DocumentRelevanceConfiguration](API_DocumentRelevanceConfiguration.md) objects
Array Members: Minimum number of 0 items. Maximum number of 500 items.
Required: No
** [IndexId](#API_Retrieve_RequestSyntax) **
The identifier of the index to retrieve relevant passages for the search.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [PageNumber](#API_Retrieve_RequestSyntax) **
Retrieved relevant passages are returned in pages the size of the `PageSize` parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.
Type: Integer
Required: No
** [PageSize](#API_Retrieve_RequestSyntax) **
Sets the number of retrieved relevant passages that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.
Type: Integer
Required: No
** [QueryText](#API_Retrieve_RequestSyntax) **
The input query text to retrieve relevant passages for the search. Amazon Kendra truncates queries at 30 token words, which excludes punctuation and stop words. Truncation still applies if you use Boolean or more advanced, complex queries. For example, `Timeoff AND October AND Category:HR` is counted as 3 tokens: `timeoff`, `october`, `hr`. For more information, see [Searching with advanced query syntax](https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax) in the Amazon Kendra Developer Guide.
Type: String
Required: Yes
** [RequestedDocumentAttributes](#API_Retrieve_RequestSyntax) **
A list of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document fields are included in the response.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `[a-zA-Z0-9_][a-zA-Z0-9_-]*`
Required: No
** [UserContext](#API_Retrieve_RequestSyntax) **
The user context token or user and group information.
Type: [UserContext](API_UserContext.md) object
Required: No
## Response Syntax
```
{
"QueryId": "string",
"ResultItems": [
{
"Content": "string",
"DocumentAttributes": [
{
"Key": "string",
"Value": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
}
}
],
"DocumentId": "string",
"DocumentTitle": "string",
"DocumentURI": "string",
"Id": "string",
"ScoreAttributes": {
"ScoreConfidence": "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.
** [QueryId](#API_Retrieve_ResponseSyntax) **
The identifier of query used for the search. You also use `QueryId` to identify the search when using the [Submitfeedback](https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html) API.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
** [ResultItems](#API_Retrieve_ResponseSyntax) **
The results of the retrieved relevant passages for the search.
Type: Array of [RetrieveResultItem](API_RetrieveResultItem.md) objects
## 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/Retrieve)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/Retrieve)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/Retrieve)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/Retrieve)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/Retrieve)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/Retrieve)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/Retrieve)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/Retrieve)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/Retrieve)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/Retrieve)
# StartDataSourceSyncJob
Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a `ResourceInUseException` exception.
Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source respository could take up to an hour or more, depending on the number of documents to sync.
## Request Syntax
```
{
"Id": "string",
"IndexId": "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.
** [Id](#API_StartDataSourceSyncJob_RequestSyntax) **
The identifier of the data source connector to synchronize.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_StartDataSourceSyncJob_RequestSyntax) **
The identifier of the index used with the data source connector.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Syntax
```
{
"ExecutionId": "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.
** [ExecutionId](#API_StartDataSourceSyncJob_ResponseSyntax) **
Identifies a particular synchronization job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
## 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
** ResourceInUseException **
The resource you want to use is currently in use. Please check you have provided the correct resource and try again.
HTTP Status Code: 400
** 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
** 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/StartDataSourceSyncJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/StartDataSourceSyncJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/StartDataSourceSyncJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/StartDataSourceSyncJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/StartDataSourceSyncJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/StartDataSourceSyncJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/StartDataSourceSyncJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/StartDataSourceSyncJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/StartDataSourceSyncJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/StartDataSourceSyncJob)
# StopDataSourceSyncJob
Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
## Request Syntax
```
{
"Id": "string",
"IndexId": "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.
** [Id](#API_StopDataSourceSyncJob_RequestSyntax) **
The identifier of the data source connector for which to stop the synchronization jobs.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_StopDataSourceSyncJob_RequestSyntax) **
The identifier of the index used with the data source connector.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** 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
** 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/StopDataSourceSyncJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/StopDataSourceSyncJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/StopDataSourceSyncJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/StopDataSourceSyncJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/StopDataSourceSyncJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/StopDataSourceSyncJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/StopDataSourceSyncJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/StopDataSourceSyncJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/StopDataSourceSyncJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/StopDataSourceSyncJob)
# SubmitFeedback
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
`SubmitFeedback` is currently not supported in the AWS GovCloud (US-West) region.
## Request Syntax
```
{
"ClickFeedbackItems": [
{
"ClickTime": number,
"ResultId": "string"
}
],
"IndexId": "string",
"QueryId": "string",
"RelevanceFeedbackItems": [
{
"RelevanceValue": "string",
"ResultId": "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.
** [ClickFeedbackItems](#API_SubmitFeedback_RequestSyntax) **
Tells Amazon Kendra that a particular search result link was chosen by the user.
Type: Array of [ClickFeedback](API_ClickFeedback.md) objects
Required: No
** [IndexId](#API_SubmitFeedback_RequestSyntax) **
The identifier of the index that was queried.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [QueryId](#API_SubmitFeedback_RequestSyntax) **
The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the `Query` API.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [RelevanceFeedbackItems](#API_SubmitFeedback_RequestSyntax) **
Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.
Type: Array of [RelevanceFeedback](API_RelevanceFeedback.md) objects
Required: No
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** 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
** ResourceUnavailableException **
The resource you want to use isn't available. Please check you have provided the correct resource and try again.
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/SubmitFeedback)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/SubmitFeedback)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SubmitFeedback)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/SubmitFeedback)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SubmitFeedback)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/SubmitFeedback)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/SubmitFeedback)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/SubmitFeedback)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/SubmitFeedback)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SubmitFeedback)
# TagResource
Adds the specified tag to the specified index, FAQ, data source, or other resource. If the tag already exists, the existing value is replaced with the new value.
## Request Syntax
```
{
"ResourceARN": "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.
** [ResourceARN](#API_TagResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to add a tag. For example, the ARN of an index is constructed as follows: *arn:aws:kendra:your-region:your-account-id:index/index-id* For information on how to construct an ARN for all types of Amazon Kendra resources, see [Resource types](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendra.html#amazonkendra-resources-for-iam-policies).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
** [Tags](#API_TagResource_RequestSyntax) **
A list of tag keys to add to the index, FAQ, data source, or other resource. If a tag already exists, the existing value is replaced with the new value.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** 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
** ResourceUnavailableException **
The resource you want to use isn't available. Please check you have provided the correct resource and try again.
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/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/TagResource)
# UntagResource
Removes a tag from an index, FAQ, data source, or other resource.
## Request Syntax
```
{
"ResourceARN": "string",
"TagKeys": [ "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.
** [ResourceARN](#API_UntagResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to remove a tag. For example, the ARN of an index is constructed as follows: *arn:aws:kendra:your-region:your-account-id:index/index-id* For information on how to construct an ARN for all types of Amazon Kendra resources, see [Resource types](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendra.html#amazonkendra-resources-for-iam-policies).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
** [TagKeys](#API_UntagResource_RequestSyntax) **
A list of tag keys to remove from the index, FAQ, data source, or other resource. If a tag key doesn't exist for the resource, it is ignored.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** 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
** ResourceUnavailableException **
The resource you want to use isn't available. Please check you have provided the correct resource and try again.
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/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/UntagResource)
# UpdateAccessControlConfiguration
Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change.
You call the [BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) API to apply the updated access control configuration, with the `AccessControlConfigurationId` included in the [Document](https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html) object. If you use an S3 bucket as a data source, you synchronize your data source to apply the `AccessControlConfigurationId` in the `.metadata.json` file. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the `BatchPutDocument` API.
**Important**
You can't configure access control using `CreateAccessControlConfiguration` for an Amazon Kendra Gen AI Enterprise Edition index. Amazon Kendra will return a `ValidationException` error for a `Gen_AI_ENTERPRISE_EDITION` index.
## Request Syntax
```
{
"AccessControlList": [
{
"Access": "string",
"DataSourceId": "string",
"Name": "string",
"Type": "string"
}
],
"Description": "string",
"HierarchicalAccessControlList": [
{
"PrincipalList": [
{
"Access": "string",
"DataSourceId": "string",
"Name": "string",
"Type": "string"
}
]
}
],
"Id": "string",
"IndexId": "string",
"Name": "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.
** [AccessControlList](#API_UpdateAccessControlConfiguration_RequestSyntax) **
Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
Type: Array of [Principal](API_Principal.md) objects
Required: No
** [Description](#API_UpdateAccessControlConfiguration_RequestSyntax) **
A new description for the access control configuration.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
Required: No
** [HierarchicalAccessControlList](#API_UpdateAccessControlConfiguration_RequestSyntax) **
The updated list of [principal](https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) lists that define the hierarchy for which documents users should have access to.
Type: Array of [HierarchicalPrincipal](API_HierarchicalPrincipal.md) objects
Array Members: Minimum number of 1 item. Maximum number of 30 items.
Required: No
** [Id](#API_UpdateAccessControlConfiguration_RequestSyntax) **
The identifier of the access control configuration you want to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9-]+`
Required: Yes
** [IndexId](#API_UpdateAccessControlConfiguration_RequestSyntax) **
The identifier of the index for an access control configuration.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [Name](#API_UpdateAccessControlConfiguration_RequestSyntax) **
A new name for the access control configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `[\S\s]*`
Required: No
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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/UpdateAccessControlConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/UpdateAccessControlConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/UpdateAccessControlConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/UpdateAccessControlConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/UpdateAccessControlConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/UpdateAccessControlConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/UpdateAccessControlConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/UpdateAccessControlConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/UpdateAccessControlConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/UpdateAccessControlConfiguration)
# UpdateDataSource
Updates an Amazon Kendra data source connector.
## Request Syntax
```
{
"Configuration": {
"AlfrescoConfiguration": {
"BlogFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"CrawlComments": boolean,
"CrawlSystemFolders": boolean,
"DocumentLibraryFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"EntityFilter": [ "string" ],
"ExclusionPatterns": [ "string" ],
"InclusionPatterns": [ "string" ],
"SecretArn": "string",
"SiteId": "string",
"SiteUrl": "string",
"SslCertificateS3Path": {
"Bucket": "string",
"Key": "string"
},
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
},
"WikiFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"BoxConfiguration": {
"CommentFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"CrawlComments": boolean,
"CrawlTasks": boolean,
"CrawlWebLinks": boolean,
"EnterpriseId": "string",
"ExclusionPatterns": [ "string" ],
"FileFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"SecretArn": "string",
"TaskFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"UseChangeLog": boolean,
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
},
"WebLinkFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"ConfluenceConfiguration": {
"AttachmentConfiguration": {
"AttachmentFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"CrawlAttachments": boolean
},
"AuthenticationType": "string",
"BlogConfiguration": {
"BlogFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"ExclusionPatterns": [ "string" ],
"InclusionPatterns": [ "string" ],
"PageConfiguration": {
"PageFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"ProxyConfiguration": {
"Credentials": "string",
"Host": "string",
"Port": number
},
"SecretArn": "string",
"ServerUrl": "string",
"SpaceConfiguration": {
"CrawlArchivedSpaces": boolean,
"CrawlPersonalSpaces": boolean,
"ExcludeSpaces": [ "string" ],
"IncludeSpaces": [ "string" ],
"SpaceFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"Version": "string",
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"DatabaseConfiguration": {
"AclConfiguration": {
"AllowedGroupsColumnName": "string"
},
"ColumnConfiguration": {
"ChangeDetectingColumns": [ "string" ],
"DocumentDataColumnName": "string",
"DocumentIdColumnName": "string",
"DocumentTitleColumnName": "string",
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"ConnectionConfiguration": {
"DatabaseHost": "string",
"DatabaseName": "string",
"DatabasePort": number,
"SecretArn": "string",
"TableName": "string"
},
"DatabaseEngineType": "string",
"SqlConfiguration": {
"QueryIdentifiersEnclosingOption": "string"
},
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"FsxConfiguration": {
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"FileSystemId": "string",
"FileSystemType": "string",
"InclusionPatterns": [ "string" ],
"SecretArn": "string",
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"GitHubConfiguration": {
"ExclusionFileNamePatterns": [ "string" ],
"ExclusionFileTypePatterns": [ "string" ],
"ExclusionFolderNamePatterns": [ "string" ],
"GitHubCommitConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubDocumentCrawlProperties": {
"CrawlIssue": boolean,
"CrawlIssueComment": boolean,
"CrawlIssueCommentAttachment": boolean,
"CrawlPullRequest": boolean,
"CrawlPullRequestComment": boolean,
"CrawlPullRequestCommentAttachment": boolean,
"CrawlRepositoryDocuments": boolean
},
"GitHubIssueAttachmentConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubIssueCommentConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubIssueDocumentConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubPullRequestCommentConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubPullRequestDocumentAttachmentConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubPullRequestDocumentConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"GitHubRepositoryConfigurationFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionFileNamePatterns": [ "string" ],
"InclusionFileTypePatterns": [ "string" ],
"InclusionFolderNamePatterns": [ "string" ],
"OnPremiseConfiguration": {
"HostUrl": "string",
"OrganizationName": "string",
"SslCertificateS3Path": {
"Bucket": "string",
"Key": "string"
}
},
"RepositoryFilter": [ "string" ],
"SaaSConfiguration": {
"HostUrl": "string",
"OrganizationName": "string"
},
"SecretArn": "string",
"Type": "string",
"UseChangeLog": boolean,
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"GoogleDriveConfiguration": {
"ExcludeMimeTypes": [ "string" ],
"ExcludeSharedDrives": [ "string" ],
"ExcludeUserAccounts": [ "string" ],
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"SecretArn": "string"
},
"JiraConfiguration": {
"AttachmentFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"CommentFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"ExclusionPatterns": [ "string" ],
"InclusionPatterns": [ "string" ],
"IssueFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"IssueSubEntityFilter": [ "string" ],
"IssueType": [ "string" ],
"JiraAccountUrl": "string",
"Project": [ "string" ],
"ProjectFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"SecretArn": "string",
"Status": [ "string" ],
"UseChangeLog": boolean,
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
},
"WorkLogFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"OneDriveConfiguration": {
"DisableLocalGroups": boolean,
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"OneDriveUsers": {
"OneDriveUserList": [ "string" ],
"OneDriveUserS3Path": {
"Bucket": "string",
"Key": "string"
}
},
"SecretArn": "string",
"TenantDomain": "string"
},
"QuipConfiguration": {
"AttachmentFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"CrawlAttachments": boolean,
"CrawlChatRooms": boolean,
"CrawlFileComments": boolean,
"Domain": "string",
"ExclusionPatterns": [ "string" ],
"FolderIds": [ "string" ],
"InclusionPatterns": [ "string" ],
"MessageFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"SecretArn": "string",
"ThreadFieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"S3Configuration": {
"AccessControlListConfiguration": {
"KeyPath": "string"
},
"BucketName": "string",
"DocumentsMetadataConfiguration": {
"S3Prefix": "string"
},
"ExclusionPatterns": [ "string" ],
"InclusionPatterns": [ "string" ],
"InclusionPrefixes": [ "string" ]
},
"SalesforceConfiguration": {
"ChatterFeedConfiguration": {
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"IncludeFilterTypes": [ "string" ]
},
"CrawlAttachments": boolean,
"ExcludeAttachmentFilePatterns": [ "string" ],
"IncludeAttachmentFilePatterns": [ "string" ],
"KnowledgeArticleConfiguration": {
"CustomKnowledgeArticleTypeConfigurations": [
{
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"Name": "string"
}
],
"IncludedStates": [ "string" ],
"StandardKnowledgeArticleTypeConfiguration": {
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
}
},
"SecretArn": "string",
"ServerUrl": "string",
"StandardObjectAttachmentConfiguration": {
"DocumentTitleFieldName": "string",
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
]
},
"StandardObjectConfigurations": [
{
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"Name": "string"
}
]
},
"ServiceNowConfiguration": {
"AuthenticationType": "string",
"HostUrl": "string",
"KnowledgeArticleConfiguration": {
"CrawlAttachments": boolean,
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"ExcludeAttachmentFilePatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"FilterQuery": "string",
"IncludeAttachmentFilePatterns": [ "string" ]
},
"SecretArn": "string",
"ServiceCatalogConfiguration": {
"CrawlAttachments": boolean,
"DocumentDataFieldName": "string",
"DocumentTitleFieldName": "string",
"ExcludeAttachmentFilePatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"IncludeAttachmentFilePatterns": [ "string" ]
},
"ServiceNowBuildVersion": "string"
},
"SharePointConfiguration": {
"AuthenticationType": "string",
"CrawlAttachments": boolean,
"DisableLocalGroups": boolean,
"DocumentTitleFieldName": "string",
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"ProxyConfiguration": {
"Credentials": "string",
"Host": "string",
"Port": number
},
"SecretArn": "string",
"SharePointVersion": "string",
"SslCertificateS3Path": {
"Bucket": "string",
"Key": "string"
},
"Urls": [ "string" ],
"UseChangeLog": boolean,
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"SlackConfiguration": {
"CrawlBotMessage": boolean,
"ExcludeArchived": boolean,
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"LookBackPeriod": number,
"PrivateChannelFilter": [ "string" ],
"PublicChannelFilter": [ "string" ],
"SecretArn": "string",
"SinceCrawlDate": "string",
"SlackEntityList": [ "string" ],
"TeamId": "string",
"UseChangeLog": boolean,
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ]
}
},
"TemplateConfiguration": {
"Template": JSON value
},
"WebCrawlerConfiguration": {
"AuthenticationConfiguration": {
"BasicAuthentication": [
{
"Credentials": "string",
"Host": "string",
"Port": number
}
]
},
"CrawlDepth": number,
"MaxContentSizePerPageInMegaBytes": number,
"MaxLinksPerPage": number,
"MaxUrlsPerMinuteCrawlRate": number,
"ProxyConfiguration": {
"Credentials": "string",
"Host": "string",
"Port": number
},
"UrlExclusionPatterns": [ "string" ],
"UrlInclusionPatterns": [ "string" ],
"Urls": {
"SeedUrlConfiguration": {
"SeedUrls": [ "string" ],
"WebCrawlerMode": "string"
},
"SiteMapsConfiguration": {
"SiteMaps": [ "string" ]
}
}
},
"WorkDocsConfiguration": {
"CrawlComments": boolean,
"ExclusionPatterns": [ "string" ],
"FieldMappings": [
{
"DataSourceFieldName": "string",
"DateFieldFormat": "string",
"IndexFieldName": "string"
}
],
"InclusionPatterns": [ "string" ],
"OrganizationId": "string",
"UseChangeLog": boolean
}
},
"CustomDocumentEnrichmentConfiguration": {
"InlineConfigurations": [
{
"Condition": {
"ConditionDocumentAttributeKey": "string",
"ConditionOnValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"Operator": "string"
},
"DocumentContentDeletion": boolean,
"Target": {
"TargetDocumentAttributeKey": "string",
"TargetDocumentAttributeValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"TargetDocumentAttributeValueDeletion": boolean
}
}
],
"PostExtractionHookConfiguration": {
"InvocationCondition": {
"ConditionDocumentAttributeKey": "string",
"ConditionOnValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"Operator": "string"
},
"LambdaArn": "string",
"S3Bucket": "string"
},
"PreExtractionHookConfiguration": {
"InvocationCondition": {
"ConditionDocumentAttributeKey": "string",
"ConditionOnValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"Operator": "string"
},
"LambdaArn": "string",
"S3Bucket": "string"
},
"RoleArn": "string"
},
"Description": "string",
"Id": "string",
"IndexId": "string",
"LanguageCode": "string",
"Name": "string",
"RoleArn": "string",
"Schedule": "string",
"VpcConfiguration": {
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "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.
** [Configuration](#API_UpdateDataSource_RequestSyntax) **
Configuration information you want to update for the data source connector.
Type: [DataSourceConfiguration](API_DataSourceConfiguration.md) object
Required: No
** [CustomDocumentEnrichmentConfiguration](#API_UpdateDataSource_RequestSyntax) **
Configuration information you want to update for altering document metadata and content during the document ingestion process.
For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see [Customizing document metadata during the ingestion process](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).
Type: [CustomDocumentEnrichmentConfiguration](API_CustomDocumentEnrichmentConfiguration.md) object
Required: No
** [Description](#API_UpdateDataSource_RequestSyntax) **
A new description for the data source connector.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
Required: No
** [Id](#API_UpdateDataSource_RequestSyntax) **
The identifier of the data source connector you want to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_UpdateDataSource_RequestSyntax) **
The identifier of the index used with the data source connector.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [LanguageCode](#API_UpdateDataSource_RequestSyntax) **
The code for a language you want to update for the data source connector. This allows you to support a language for all documents when updating the data source. English is supported by default. For more information on supported languages, including their codes, see [Adding documents in languages other than English](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
Type: String
Length Constraints: Minimum length of 2. Maximum length of 10.
Pattern: `[a-zA-Z-]*`
Required: No
** [Name](#API_UpdateDataSource_RequestSyntax) **
A new name for the data source connector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** [RoleArn](#API_UpdateDataSource_RequestSyntax) **
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see [IAM 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: No
** [Schedule](#API_UpdateDataSource_RequestSyntax) **
The sync schedule you want to update for the data source connector.
Type: String
Required: No
** [VpcConfiguration](#API_UpdateDataSource_RequestSyntax) **
Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see [Configuring a VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
Type: [DataSourceVpcConfiguration](API_DataSourceVpcConfiguration.md) object
Required: No
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** 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/UpdateDataSource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/UpdateDataSource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/UpdateDataSource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/UpdateDataSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/UpdateDataSource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/UpdateDataSource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/UpdateDataSource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/UpdateDataSource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/UpdateDataSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/UpdateDataSource)
# UpdateExperience
Updates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see [Building a search experience with no code](https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).
## Request Syntax
```
{
"Configuration": {
"ContentSourceConfiguration": {
"DataSourceIds": [ "string" ],
"DirectPutContent": boolean,
"FaqIds": [ "string" ]
},
"UserIdentityConfiguration": {
"IdentityAttributeName": "string"
}
},
"Description": "string",
"Id": "string",
"IndexId": "string",
"Name": "string",
"RoleArn": "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.
** [Configuration](#API_UpdateExperience_RequestSyntax) **
Configuration information you want to update for your Amazon Kendra experience.
Type: [ExperienceConfiguration](API_ExperienceConfiguration.md) object
Required: No
** [Description](#API_UpdateExperience_RequestSyntax) **
A new description for your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
Required: No
** [Id](#API_UpdateExperience_RequestSyntax) **
The identifier of your Amazon Kendra experience you want to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_UpdateExperience_RequestSyntax) **
The identifier of the index for your Amazon Kendra experience.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [Name](#API_UpdateExperience_RequestSyntax) **
A new name for your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** [RoleArn](#API_UpdateExperience_RequestSyntax) **
The Amazon Resource Name (ARN) of an IAM role with permission to access the `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and IAM Identity Center that stores your users and groups information. For more information, see [IAM 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: No
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** 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/UpdateExperience)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/UpdateExperience)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/UpdateExperience)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/UpdateExperience)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/UpdateExperience)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/UpdateExperience)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/UpdateExperience)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/UpdateExperience)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/UpdateExperience)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/UpdateExperience)
# UpdateFeaturedResultsSet
Updates a set of featured results. Features results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match of a query, then one or more specific documents are featured in the search results.
## Request Syntax
```
{
"Description": "string",
"FeaturedDocuments": [
{
"Id": "string"
}
],
"FeaturedResultsSetId": "string",
"FeaturedResultsSetName": "string",
"IndexId": "string",
"QueryTexts": [ "string" ],
"Status": "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.
** [Description](#API_UpdateFeaturedResultsSet_RequestSyntax) **
A new description for the set of featured results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
Required: No
** [FeaturedDocuments](#API_UpdateFeaturedResultsSet_RequestSyntax) **
A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of featured documents, see [FeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html).
Type: Array of [FeaturedDocument](API_FeaturedDocument.md) objects
Required: No
** [FeaturedResultsSetId](#API_UpdateFeaturedResultsSet_RequestSyntax) **
The identifier of the set of featured results that you want to update.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `^[a-zA-Z-0-9]*`
Required: Yes
** [FeaturedResultsSetName](#API_UpdateFeaturedResultsSet_RequestSyntax) **
A new name for the set of featured results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][ a-zA-Z0-9_-]*`
Required: No
** [IndexId](#API_UpdateFeaturedResultsSet_RequestSyntax) **
The identifier of the index used for featuring results.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [QueryTexts](#API_UpdateFeaturedResultsSet_RequestSyntax) **
A list of queries for featuring results. For more information on the list of queries, see [FeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html).
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 49 items.
Required: No
** [Status](#API_UpdateFeaturedResultsSet_RequestSyntax) **
You can set the status to `ACTIVE` or `INACTIVE`. When the value is `ACTIVE`, featured results are ready for use. You can still configure your settings before setting the status to `ACTIVE`. The queries you specify for featured results must be unique per featured results set for each index, whether the status is `ACTIVE` or `INACTIVE`.
Type: String
Valid Values: `ACTIVE | INACTIVE`
Required: No
## Response Syntax
```
{
"FeaturedResultsSet": {
"CreationTimestamp": number,
"Description": "string",
"FeaturedDocuments": [
{
"Id": "string"
}
],
"FeaturedResultsSetId": "string",
"FeaturedResultsSetName": "string",
"LastUpdatedTimestamp": number,
"QueryTexts": [ "string" ],
"Status": "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.
** [FeaturedResultsSet](#API_UpdateFeaturedResultsSet_ResponseSyntax) **
Information on the set of featured results. This includes the identifier of the featured results set, whether the featured results set is active or inactive, when the featured results set was last updated, and more.
Type: [FeaturedResultsSet](API_FeaturedResultsSet.md) object
## 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
** FeaturedResultsConflictException **
An error message with a list of conflicting queries used across different sets of featured results. This occurred with the request for a new featured results set. Check that the queries you specified for featured results are unique per featured results set for each index.
** ConflictingItems **
A list of the conflicting queries, including the query text, the name for the featured results set, and the identifier of the featured results set.
** Message **
An explanation for the conflicting queries.
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
** 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/UpdateFeaturedResultsSet)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/UpdateFeaturedResultsSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/UpdateFeaturedResultsSet)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/UpdateFeaturedResultsSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/UpdateFeaturedResultsSet)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/UpdateFeaturedResultsSet)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/UpdateFeaturedResultsSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/UpdateFeaturedResultsSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/UpdateFeaturedResultsSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/UpdateFeaturedResultsSet)
# UpdateIndex
Updates an Amazon Kendra index.
## Request Syntax
```
{
"CapacityUnits": {
"QueryCapacityUnits": number,
"StorageCapacityUnits": number
},
"Description": "string",
"DocumentMetadataConfigurationUpdates": [
{
"Name": "string",
"Relevance": {
"Duration": "string",
"Freshness": boolean,
"Importance": number,
"RankOrder": "string",
"ValueImportanceMap": {
"string" : number
}
},
"Search": {
"Displayable": boolean,
"Facetable": boolean,
"Searchable": boolean,
"Sortable": boolean
},
"Type": "string"
}
],
"Id": "string",
"Name": "string",
"RoleArn": "string",
"UserContextPolicy": "string",
"UserGroupResolutionConfiguration": {
"UserGroupResolutionMode": "string"
},
"UserTokenConfigurations": [
{
"JsonTokenTypeConfiguration": {
"GroupAttributeField": "string",
"UserNameAttributeField": "string"
},
"JwtTokenTypeConfiguration": {
"ClaimRegex": "string",
"GroupAttributeField": "string",
"Issuer": "string",
"KeyLocation": "string",
"SecretManagerArn": "string",
"URL": "string",
"UserNameAttributeField": "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.
** [CapacityUnits](#API_UpdateIndex_RequestSyntax) **
Sets the number of additional document storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day, or make 5 API calls.
If you are using extra storage units, you can't reduce the storage capacity below what is required to meet the storage needs for your index.
Type: [CapacityUnitsConfiguration](API_CapacityUnitsConfiguration.md) object
Required: No
** [Description](#API_UpdateIndex_RequestSyntax) **
A new description for the index.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
Required: No
** [DocumentMetadataConfigurationUpdates](#API_UpdateIndex_RequestSyntax) **
The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
Type: Array of [DocumentMetadataConfiguration](API_DocumentMetadataConfiguration.md) objects
Array Members: Minimum number of 0 items. Maximum number of 500 items.
Required: No
** [Id](#API_UpdateIndex_RequestSyntax) **
The identifier of the index you want to update.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [Name](#API_UpdateIndex_RequestSyntax) **
A new name for the index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** [RoleArn](#API_UpdateIndex_RequestSyntax) **
An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.
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: No
** [UserContextPolicy](#API_UpdateIndex_RequestSyntax) **
The user context policy.
If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use `ATTRIBUTE_FILTER` to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use `USER_TOKEN` to configure user context policy, Amazon Kendra returns a `ValidationException` error.
Type: String
Valid Values: `ATTRIBUTE_FILTER | USER_TOKEN`
Required: No
** [UserGroupResolutionConfiguration](#API_UpdateIndex_RequestSyntax) **
Gets users and groups from AWS IAM Identity Center identity source. To configure this, see [UserGroupResolutionConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html). This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
If you're using an Amazon Kendra Gen AI Enterprise Edition index, `UserGroupResolutionConfiguration` isn't supported.
Type: [UserGroupResolutionConfiguration](API_UserGroupResolutionConfiguration.md) object
Required: No
** [UserTokenConfigurations](#API_UpdateIndex_RequestSyntax) **
The user token configuration.
If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use `UserTokenConfigurations` to configure user context policy, Amazon Kendra returns a `ValidationException` error.
Type: Array of [UserTokenConfiguration](API_UserTokenConfiguration.md) objects
Array Members: Maximum number of 1 item.
Required: No
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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/UpdateIndex)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/UpdateIndex)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/UpdateIndex)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/UpdateIndex)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/UpdateIndex)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/UpdateIndex)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/UpdateIndex)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/UpdateIndex)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/UpdateIndex)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/UpdateIndex)
# UpdateQuerySuggestionsBlockList
Updates a block list used for query suggestions for an index.
Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately.
If a block list is updating, then you need to wait for the first update to finish before submitting another update.
Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
`UpdateQuerySuggestionsBlockList` is currently not supported in the AWS GovCloud (US-West) region.
## Request Syntax
```
{
"Description": "string",
"Id": "string",
"IndexId": "string",
"Name": "string",
"RoleArn": "string",
"SourceS3Path": {
"Bucket": "string",
"Key": "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.
** [Description](#API_UpdateQuerySuggestionsBlockList_RequestSyntax) **
A new description for the block list.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
Required: No
** [Id](#API_UpdateQuerySuggestionsBlockList_RequestSyntax) **
The identifier of the block list you want to update.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [IndexId](#API_UpdateQuerySuggestionsBlockList_RequestSyntax) **
The identifier of the index for the block list.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [Name](#API_UpdateQuerySuggestionsBlockList_RequestSyntax) **
A new name for the block list.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*`
Required: No
** [RoleArn](#API_UpdateQuerySuggestionsBlockList_RequestSyntax) **
The IAM (Identity and Access Management) role used to access the block list text file in S3.
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: No
** [SourceS3Path](#API_UpdateQuerySuggestionsBlockList_RequestSyntax) **
The S3 path where your block list text file sits in S3.
If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the `UpdateQuerySuggestionsBlockList` API to refresh you block list.
If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.
Type: [S3Path](API_S3Path.md) object
Required: No
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** 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/UpdateQuerySuggestionsBlockList)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/UpdateQuerySuggestionsBlockList)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/UpdateQuerySuggestionsBlockList)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/UpdateQuerySuggestionsBlockList)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/UpdateQuerySuggestionsBlockList)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/UpdateQuerySuggestionsBlockList)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/UpdateQuerySuggestionsBlockList)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/UpdateQuerySuggestionsBlockList)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/UpdateQuerySuggestionsBlockList)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/UpdateQuerySuggestionsBlockList)
# UpdateQuerySuggestionsConfig
Updates the settings of query suggestions for an index.
Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
If an update is currently processing, you need to wait for the update to finish before making another update.
Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.
You can still enable/disable query suggestions at any time.
`UpdateQuerySuggestionsConfig` is currently not supported in the AWS GovCloud (US-West) region.
## Request Syntax
```
{
"AttributeSuggestionsConfig": {
"AttributeSuggestionsMode": "string",
"SuggestableConfigList": [
{
"AttributeName": "string",
"Suggestable": boolean
}
]
},
"IncludeQueriesWithoutUserInformation": boolean,
"IndexId": "string",
"MinimumNumberOfQueryingUsers": number,
"MinimumQueryCount": number,
"Mode": "string",
"QueryLogLookBackWindowInDays": number
}
```
## 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.
** [AttributeSuggestionsConfig](#API_UpdateQuerySuggestionsConfig_RequestSyntax) **
Configuration information for the document fields/attributes that you want to base query suggestions on.
Type: [AttributeSuggestionsUpdateConfig](API_AttributeSuggestionsUpdateConfig.md) object
Required: No
** [IncludeQueriesWithoutUserInformation](#API_UpdateQuerySuggestionsConfig_RequestSyntax) **
`TRUE` to include queries without user information (i.e. all queries, irrespective of the user), otherwise `FALSE` to only include queries with user information.
If you pass user information to Amazon Kendra along with the queries, you can set this flag to `FALSE` and instruct Amazon Kendra to only consider queries with user information.
If you set to `FALSE`, Amazon Kendra only considers queries searched at least `MinimumQueryCount` times across `MinimumNumberOfQueryingUsers` unique users for suggestions.
If you set to `TRUE`, Amazon Kendra ignores all user information and learns from all queries.
Type: Boolean
Required: No
** [IndexId](#API_UpdateQuerySuggestionsConfig_RequestSyntax) **
The identifier of the index with query suggestions you want to update.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [MinimumNumberOfQueryingUsers](#API_UpdateQuerySuggestionsConfig_RequestSyntax) **
The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.
Increasing this number might decrease the number of suggestions. However, this ensures a query is searched by many users and is truly popular to suggest to users.
How you tune this setting depends on your specific needs.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10000.
Required: No
** [MinimumQueryCount](#API_UpdateQuerySuggestionsConfig_RequestSyntax) **
The the minimum number of times a query must be searched in order to be eligible to suggest to your users.
Decreasing this number increases the number of suggestions. However, this affects the quality of suggestions as it sets a low bar for a query to be considered popular to suggest to users.
How you tune this setting depends on your specific needs.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10000.
Required: No
** [Mode](#API_UpdateQuerySuggestionsConfig_RequestSyntax) **
Set the mode to `ENABLED` or `LEARN_ONLY`.
By default, Amazon Kendra enables query suggestions. `LEARN_ONLY` mode allows you to turn off query suggestions. You can to update this at any time.
In `LEARN_ONLY` mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date for when you are ready to switch to ENABLED mode again.
Type: String
Valid Values: `ENABLED | LEARN_ONLY`
Required: No
** [QueryLogLookBackWindowInDays](#API_UpdateQuerySuggestionsConfig_RequestSyntax) **
How recent your queries are in your query log time window.
The time window is the number of days from current day to past days.
By default, Amazon Kendra sets this to 180.
Type: Integer
Required: No
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** 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/UpdateQuerySuggestionsConfig)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/UpdateQuerySuggestionsConfig)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/UpdateQuerySuggestionsConfig)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/UpdateQuerySuggestionsConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/UpdateQuerySuggestionsConfig)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/UpdateQuerySuggestionsConfig)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/UpdateQuerySuggestionsConfig)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/UpdateQuerySuggestionsConfig)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/UpdateQuerySuggestionsConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/UpdateQuerySuggestionsConfig)
# UpdateThesaurus
Updates a thesaurus for an index.
## Request Syntax
```
{
"Description": "string",
"Id": "string",
"IndexId": "string",
"Name": "string",
"RoleArn": "string",
"SourceS3Path": {
"Bucket": "string",
"Key": "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.
** [Description](#API_UpdateThesaurus_RequestSyntax) **
A new description for the thesaurus.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
Required: No
** [Id](#API_UpdateThesaurus_RequestSyntax) **
The identifier of the thesaurus you want to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [IndexId](#API_UpdateThesaurus_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_UpdateThesaurus_RequestSyntax) **
A new 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: No
** [RoleArn](#API_UpdateThesaurus_RequestSyntax) **
An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in `SourceS3Path`.
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: No
** [SourceS3Path](#API_UpdateThesaurus_RequestSyntax) **
Information required to find a specific file in an Amazon S3 bucket.
Type: [S3Path](API_S3Path.md) object
Required: No
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** 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/UpdateThesaurus)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/UpdateThesaurus)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/UpdateThesaurus)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/UpdateThesaurus)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/UpdateThesaurus)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/UpdateThesaurus)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/UpdateThesaurus)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/UpdateThesaurus)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/UpdateThesaurus)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/UpdateThesaurus)
# Amazon Kendra Intelligent Ranking
The following actions are supported by Amazon Kendra Intelligent Ranking:
+ [CreateRescoreExecutionPlan](API_Ranking_CreateRescoreExecutionPlan.md)
+ [DeleteRescoreExecutionPlan](API_Ranking_DeleteRescoreExecutionPlan.md)
+ [DescribeRescoreExecutionPlan](API_Ranking_DescribeRescoreExecutionPlan.md)
+ [ListRescoreExecutionPlans](API_Ranking_ListRescoreExecutionPlans.md)
+ [ListTagsForResource](API_Ranking_ListTagsForResource.md)
+ [Rescore](API_Ranking_Rescore.md)
+ [TagResource](API_Ranking_TagResource.md)
+ [UntagResource](API_Ranking_UntagResource.md)
+ [UpdateRescoreExecutionPlan](API_Ranking_UpdateRescoreExecutionPlan.md)
# CreateRescoreExecutionPlan
Creates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the `Rescore` API. You set the number of capacity units that you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service's results.
For an example of using the `CreateRescoreExecutionPlan` API, including using the Python and Java SDKs, see [Semantically ranking a search service's results](https://docs.aws.amazon.com/kendra/latest/dg/search-service-rerank.html).
## Request Syntax
```
{
"CapacityUnits": {
"RescoreCapacityUnits": number
},
"ClientToken": "string",
"Description": "string",
"Name": "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.
** [CapacityUnits](#API_Ranking_CreateRescoreExecutionPlan_RequestSyntax) **
You can set additional capacity units to meet the needs of your rescore execution plan. You are given a single capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For more information on the default capacity and additional capacity units, see [Adjusting capacity](https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html).
Type: [CapacityUnitsConfiguration](API_Ranking_CapacityUnitsConfiguration.md) object
Required: No
** [ClientToken](#API_Ranking_CreateRescoreExecutionPlan_RequestSyntax) **
A token that you provide to identify the request to create a rescore execution plan. Multiple calls to the `CreateRescoreExecutionPlanRequest` API with the same client token will create only one rescore execution plan.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `^$|[\x00-\x7F]+`
Required: No
** [Description](#API_Ranking_CreateRescoreExecutionPlan_RequestSyntax) **
A description for the rescore execution plan.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
Required: No
** [Name](#API_Ranking_CreateRescoreExecutionPlan_RequestSyntax) **
A name for the rescore execution plan.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** [Tags](#API_Ranking_CreateRescoreExecutionPlan_RequestSyntax) **
A list of key-value pairs that identify or categorize your rescore execution plan. You can also use tags to help control access to the rescore execution plan. 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_Ranking_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
{
"Arn": "string",
"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.
** [Arn](#API_Ranking_CreateRescoreExecutionPlan_ResponseSyntax) **
The Amazon Resource Name (ARN) of the rescore execution plan.
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}`
** [Id](#API_Ranking_CreateRescoreExecutionPlan_ResponseSyntax) **
The identifier of the rescore execution plan.
Type: String
Length Constraints: Fixed length of 36.
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 inconsistencies with your resources and try again.
HTTP Status Code: 400
** InternalServerException **
An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.
HTTP Status Code: 500
** ServiceQuotaExceededException **
You have exceeded the set limits for your Amazon Kendra Intelligent Ranking 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 Intelligent Ranking 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-ranking-2022-10-19/CreateRescoreExecutionPlan)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-ranking-2022-10-19/CreateRescoreExecutionPlan)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-ranking-2022-10-19/CreateRescoreExecutionPlan)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-ranking-2022-10-19/CreateRescoreExecutionPlan)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-ranking-2022-10-19/CreateRescoreExecutionPlan)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-ranking-2022-10-19/CreateRescoreExecutionPlan)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-ranking-2022-10-19/CreateRescoreExecutionPlan)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-ranking-2022-10-19/CreateRescoreExecutionPlan)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-ranking-2022-10-19/CreateRescoreExecutionPlan)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-ranking-2022-10-19/CreateRescoreExecutionPlan)
# DeleteRescoreExecutionPlan
Deletes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the `Rescore` API.
## Request Syntax
```
{
"Id": "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.
** [Id](#API_Ranking_DeleteRescoreExecutionPlan_RequestSyntax) **
The identifier of the rescore execution plan that you want to delete.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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 inconsistencies with your resources and try again.
HTTP Status Code: 400
** InternalServerException **
An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking 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
** 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 Intelligent Ranking 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-ranking-2022-10-19/DeleteRescoreExecutionPlan)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-ranking-2022-10-19/DeleteRescoreExecutionPlan)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-ranking-2022-10-19/DeleteRescoreExecutionPlan)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-ranking-2022-10-19/DeleteRescoreExecutionPlan)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-ranking-2022-10-19/DeleteRescoreExecutionPlan)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-ranking-2022-10-19/DeleteRescoreExecutionPlan)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-ranking-2022-10-19/DeleteRescoreExecutionPlan)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-ranking-2022-10-19/DeleteRescoreExecutionPlan)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-ranking-2022-10-19/DeleteRescoreExecutionPlan)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-ranking-2022-10-19/DeleteRescoreExecutionPlan)
# DescribeRescoreExecutionPlan
Gets information about a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the `Rescore` API.
## Request Syntax
```
{
"Id": "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.
** [Id](#API_Ranking_DescribeRescoreExecutionPlan_RequestSyntax) **
The identifier of the rescore execution plan that you want to get information on.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
## Response Syntax
```
{
"Arn": "string",
"CapacityUnits": {
"RescoreCapacityUnits": number
},
"CreatedAt": number,
"Description": "string",
"ErrorMessage": "string",
"Id": "string",
"Name": "string",
"Status": "string",
"UpdatedAt": number
}
```
## 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.
** [Arn](#API_Ranking_DescribeRescoreExecutionPlan_ResponseSyntax) **
The Amazon Resource Name (ARN) of the rescore execution plan.
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}`
** [CapacityUnits](#API_Ranking_DescribeRescoreExecutionPlan_ResponseSyntax) **
The capacity units set for the rescore execution plan. A capacity of zero indicates that the rescore execution plan is using the default capacity. For more information on the default capacity and additional capacity units, see [Adjusting capacity](https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html).
Type: [CapacityUnitsConfiguration](API_Ranking_CapacityUnitsConfiguration.md) object
** [CreatedAt](#API_Ranking_DescribeRescoreExecutionPlan_ResponseSyntax) **
The Unix timestamp of when the rescore execution plan was created.
Type: Timestamp
** [Description](#API_Ranking_DescribeRescoreExecutionPlan_ResponseSyntax) **
The description for the rescore execution plan.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
** [ErrorMessage](#API_Ranking_DescribeRescoreExecutionPlan_ResponseSyntax) **
When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a message that explains why.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
** [Id](#API_Ranking_DescribeRescoreExecutionPlan_ResponseSyntax) **
The identifier of the rescore execution plan.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
** [Name](#API_Ranking_DescribeRescoreExecutionPlan_ResponseSyntax) **
The name for the rescore execution plan.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
** [Status](#API_Ranking_DescribeRescoreExecutionPlan_ResponseSyntax) **
The current status of the rescore execution plan. When the value is `ACTIVE`, the rescore execution plan is ready for use. If the `Status` field value is `FAILED`, the `ErrorMessage` field contains a message that explains why.
Type: String
Valid Values: `CREATING | UPDATING | ACTIVE | DELETING | FAILED`
** [UpdatedAt](#API_Ranking_DescribeRescoreExecutionPlan_ResponseSyntax) **
The Unix timestamp of when the rescore execution plan was last updated.
Type: Timestamp
## 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
** InternalServerException **
An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking 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
** 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 Intelligent Ranking 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-ranking-2022-10-19/DescribeRescoreExecutionPlan)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-ranking-2022-10-19/DescribeRescoreExecutionPlan)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-ranking-2022-10-19/DescribeRescoreExecutionPlan)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-ranking-2022-10-19/DescribeRescoreExecutionPlan)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-ranking-2022-10-19/DescribeRescoreExecutionPlan)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-ranking-2022-10-19/DescribeRescoreExecutionPlan)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-ranking-2022-10-19/DescribeRescoreExecutionPlan)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-ranking-2022-10-19/DescribeRescoreExecutionPlan)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-ranking-2022-10-19/DescribeRescoreExecutionPlan)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-ranking-2022-10-19/DescribeRescoreExecutionPlan)
# ListRescoreExecutionPlans
Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the `Rescore` API.
## Request Syntax
```
{
"MaxResults": number,
"NextToken": "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.
** [MaxResults](#API_Ranking_ListRescoreExecutionPlans_RequestSyntax) **
The maximum number of rescore execution plans to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
** [NextToken](#API_Ranking_ListRescoreExecutionPlans_RequestSyntax) **
If the response is truncated, Amazon Kendra Intelligent Ranking returns a pagination token in the response. You can use this pagination token to retrieve the next set of rescore execution plans.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
Pattern: `^\P{C}*$`
Required: No
## Response Syntax
```
{
"NextToken": "string",
"SummaryItems": [
{
"CreatedAt": number,
"Id": "string",
"Name": "string",
"Status": "string",
"UpdatedAt": number
}
]
}
```
## 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.
** [NextToken](#API_Ranking_ListRescoreExecutionPlans_ResponseSyntax) **
If the response is truncated, Amazon Kendra Intelligent Ranking returns a pagination token in the response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
Pattern: `^\P{C}*$`
** [SummaryItems](#API_Ranking_ListRescoreExecutionPlans_ResponseSyntax) **
An array of summary information for one or more rescore execution plans.
Type: Array of [RescoreExecutionPlanSummary](API_Ranking_RescoreExecutionPlanSummary.md) objects
## 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
** InternalServerException **
An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.
HTTP Status Code: 500
** 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 Intelligent Ranking 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-ranking-2022-10-19/ListRescoreExecutionPlans)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-ranking-2022-10-19/ListRescoreExecutionPlans)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-ranking-2022-10-19/ListRescoreExecutionPlans)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-ranking-2022-10-19/ListRescoreExecutionPlans)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-ranking-2022-10-19/ListRescoreExecutionPlans)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-ranking-2022-10-19/ListRescoreExecutionPlans)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-ranking-2022-10-19/ListRescoreExecutionPlans)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-ranking-2022-10-19/ListRescoreExecutionPlans)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-ranking-2022-10-19/ListRescoreExecutionPlans)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-ranking-2022-10-19/ListRescoreExecutionPlans)
# ListTagsForResource
Gets a list of tags associated with a specified resource. A rescore execution plan is an example of a resource that can have tags associated with it.
## Request Syntax
```
{
"ResourceARN": "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.
** [ResourceARN](#API_Ranking_ListTagsForResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the rescore execution plan to get a list of tags for. For example, the ARN of a rescore execution plan is constructed as follows: *arn:aws:kendra-ranking:your-region:your-account-id:rescore-execution-plan/rescore-execution-plan-id* For information, see [Resource types](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendraintelligentranking.html#amazonkendraintelligentranking-resources-for-iam-policies).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
## Response Syntax
```
{
"Tags": [
{
"Key": "string",
"Value": "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.
** [Tags](#API_Ranking_ListTagsForResource_ResponseSyntax) **
A list of tags associated with the rescore execution plan.
Type: Array of [Tag](API_Ranking_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
## 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
** InternalServerException **
An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.
HTTP Status Code: 500
** ResourceUnavailableException **
The resource you want to use is unavailable. Please check you have provided the correct resource information and try again.
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 Intelligent Ranking 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-ranking-2022-10-19/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-ranking-2022-10-19/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-ranking-2022-10-19/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-ranking-2022-10-19/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-ranking-2022-10-19/ListTagsForResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-ranking-2022-10-19/ListTagsForResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-ranking-2022-10-19/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-ranking-2022-10-19/ListTagsForResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-ranking-2022-10-19/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-ranking-2022-10-19/ListTagsForResource)
# Rescore
Rescores or re-ranks search results from a search service such as OpenSearch (self managed). You use the semantic search capabilities of Amazon Kendra Intelligent Ranking to improve the search service's results.
## Request Syntax
```
{
"Documents": [
{
"Body": "string",
"GroupId": "string",
"Id": "string",
"OriginalScore": number,
"Title": "string",
"TokenizedBody": [ "string" ],
"TokenizedTitle": [ "string" ]
}
],
"RescoreExecutionPlanId": "string",
"SearchQuery": "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.
** [Documents](#API_Ranking_Rescore_RequestSyntax) **
The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.
Type: Array of [Document](API_Ranking_Document.md) objects
Array Members: Minimum number of 1 item.
Required: Yes
** [RescoreExecutionPlanId](#API_Ranking_Rescore_RequestSyntax) **
The identifier of the rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the `Rescore` API.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [SearchQuery](#API_Ranking_Rescore_RequestSyntax) **
The input query from the search service.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: Yes
## Response Syntax
```
{
"RescoreId": "string",
"ResultItems": [
{
"DocumentId": "string",
"Score": number
}
]
}
```
## 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.
** [RescoreId](#API_Ranking_Rescore_ResponseSyntax) **
The identifier associated with the scores that Amazon Kendra Intelligent Ranking gives to the results. Amazon Kendra Intelligent Ranking rescores or re-ranks the results for the search service.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]`
** [ResultItems](#API_Ranking_Rescore_ResponseSyntax) **
A list of result items for documents with new relevancy scores. The results are in descending order.
Type: Array of [RescoreResultItem](API_Ranking_RescoreResultItem.md) objects
Array Members: Minimum number of 1 item.
## 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 inconsistencies with your resources and try again.
HTTP Status Code: 400
** InternalServerException **
An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking 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
** 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 Intelligent Ranking 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-ranking-2022-10-19/Rescore)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-ranking-2022-10-19/Rescore)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-ranking-2022-10-19/Rescore)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-ranking-2022-10-19/Rescore)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-ranking-2022-10-19/Rescore)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-ranking-2022-10-19/Rescore)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-ranking-2022-10-19/Rescore)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-ranking-2022-10-19/Rescore)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-ranking-2022-10-19/Rescore)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-ranking-2022-10-19/Rescore)
# TagResource
Adds a specified tag to a specified rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the `Rescore` API. If the tag already exists, the existing value is replaced with the new value.
## Request Syntax
```
{
"ResourceARN": "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.
** [ResourceARN](#API_Ranking_TagResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the rescore execution plan to add a tag. For example, the ARN of a rescore execution plan is constructed as follows: *arn:aws:kendra-ranking:your-region:your-account-id:rescore-execution-plan/rescore-execution-plan-id* For information, see [Resource types](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendraintelligentranking.html#amazonkendraintelligentranking-resources-for-iam-policies).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
** [Tags](#API_Ranking_TagResource_RequestSyntax) **
A list of tag keys to add to a rescore execution plan. If a tag already exists, the existing value is replaced with the new value.
Type: Array of [Tag](API_Ranking_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** InternalServerException **
An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.
HTTP Status Code: 500
** ResourceUnavailableException **
The resource you want to use is unavailable. Please check you have provided the correct resource information and try again.
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 Intelligent Ranking 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-ranking-2022-10-19/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-ranking-2022-10-19/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-ranking-2022-10-19/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-ranking-2022-10-19/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-ranking-2022-10-19/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-ranking-2022-10-19/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-ranking-2022-10-19/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-ranking-2022-10-19/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-ranking-2022-10-19/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-ranking-2022-10-19/TagResource)
# UntagResource
Removes a tag from a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the `Rescore` operation.
## Request Syntax
```
{
"ResourceARN": "string",
"TagKeys": [ "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.
** [ResourceARN](#API_Ranking_UntagResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the rescore execution plan to remove the tag. For example, the ARN of a rescore execution plan is constructed as follows: *arn:aws:kendra-ranking:your-region:your-account-id:rescore-execution-plan/rescore-execution-plan-id* For information, see [Resource types](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendraintelligentranking.html#amazonkendraintelligentranking-resources-for-iam-policies).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
** [TagKeys](#API_Ranking_UntagResource_RequestSyntax) **
A list of tag keys to remove from the rescore execution plan. If a tag key does not exist on the resource, it is ignored.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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
** InternalServerException **
An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.
HTTP Status Code: 500
** ResourceUnavailableException **
The resource you want to use is unavailable. Please check you have provided the correct resource information and try again.
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 Intelligent Ranking 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-ranking-2022-10-19/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-ranking-2022-10-19/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-ranking-2022-10-19/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-ranking-2022-10-19/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-ranking-2022-10-19/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-ranking-2022-10-19/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-ranking-2022-10-19/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-ranking-2022-10-19/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-ranking-2022-10-19/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-ranking-2022-10-19/UntagResource)
# UpdateRescoreExecutionPlan
Updates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the `Rescore` API. You can update the number of capacity units you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service's results.
## Request Syntax
```
{
"CapacityUnits": {
"RescoreCapacityUnits": number
},
"Description": "string",
"Id": "string",
"Name": "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.
** [CapacityUnits](#API_Ranking_UpdateRescoreExecutionPlan_RequestSyntax) **
You can set additional capacity units to meet the needs of your rescore execution plan. You are given a single capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For more information on the default capacity and additional capacity units, see [Adjusting capacity](https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html).
Type: [CapacityUnitsConfiguration](API_Ranking_CapacityUnitsConfiguration.md) object
Required: No
** [Description](#API_Ranking_UpdateRescoreExecutionPlan_RequestSyntax) **
A new description for the rescore execution plan.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
Required: No
** [Id](#API_Ranking_UpdateRescoreExecutionPlan_RequestSyntax) **
The identifier of the rescore execution plan that you want to update.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: Yes
** [Name](#API_Ranking_UpdateRescoreExecutionPlan_RequestSyntax) **
A new name for the rescore execution plan.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## 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 inconsistencies with your resources and try again.
HTTP Status Code: 400
** InternalServerException **
An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking 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 Intelligent Ranking 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 Intelligent Ranking 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-ranking-2022-10-19/UpdateRescoreExecutionPlan)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-ranking-2022-10-19/UpdateRescoreExecutionPlan)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-ranking-2022-10-19/UpdateRescoreExecutionPlan)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-ranking-2022-10-19/UpdateRescoreExecutionPlan)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-ranking-2022-10-19/UpdateRescoreExecutionPlan)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-ranking-2022-10-19/UpdateRescoreExecutionPlan)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-ranking-2022-10-19/UpdateRescoreExecutionPlan)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-ranking-2022-10-19/UpdateRescoreExecutionPlan)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-ranking-2022-10-19/UpdateRescoreExecutionPlan)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-ranking-2022-10-19/UpdateRescoreExecutionPlan)
# Data Types
The following data types are supported by Amazon Kendra:
+ [AccessControlConfigurationSummary](API_AccessControlConfigurationSummary.md)
+ [AccessControlListConfiguration](API_AccessControlListConfiguration.md)
+ [AclConfiguration](API_AclConfiguration.md)
+ [AdditionalResultAttribute](API_AdditionalResultAttribute.md)
+ [AdditionalResultAttributeValue](API_AdditionalResultAttributeValue.md)
+ [AlfrescoConfiguration](API_AlfrescoConfiguration.md)
+ [AttributeFilter](API_AttributeFilter.md)
+ [AttributeSuggestionsDescribeConfig](API_AttributeSuggestionsDescribeConfig.md)
+ [AttributeSuggestionsGetConfig](API_AttributeSuggestionsGetConfig.md)
+ [AttributeSuggestionsUpdateConfig](API_AttributeSuggestionsUpdateConfig.md)
+ [AuthenticationConfiguration](API_AuthenticationConfiguration.md)
+ [BasicAuthenticationConfiguration](API_BasicAuthenticationConfiguration.md)
+ [BatchDeleteDocumentResponseFailedDocument](API_BatchDeleteDocumentResponseFailedDocument.md)
+ [BatchDeleteFeaturedResultsSetError](API_BatchDeleteFeaturedResultsSetError.md)
+ [BatchGetDocumentStatusResponseError](API_BatchGetDocumentStatusResponseError.md)
+ [BatchPutDocumentResponseFailedDocument](API_BatchPutDocumentResponseFailedDocument.md)
+ [BoxConfiguration](API_BoxConfiguration.md)
+ [CapacityUnitsConfiguration](API_CapacityUnitsConfiguration.md)
+ [ClickFeedback](API_ClickFeedback.md)
+ [CollapseConfiguration](API_CollapseConfiguration.md)
+ [CollapsedResultDetail](API_CollapsedResultDetail.md)
+ [ColumnConfiguration](API_ColumnConfiguration.md)
+ [ConflictingItem](API_ConflictingItem.md)
+ [ConfluenceAttachmentConfiguration](API_ConfluenceAttachmentConfiguration.md)
+ [ConfluenceAttachmentToIndexFieldMapping](API_ConfluenceAttachmentToIndexFieldMapping.md)
+ [ConfluenceBlogConfiguration](API_ConfluenceBlogConfiguration.md)
+ [ConfluenceBlogToIndexFieldMapping](API_ConfluenceBlogToIndexFieldMapping.md)
+ [ConfluenceConfiguration](API_ConfluenceConfiguration.md)
+ [ConfluencePageConfiguration](API_ConfluencePageConfiguration.md)
+ [ConfluencePageToIndexFieldMapping](API_ConfluencePageToIndexFieldMapping.md)
+ [ConfluenceSpaceConfiguration](API_ConfluenceSpaceConfiguration.md)
+ [ConfluenceSpaceToIndexFieldMapping](API_ConfluenceSpaceToIndexFieldMapping.md)
+ [ConnectionConfiguration](API_ConnectionConfiguration.md)
+ [ContentSourceConfiguration](API_ContentSourceConfiguration.md)
+ [Correction](API_Correction.md)
+ [CustomDocumentEnrichmentConfiguration](API_CustomDocumentEnrichmentConfiguration.md)
+ [DatabaseConfiguration](API_DatabaseConfiguration.md)
+ [DataSourceConfiguration](API_DataSourceConfiguration.md)
+ [DataSourceGroup](API_DataSourceGroup.md)
+ [DataSourceSummary](API_DataSourceSummary.md)
+ [DataSourceSyncJob](API_DataSourceSyncJob.md)
+ [DataSourceSyncJobMetrics](API_DataSourceSyncJobMetrics.md)
+ [DataSourceSyncJobMetricTarget](API_DataSourceSyncJobMetricTarget.md)
+ [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md)
+ [DataSourceVpcConfiguration](API_DataSourceVpcConfiguration.md)
+ [Document](API_Document.md)
+ [DocumentAttribute](API_DocumentAttribute.md)
+ [DocumentAttributeCondition](API_DocumentAttributeCondition.md)
+ [DocumentAttributeTarget](API_DocumentAttributeTarget.md)
+ [DocumentAttributeValue](API_DocumentAttributeValue.md)
+ [DocumentAttributeValueCountPair](API_DocumentAttributeValueCountPair.md)
+ [DocumentInfo](API_DocumentInfo.md)
+ [DocumentMetadataConfiguration](API_DocumentMetadataConfiguration.md)
+ [DocumentRelevanceConfiguration](API_DocumentRelevanceConfiguration.md)
+ [DocumentsMetadataConfiguration](API_DocumentsMetadataConfiguration.md)
+ [EntityConfiguration](API_EntityConfiguration.md)
+ [EntityDisplayData](API_EntityDisplayData.md)
+ [EntityPersonaConfiguration](API_EntityPersonaConfiguration.md)
+ [ExpandConfiguration](API_ExpandConfiguration.md)
+ [ExpandedResultItem](API_ExpandedResultItem.md)
+ [ExperienceConfiguration](API_ExperienceConfiguration.md)
+ [ExperienceEndpoint](API_ExperienceEndpoint.md)
+ [ExperienceEntitiesSummary](API_ExperienceEntitiesSummary.md)
+ [ExperiencesSummary](API_ExperiencesSummary.md)
+ [Facet](API_Facet.md)
+ [FacetResult](API_FacetResult.md)
+ [FailedEntity](API_FailedEntity.md)
+ [FaqStatistics](API_FaqStatistics.md)
+ [FaqSummary](API_FaqSummary.md)
+ [FeaturedDocument](API_FeaturedDocument.md)
+ [FeaturedDocumentMissing](API_FeaturedDocumentMissing.md)
+ [FeaturedDocumentWithMetadata](API_FeaturedDocumentWithMetadata.md)
+ [FeaturedResultsItem](API_FeaturedResultsItem.md)
+ [FeaturedResultsSet](API_FeaturedResultsSet.md)
+ [FeaturedResultsSetSummary](API_FeaturedResultsSetSummary.md)
+ [FsxConfiguration](API_FsxConfiguration.md)
+ [GitHubConfiguration](API_GitHubConfiguration.md)
+ [GitHubDocumentCrawlProperties](API_GitHubDocumentCrawlProperties.md)
+ [GoogleDriveConfiguration](API_GoogleDriveConfiguration.md)
+ [GroupMembers](API_GroupMembers.md)
+ [GroupOrderingIdSummary](API_GroupOrderingIdSummary.md)
+ [GroupSummary](API_GroupSummary.md)
+ [HierarchicalPrincipal](API_HierarchicalPrincipal.md)
+ [Highlight](API_Highlight.md)
+ [HookConfiguration](API_HookConfiguration.md)
+ [IndexConfigurationSummary](API_IndexConfigurationSummary.md)
+ [IndexStatistics](API_IndexStatistics.md)
+ [InlineCustomDocumentEnrichmentConfiguration](API_InlineCustomDocumentEnrichmentConfiguration.md)
+ [JiraConfiguration](API_JiraConfiguration.md)
+ [JsonTokenTypeConfiguration](API_JsonTokenTypeConfiguration.md)
+ [JwtTokenTypeConfiguration](API_JwtTokenTypeConfiguration.md)
+ [MemberGroup](API_MemberGroup.md)
+ [MemberUser](API_MemberUser.md)
+ [OneDriveConfiguration](API_OneDriveConfiguration.md)
+ [OneDriveUsers](API_OneDriveUsers.md)
+ [OnPremiseConfiguration](API_OnPremiseConfiguration.md)
+ [PersonasSummary](API_PersonasSummary.md)
+ [Principal](API_Principal.md)
+ [ProxyConfiguration](API_ProxyConfiguration.md)
+ [QueryResultItem](API_QueryResultItem.md)
+ [QuerySuggestionsBlockListSummary](API_QuerySuggestionsBlockListSummary.md)
+ [QuipConfiguration](API_QuipConfiguration.md)
+ [Relevance](API_Relevance.md)
+ [RelevanceFeedback](API_RelevanceFeedback.md)
+ [RetrieveResultItem](API_RetrieveResultItem.md)
+ [S3DataSourceConfiguration](API_S3DataSourceConfiguration.md)
+ [S3Path](API_S3Path.md)
+ [SaaSConfiguration](API_SaaSConfiguration.md)
+ [SalesforceChatterFeedConfiguration](API_SalesforceChatterFeedConfiguration.md)
+ [SalesforceConfiguration](API_SalesforceConfiguration.md)
+ [SalesforceCustomKnowledgeArticleTypeConfiguration](API_SalesforceCustomKnowledgeArticleTypeConfiguration.md)
+ [SalesforceKnowledgeArticleConfiguration](API_SalesforceKnowledgeArticleConfiguration.md)
+ [SalesforceStandardKnowledgeArticleTypeConfiguration](API_SalesforceStandardKnowledgeArticleTypeConfiguration.md)
+ [SalesforceStandardObjectAttachmentConfiguration](API_SalesforceStandardObjectAttachmentConfiguration.md)
+ [SalesforceStandardObjectConfiguration](API_SalesforceStandardObjectConfiguration.md)
+ [ScoreAttributes](API_ScoreAttributes.md)
+ [Search](API_Search.md)
+ [SeedUrlConfiguration](API_SeedUrlConfiguration.md)
+ [ServerSideEncryptionConfiguration](API_ServerSideEncryptionConfiguration.md)
+ [ServiceNowConfiguration](API_ServiceNowConfiguration.md)
+ [ServiceNowKnowledgeArticleConfiguration](API_ServiceNowKnowledgeArticleConfiguration.md)
+ [ServiceNowServiceCatalogConfiguration](API_ServiceNowServiceCatalogConfiguration.md)
+ [SharePointConfiguration](API_SharePointConfiguration.md)
+ [SiteMapsConfiguration](API_SiteMapsConfiguration.md)
+ [SlackConfiguration](API_SlackConfiguration.md)
+ [SortingConfiguration](API_SortingConfiguration.md)
+ [SourceDocument](API_SourceDocument.md)
+ [SpellCorrectedQuery](API_SpellCorrectedQuery.md)
+ [SpellCorrectionConfiguration](API_SpellCorrectionConfiguration.md)
+ [SqlConfiguration](API_SqlConfiguration.md)
+ [Status](API_Status.md)
+ [SuggestableConfig](API_SuggestableConfig.md)
+ [Suggestion](API_Suggestion.md)
+ [SuggestionHighlight](API_SuggestionHighlight.md)
+ [SuggestionTextWithHighlights](API_SuggestionTextWithHighlights.md)
+ [SuggestionValue](API_SuggestionValue.md)
+ [TableCell](API_TableCell.md)
+ [TableExcerpt](API_TableExcerpt.md)
+ [TableRow](API_TableRow.md)
+ [Tag](API_Tag.md)
+ [TemplateConfiguration](API_TemplateConfiguration.md)
+ [TextDocumentStatistics](API_TextDocumentStatistics.md)
+ [TextWithHighlights](API_TextWithHighlights.md)
+ [ThesaurusSummary](API_ThesaurusSummary.md)
+ [TimeRange](API_TimeRange.md)
+ [Urls](API_Urls.md)
+ [UserContext](API_UserContext.md)
+ [UserGroupResolutionConfiguration](API_UserGroupResolutionConfiguration.md)
+ [UserIdentityConfiguration](API_UserIdentityConfiguration.md)
+ [UserTokenConfiguration](API_UserTokenConfiguration.md)
+ [Warning](API_Warning.md)
+ [WebCrawlerConfiguration](API_WebCrawlerConfiguration.md)
+ [WorkDocsConfiguration](API_WorkDocsConfiguration.md)
The following data types are supported by Amazon Kendra Intelligent Ranking:
+ [CapacityUnitsConfiguration](API_Ranking_CapacityUnitsConfiguration.md)
+ [Document](API_Ranking_Document.md)
+ [RescoreExecutionPlanSummary](API_Ranking_RescoreExecutionPlanSummary.md)
+ [RescoreResultItem](API_Ranking_RescoreResultItem.md)
+ [Tag](API_Ranking_Tag.md)
# Amazon Kendra
The following data types are supported by Amazon Kendra:
+ [AccessControlConfigurationSummary](API_AccessControlConfigurationSummary.md)
+ [AccessControlListConfiguration](API_AccessControlListConfiguration.md)
+ [AclConfiguration](API_AclConfiguration.md)
+ [AdditionalResultAttribute](API_AdditionalResultAttribute.md)
+ [AdditionalResultAttributeValue](API_AdditionalResultAttributeValue.md)
+ [AlfrescoConfiguration](API_AlfrescoConfiguration.md)
+ [AttributeFilter](API_AttributeFilter.md)
+ [AttributeSuggestionsDescribeConfig](API_AttributeSuggestionsDescribeConfig.md)
+ [AttributeSuggestionsGetConfig](API_AttributeSuggestionsGetConfig.md)
+ [AttributeSuggestionsUpdateConfig](API_AttributeSuggestionsUpdateConfig.md)
+ [AuthenticationConfiguration](API_AuthenticationConfiguration.md)
+ [BasicAuthenticationConfiguration](API_BasicAuthenticationConfiguration.md)
+ [BatchDeleteDocumentResponseFailedDocument](API_BatchDeleteDocumentResponseFailedDocument.md)
+ [BatchDeleteFeaturedResultsSetError](API_BatchDeleteFeaturedResultsSetError.md)
+ [BatchGetDocumentStatusResponseError](API_BatchGetDocumentStatusResponseError.md)
+ [BatchPutDocumentResponseFailedDocument](API_BatchPutDocumentResponseFailedDocument.md)
+ [BoxConfiguration](API_BoxConfiguration.md)
+ [CapacityUnitsConfiguration](API_CapacityUnitsConfiguration.md)
+ [ClickFeedback](API_ClickFeedback.md)
+ [CollapseConfiguration](API_CollapseConfiguration.md)
+ [CollapsedResultDetail](API_CollapsedResultDetail.md)
+ [ColumnConfiguration](API_ColumnConfiguration.md)
+ [ConflictingItem](API_ConflictingItem.md)
+ [ConfluenceAttachmentConfiguration](API_ConfluenceAttachmentConfiguration.md)
+ [ConfluenceAttachmentToIndexFieldMapping](API_ConfluenceAttachmentToIndexFieldMapping.md)
+ [ConfluenceBlogConfiguration](API_ConfluenceBlogConfiguration.md)
+ [ConfluenceBlogToIndexFieldMapping](API_ConfluenceBlogToIndexFieldMapping.md)
+ [ConfluenceConfiguration](API_ConfluenceConfiguration.md)
+ [ConfluencePageConfiguration](API_ConfluencePageConfiguration.md)
+ [ConfluencePageToIndexFieldMapping](API_ConfluencePageToIndexFieldMapping.md)
+ [ConfluenceSpaceConfiguration](API_ConfluenceSpaceConfiguration.md)
+ [ConfluenceSpaceToIndexFieldMapping](API_ConfluenceSpaceToIndexFieldMapping.md)
+ [ConnectionConfiguration](API_ConnectionConfiguration.md)
+ [ContentSourceConfiguration](API_ContentSourceConfiguration.md)
+ [Correction](API_Correction.md)
+ [CustomDocumentEnrichmentConfiguration](API_CustomDocumentEnrichmentConfiguration.md)
+ [DatabaseConfiguration](API_DatabaseConfiguration.md)
+ [DataSourceConfiguration](API_DataSourceConfiguration.md)
+ [DataSourceGroup](API_DataSourceGroup.md)
+ [DataSourceSummary](API_DataSourceSummary.md)
+ [DataSourceSyncJob](API_DataSourceSyncJob.md)
+ [DataSourceSyncJobMetrics](API_DataSourceSyncJobMetrics.md)
+ [DataSourceSyncJobMetricTarget](API_DataSourceSyncJobMetricTarget.md)
+ [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md)
+ [DataSourceVpcConfiguration](API_DataSourceVpcConfiguration.md)
+ [Document](API_Document.md)
+ [DocumentAttribute](API_DocumentAttribute.md)
+ [DocumentAttributeCondition](API_DocumentAttributeCondition.md)
+ [DocumentAttributeTarget](API_DocumentAttributeTarget.md)
+ [DocumentAttributeValue](API_DocumentAttributeValue.md)
+ [DocumentAttributeValueCountPair](API_DocumentAttributeValueCountPair.md)
+ [DocumentInfo](API_DocumentInfo.md)
+ [DocumentMetadataConfiguration](API_DocumentMetadataConfiguration.md)
+ [DocumentRelevanceConfiguration](API_DocumentRelevanceConfiguration.md)
+ [DocumentsMetadataConfiguration](API_DocumentsMetadataConfiguration.md)
+ [EntityConfiguration](API_EntityConfiguration.md)
+ [EntityDisplayData](API_EntityDisplayData.md)
+ [EntityPersonaConfiguration](API_EntityPersonaConfiguration.md)
+ [ExpandConfiguration](API_ExpandConfiguration.md)
+ [ExpandedResultItem](API_ExpandedResultItem.md)
+ [ExperienceConfiguration](API_ExperienceConfiguration.md)
+ [ExperienceEndpoint](API_ExperienceEndpoint.md)
+ [ExperienceEntitiesSummary](API_ExperienceEntitiesSummary.md)
+ [ExperiencesSummary](API_ExperiencesSummary.md)
+ [Facet](API_Facet.md)
+ [FacetResult](API_FacetResult.md)
+ [FailedEntity](API_FailedEntity.md)
+ [FaqStatistics](API_FaqStatistics.md)
+ [FaqSummary](API_FaqSummary.md)
+ [FeaturedDocument](API_FeaturedDocument.md)
+ [FeaturedDocumentMissing](API_FeaturedDocumentMissing.md)
+ [FeaturedDocumentWithMetadata](API_FeaturedDocumentWithMetadata.md)
+ [FeaturedResultsItem](API_FeaturedResultsItem.md)
+ [FeaturedResultsSet](API_FeaturedResultsSet.md)
+ [FeaturedResultsSetSummary](API_FeaturedResultsSetSummary.md)
+ [FsxConfiguration](API_FsxConfiguration.md)
+ [GitHubConfiguration](API_GitHubConfiguration.md)
+ [GitHubDocumentCrawlProperties](API_GitHubDocumentCrawlProperties.md)
+ [GoogleDriveConfiguration](API_GoogleDriveConfiguration.md)
+ [GroupMembers](API_GroupMembers.md)
+ [GroupOrderingIdSummary](API_GroupOrderingIdSummary.md)
+ [GroupSummary](API_GroupSummary.md)
+ [HierarchicalPrincipal](API_HierarchicalPrincipal.md)
+ [Highlight](API_Highlight.md)
+ [HookConfiguration](API_HookConfiguration.md)
+ [IndexConfigurationSummary](API_IndexConfigurationSummary.md)
+ [IndexStatistics](API_IndexStatistics.md)
+ [InlineCustomDocumentEnrichmentConfiguration](API_InlineCustomDocumentEnrichmentConfiguration.md)
+ [JiraConfiguration](API_JiraConfiguration.md)
+ [JsonTokenTypeConfiguration](API_JsonTokenTypeConfiguration.md)
+ [JwtTokenTypeConfiguration](API_JwtTokenTypeConfiguration.md)
+ [MemberGroup](API_MemberGroup.md)
+ [MemberUser](API_MemberUser.md)
+ [OneDriveConfiguration](API_OneDriveConfiguration.md)
+ [OneDriveUsers](API_OneDriveUsers.md)
+ [OnPremiseConfiguration](API_OnPremiseConfiguration.md)
+ [PersonasSummary](API_PersonasSummary.md)
+ [Principal](API_Principal.md)
+ [ProxyConfiguration](API_ProxyConfiguration.md)
+ [QueryResultItem](API_QueryResultItem.md)
+ [QuerySuggestionsBlockListSummary](API_QuerySuggestionsBlockListSummary.md)
+ [QuipConfiguration](API_QuipConfiguration.md)
+ [Relevance](API_Relevance.md)
+ [RelevanceFeedback](API_RelevanceFeedback.md)
+ [RetrieveResultItem](API_RetrieveResultItem.md)
+ [S3DataSourceConfiguration](API_S3DataSourceConfiguration.md)
+ [S3Path](API_S3Path.md)
+ [SaaSConfiguration](API_SaaSConfiguration.md)
+ [SalesforceChatterFeedConfiguration](API_SalesforceChatterFeedConfiguration.md)
+ [SalesforceConfiguration](API_SalesforceConfiguration.md)
+ [SalesforceCustomKnowledgeArticleTypeConfiguration](API_SalesforceCustomKnowledgeArticleTypeConfiguration.md)
+ [SalesforceKnowledgeArticleConfiguration](API_SalesforceKnowledgeArticleConfiguration.md)
+ [SalesforceStandardKnowledgeArticleTypeConfiguration](API_SalesforceStandardKnowledgeArticleTypeConfiguration.md)
+ [SalesforceStandardObjectAttachmentConfiguration](API_SalesforceStandardObjectAttachmentConfiguration.md)
+ [SalesforceStandardObjectConfiguration](API_SalesforceStandardObjectConfiguration.md)
+ [ScoreAttributes](API_ScoreAttributes.md)
+ [Search](API_Search.md)
+ [SeedUrlConfiguration](API_SeedUrlConfiguration.md)
+ [ServerSideEncryptionConfiguration](API_ServerSideEncryptionConfiguration.md)
+ [ServiceNowConfiguration](API_ServiceNowConfiguration.md)
+ [ServiceNowKnowledgeArticleConfiguration](API_ServiceNowKnowledgeArticleConfiguration.md)
+ [ServiceNowServiceCatalogConfiguration](API_ServiceNowServiceCatalogConfiguration.md)
+ [SharePointConfiguration](API_SharePointConfiguration.md)
+ [SiteMapsConfiguration](API_SiteMapsConfiguration.md)
+ [SlackConfiguration](API_SlackConfiguration.md)
+ [SortingConfiguration](API_SortingConfiguration.md)
+ [SourceDocument](API_SourceDocument.md)
+ [SpellCorrectedQuery](API_SpellCorrectedQuery.md)
+ [SpellCorrectionConfiguration](API_SpellCorrectionConfiguration.md)
+ [SqlConfiguration](API_SqlConfiguration.md)
+ [Status](API_Status.md)
+ [SuggestableConfig](API_SuggestableConfig.md)
+ [Suggestion](API_Suggestion.md)
+ [SuggestionHighlight](API_SuggestionHighlight.md)
+ [SuggestionTextWithHighlights](API_SuggestionTextWithHighlights.md)
+ [SuggestionValue](API_SuggestionValue.md)
+ [TableCell](API_TableCell.md)
+ [TableExcerpt](API_TableExcerpt.md)
+ [TableRow](API_TableRow.md)
+ [Tag](API_Tag.md)
+ [TemplateConfiguration](API_TemplateConfiguration.md)
+ [TextDocumentStatistics](API_TextDocumentStatistics.md)
+ [TextWithHighlights](API_TextWithHighlights.md)
+ [ThesaurusSummary](API_ThesaurusSummary.md)
+ [TimeRange](API_TimeRange.md)
+ [Urls](API_Urls.md)
+ [UserContext](API_UserContext.md)
+ [UserGroupResolutionConfiguration](API_UserGroupResolutionConfiguration.md)
+ [UserIdentityConfiguration](API_UserIdentityConfiguration.md)
+ [UserTokenConfiguration](API_UserTokenConfiguration.md)
+ [Warning](API_Warning.md)
+ [WebCrawlerConfiguration](API_WebCrawlerConfiguration.md)
+ [WorkDocsConfiguration](API_WorkDocsConfiguration.md)
# AccessControlConfigurationSummary
Summary information on an access control configuration that you created for your documents in an index.
## Contents
** Id **
The identifier of the access control configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9-]+`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/AccessControlConfigurationSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/AccessControlConfigurationSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/AccessControlConfigurationSummary)
# AccessControlListConfiguration
Access Control List files for the documents in a data source. For the format of the file, see [Access control for S3 data sources](https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html).
## Contents
** KeyPath **
Path to the Amazon S3 bucket that contains the ACL files.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/AccessControlListConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/AccessControlListConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/AccessControlListConfiguration)
# AclConfiguration
Provides information about the column that should be used for filtering the query response by groups.
## Contents
** AllowedGroupsColumnName **
A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the `UserContext` field of the `Query` API.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/AclConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/AclConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/AclConfiguration)
# AdditionalResultAttribute
An attribute returned from an index query.
## Contents
** Key **
The key that identifies the attribute.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
** Value **
An object that contains the attribute value.
Type: [AdditionalResultAttributeValue](API_AdditionalResultAttributeValue.md) object
Required: Yes
** ValueType **
The data type of the `Value` property.
Type: String
Valid Values: `TEXT_WITH_HIGHLIGHTS_VALUE`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/AdditionalResultAttribute)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/AdditionalResultAttribute)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/AdditionalResultAttribute)
# AdditionalResultAttributeValue
An attribute returned with a document from a search.
## Contents
** TextWithHighlightsValue **
The text associated with the attribute and information about the highlight to apply to the text.
Type: [TextWithHighlights](API_TextWithHighlights.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/AdditionalResultAttributeValue)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/AdditionalResultAttributeValue)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/AdditionalResultAttributeValue)
# AlfrescoConfiguration
Provides the configuration information to connect to Alfresco as your data source.
**Note**
Support for `AlfrescoConfiguration` ended May 2023. We recommend migrating to or using the Alfresco data source template schema / [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API.
## Contents
** SecretArn **
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key-value pairs required to connect to your Alfresco data source. The secret must contain a JSON structure with the following keys:
+ username—The user name of the Alfresco account.
+ password—The password of the Alfresco account.
Type: String
Length Constraints: Minimum length of 1. 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
** SiteId **
The identifier of the Alfresco site. For example, *my-site*.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `^[A-Za-z0-9-]+$`
Required: Yes
** SiteUrl **
The URL of the Alfresco site. For example, *https://hostname:8080*.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^https:\/\/[a-zA-Z0-9_\-\.]+$`
Required: Yes
** SslCertificateS3Path **
The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to Alfresco if you require a secure SSL connection.
You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see [Create and sign an X509 certificate](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html).
Type: [S3Path](API_S3Path.md) object
Required: Yes
** BlogFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Alfresco blogs to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Alfresco fields. For more information, see [ Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Alfresco data source field names must exist in your Alfresco custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** CrawlComments **
`TRUE` to index comments of blogs and other content.
Type: Boolean
Required: No
** CrawlSystemFolders **
`TRUE` to index shared files.
Type: Boolean
Required: No
** DocumentLibraryFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Alfresco document libraries to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Alfresco fields. For more information, see [ Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Alfresco data source field names must exist in your Alfresco custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** EntityFilter **
Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 3 items.
Valid Values: `wiki | blog | documentLibrary`
Required: No
** ExclusionPatterns **
A list of regular expression patterns to exclude certain files in your Alfresco data source. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** InclusionPatterns **
A list of regular expression patterns to include certain files in your Alfresco data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** VpcConfiguration **
Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see [Configuring a VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
Type: [DataSourceVpcConfiguration](API_DataSourceVpcConfiguration.md) object
Required: No
** WikiFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Alfresco wikis to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Alfresco fields. For more information, see [ Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Alfresco data source field names must exist in your Alfresco custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/AlfrescoConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/AlfrescoConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/AlfrescoConfiguration)
# AttributeFilter
Filters the search results based on document attributes or fields.
You can filter results using attributes for your particular documents. The attributes must exist in your index. For example, if your documents include the custom attribute "Department", you can filter documents that belong to the "HR" department. You would use the `EqualsTo` operation to filter results or documents with "Department" equals to "HR".
You can use `AndAllFilters` and `OrAllFilters` in combination with each other or with other operations such as `EqualsTo`. For example:
`AndAllFilters`
+ `EqualsTo`: "Department", "HR"
+ `OrAllFilters`
+ `ContainsAny`: "Project Name", ["new hires", "new hiring"]
This example filters results or documents that belong to the HR department `AND` belong to projects that contain "new hires" `OR` "new hiring" in the project name (must use `ContainAny` with `StringListValue`). This example is filtering with a depth of 2.
You cannot filter more than a depth of 2, otherwise you receive a `ValidationException` exception with the message "AttributeFilter cannot have a depth of more than 2." Also, if you use more than 10 attribute filters in a given list for `AndAllFilters` or `OrAllFilters`, you receive a `ValidationException` with the message "AttributeFilter cannot have a length of more than 10".
For examples of using `AttributeFilter`, see [Using document attributes to filter search results](https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering).
## Contents
** AndAllFilters **
Performs a logical `AND` operation on all filters that you specify.
Type: Array of [AttributeFilter](#API_AttributeFilter) objects
Required: No
** ContainsAll **
Returns true when a document contains all of the specified document attributes/fields. This filter is only applicable to [StringListValue](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html).
Type: [DocumentAttribute](API_DocumentAttribute.md) object
Required: No
** ContainsAny **
Returns true when a document contains any of the specified document attributes/fields. This filter is only applicable to [StringListValue](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html).
Type: [DocumentAttribute](API_DocumentAttribute.md) object
Required: No
** EqualsTo **
Performs an equals operation on document attributes/fields and their values.
Type: [DocumentAttribute](API_DocumentAttribute.md) object
Required: No
** GreaterThan **
Performs a greater than operation on document attributes/fields and their values. Use with the [document attribute type](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html) `Date` or `Long`.
Type: [DocumentAttribute](API_DocumentAttribute.md) object
Required: No
** GreaterThanOrEquals **
Performs a greater or equals than operation on document attributes/fields and their values. Use with the [document attribute type](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html) `Date` or `Long`.
Type: [DocumentAttribute](API_DocumentAttribute.md) object
Required: No
** LessThan **
Performs a less than operation on document attributes/fields and their values. Use with the [document attribute type](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html) `Date` or `Long`.
Type: [DocumentAttribute](API_DocumentAttribute.md) object
Required: No
** LessThanOrEquals **
Performs a less than or equals operation on document attributes/fields and their values. Use with the [document attribute type](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html) `Date` or `Long`.
Type: [DocumentAttribute](API_DocumentAttribute.md) object
Required: No
** NotFilter **
Performs a logical `NOT` operation on all filters that you specify.
Type: [AttributeFilter](#API_AttributeFilter) object
Required: No
** OrAllFilters **
Performs a logical `OR` operation on all filters that you specify.
Type: Array of [AttributeFilter](#API_AttributeFilter) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/AttributeFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/AttributeFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/AttributeFilter)
# AttributeSuggestionsDescribeConfig
Gets information on the configuration of document fields/attributes that you want to base query suggestions on. To change your configuration, use [AttributeSuggestionsUpdateConfig](https://docs.aws.amazon.com/kendra/latest/dg/API_AttributeSuggestionsUpdateConfig.html) and then call [UpdateQuerySuggestionsConfig](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html).
## Contents
** AttributeSuggestionsMode **
The mode is set to either `ACTIVE` or `INACTIVE`. If the `Mode` for query history is set to `ENABLED` when calling [UpdateQuerySuggestionsConfig](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html) and `AttributeSuggestionsMode` to use fields/attributes is set to `ACTIVE`, and you haven't set your `SuggestionTypes` preference to `DOCUMENT_ATTRIBUTES`, then Amazon Kendra uses the query history.
Type: String
Valid Values: `ACTIVE | INACTIVE`
Required: No
** SuggestableConfigList **
The list of fields/attributes that you want to set as suggestible for query suggestions.
Type: Array of [SuggestableConfig](API_SuggestableConfig.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/AttributeSuggestionsDescribeConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/AttributeSuggestionsDescribeConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/AttributeSuggestionsDescribeConfig)
# AttributeSuggestionsGetConfig
Provides the configuration information for the document fields/attributes that you want to base query suggestions on.
## Contents
** AdditionalResponseAttributes **
The list of additional document field/attribute keys or field names to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `[a-zA-Z0-9_][a-zA-Z0-9_-]*`
Required: No
** AttributeFilter **
Filters the search results based on document fields/attributes.
Type: [AttributeFilter](API_AttributeFilter.md) object
Required: No
** SuggestionAttributes **
The list of document field/attribute keys or field names to use for query suggestions. If the content within any of the fields match what your user starts typing as their query, then the field content is returned as a query suggestion.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `[a-zA-Z0-9_][a-zA-Z0-9_-]*`
Required: No
** UserContext **
Applies user context filtering so that only users who are given access to certain documents see these document in their search results.
Type: [UserContext](API_UserContext.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/AttributeSuggestionsGetConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/AttributeSuggestionsGetConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/AttributeSuggestionsGetConfig)
# AttributeSuggestionsUpdateConfig
Updates the configuration information for the document fields/attributes that you want to base query suggestions on.
To deactivate using documents fields for query suggestions, set the mode to `INACTIVE`. You must also set `SuggestionTypes` as either `QUERY` or `DOCUMENT_ATTRIBUTES` and then call [GetQuerySuggestions](https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html). If you set to `QUERY`, then Amazon Kendra uses the query history to base suggestions on. If you set to `DOCUMENT_ATTRIBUTES`, then Amazon Kendra uses the contents of document fields to base suggestions on.
## Contents
** AttributeSuggestionsMode **
You can set the mode to `ACTIVE` or `INACTIVE`. You must also set `SuggestionTypes` as either `QUERY` or `DOCUMENT_ATTRIBUTES` and then call [GetQuerySuggestions](https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html). If `Mode` to use query history is set to `ENABLED` when calling [UpdateQuerySuggestionsConfig](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html) and `AttributeSuggestionsMode` to use fields/attributes is set to `ACTIVE`, and you haven't set your `SuggestionTypes` preference to `DOCUMENT_ATTRIBUTES`, then Amazon Kendra uses the query history.
Type: String
Valid Values: `ACTIVE | INACTIVE`
Required: No
** SuggestableConfigList **
The list of fields/attributes that you want to set as suggestible for query suggestions.
Type: Array of [SuggestableConfig](API_SuggestableConfig.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/AttributeSuggestionsUpdateConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/AttributeSuggestionsUpdateConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/AttributeSuggestionsUpdateConfig)
# AuthenticationConfiguration
Provides the configuration information to connect to websites that require user authentication.
## Contents
** BasicAuthentication **
The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials.
The list includes the name and port number of the website host.
Type: Array of [BasicAuthenticationConfiguration](API_BasicAuthenticationConfiguration.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/AuthenticationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/AuthenticationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/AuthenticationConfiguration)
# BasicAuthenticationConfiguration
Provides the configuration information to connect to websites that require basic user authentication.
## Contents
** Credentials **
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret. You create a secret to store your credentials in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)
You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.
Type: String
Length Constraints: Minimum length of 1. 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
** Host **
The name of the website host you want to connect to using authentication credentials.
For example, the host name of https://a.example.com/page1.html is "a.example.com".
Type: String
Length Constraints: Minimum length of 1. Maximum length of 253.
Pattern: `([^\s]*)`
Required: Yes
** Port **
The port number of the website host you want to connect to using authentication credentials.
For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65535.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/BasicAuthenticationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/BasicAuthenticationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/BasicAuthenticationConfiguration)
# BatchDeleteDocumentResponseFailedDocument
Provides information about documents that could not be removed from an index by the `BatchDeleteDocument` API.
## Contents
** DataSourceId **
The identifier of the data source connector that the document belongs to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** ErrorCode **
The error code for why the document couldn't be removed from the index.
Type: String
Valid Values: `InternalError | InvalidRequest`
Required: No
** ErrorMessage **
An explanation for why the document couldn't be removed from the index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
Required: No
** Id **
The identifier of the document that couldn't be removed from the index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/BatchDeleteDocumentResponseFailedDocument)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/BatchDeleteDocumentResponseFailedDocument)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/BatchDeleteDocumentResponseFailedDocument)
# BatchDeleteFeaturedResultsSetError
Provides information about a set of featured results that couldn't be removed from an index by the [BatchDeleteFeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteFeaturedResultsSet.html) API.
## Contents
** ErrorCode **
The error code for why the set of featured results couldn't be removed from the index.
Type: String
Valid Values: `InternalError | InvalidRequest`
Required: Yes
** ErrorMessage **
An explanation for why the set of featured results couldn't be removed from the index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
Required: Yes
** Id **
The identifier of the set of featured results that couldn't be removed from the index.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `^[a-zA-Z-0-9]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/BatchDeleteFeaturedResultsSetError)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/BatchDeleteFeaturedResultsSetError)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/BatchDeleteFeaturedResultsSetError)
# BatchGetDocumentStatusResponseError
Provides a response when the status of a document could not be retrieved.
## Contents
** DataSourceId **
The identifier of the data source connector that the failed document belongs to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** DocumentId **
The identifier of the document whose status could not be retrieved.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** ErrorCode **
Indicates the source of the error.
Type: String
Valid Values: `InternalError | InvalidRequest`
Required: No
** ErrorMessage **
States that the API could not get the status of a document. This could be because the request is not valid or there is a system error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/BatchGetDocumentStatusResponseError)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/BatchGetDocumentStatusResponseError)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/BatchGetDocumentStatusResponseError)
# BatchPutDocumentResponseFailedDocument
Provides information about a document that could not be indexed.
## Contents
** DataSourceId **
The identifier of the data source connector that the failed document belongs to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** ErrorCode **
The type of error that caused the document to fail to be indexed.
Type: String
Valid Values: `InternalError | InvalidRequest`
Required: No
** ErrorMessage **
A description of the reason why the document could not be indexed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
Required: No
** Id **
The identifier of the document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/BatchPutDocumentResponseFailedDocument)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/BatchPutDocumentResponseFailedDocument)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/BatchPutDocumentResponseFailedDocument)
# BoxConfiguration
Provides the configuration information to connect to Box as your data source.
## Contents
** EnterpriseId **
The identifier of the Box Enterprise platform. You can find the enterprise ID in the Box Developer Console settings or when you create an app in Box and download your authentication credentials. For example, *801234567*.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `^[A-Z0-9]*$`
Required: Yes
** SecretArn **
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key-value pairs required to connect to your Box platform. The secret must contain a JSON structure with the following keys:
+ clientID—The identifier of the client OAuth 2.0 authentication application created in Box.
+ clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box.
+ publicKeyId—The identifier of the public key contained within an identity certificate.
+ privateKey—A set of characters that make up an encryption key.
+ passphrase—A set of characters that act like a password.
You create an application in Box to generate the keys or credentials required for the secret. For more information, see [Using a Box data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-box.html).
Type: String
Length Constraints: Minimum length of 1. 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
** CommentFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Box comments to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Box fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Box field names must exist in your Box custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** CrawlComments **
`TRUE` to index comments.
Type: Boolean
Required: No
** CrawlTasks **
`TRUE` to index the contents of tasks.
Type: Boolean
Required: No
** CrawlWebLinks **
`TRUE` to index web links.
Type: Boolean
Required: No
** ExclusionPatterns **
A list of regular expression patterns to exclude certain files and folders from your Box platform. Files and folders that match the patterns are excluded from the index.Files and folders that don't match the patterns are included in the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** FileFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Box files to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Box fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Box field names must exist in your Box custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** InclusionPatterns **
A list of regular expression patterns to include certain files and folders in your Box platform. Files and folders that match the patterns are included in the index. Files and folders that don't match the patterns are excluded from the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** TaskFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Box tasks to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Box fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Box field names must exist in your Box custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** UseChangeLog **
`TRUE` to use the Slack change log to determine which documents require updating in the index. Depending on the data source change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents.
Type: Boolean
Required: No
** VpcConfiguration **
Configuration information for an Amazon VPC to connect to your Box. For more information, see [Configuring a VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
Type: [DataSourceVpcConfiguration](API_DataSourceVpcConfiguration.md) object
Required: No
** WebLinkFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Box web links to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Box fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Box field names must exist in your Box custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/BoxConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/BoxConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/BoxConfiguration)
# CapacityUnitsConfiguration
Specifies additional capacity units configured for your Enterprise Edition index. You can add and remove capacity units to fit your usage requirements.
## Contents
** QueryCapacityUnits **
The amount of extra query capacity for an index and [GetQuerySuggestions](https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html) capacity.
A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units.
`GetQuerySuggestions` capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and `GetQuerySuggestions` capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the `GetQuerySuggestions` capacity is 2.5 calls per second (higher than five times 0.2 queries per second).
Type: Integer
Valid Range: Minimum value of 0.
Required: Yes
** StorageCapacityUnits **
The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units.
Type: Integer
Valid Range: Minimum value of 0.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/CapacityUnitsConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/CapacityUnitsConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/CapacityUnitsConfiguration)
# ClickFeedback
Gathers information about when a particular result was clicked by a user. Your application uses the `SubmitFeedback` API to provide click information.
## Contents
** ClickTime **
The Unix timestamp when the result was clicked.
Type: Timestamp
Required: Yes
** ResultId **
The identifier of the search result that was clicked.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 73.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ClickFeedback)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ClickFeedback)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ClickFeedback)
# CollapseConfiguration
Specifies how to group results by document attribute value, and how to display them collapsed/expanded under a designated primary document for each group.
## Contents
** DocumentAttributeKey **
The document attribute used to group search results. You can use any attribute that has the `Sortable` flag set to true. You can also sort by any of the following built-in attributes:"\$1category","\$1created\$1at", "\$1last\$1updated\$1at", "\$1version", "\$1view\$1count".
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `[a-zA-Z0-9_][a-zA-Z0-9_-]*`
Required: Yes
** Expand **
Specifies whether to expand the collapsed results.
Type: Boolean
Required: No
** ExpandConfiguration **
Provides configuration information to customize expansion options for a collapsed group.
Type: [ExpandConfiguration](API_ExpandConfiguration.md) object
Required: No
** MissingAttributeKeyStrategy **
Specifies the behavior for documents without a value for the collapse attribute.
Amazon Kendra offers three customization options:
+ Choose to `COLLAPSE` all documents with null or missing values in one group. This is the default configuration.
+ Choose to `IGNORE` documents with null or missing values. Ignored documents will not appear in query results.
+ Choose to `EXPAND` each document with a null or missing value into a group of its own.
Type: String
Valid Values: `IGNORE | COLLAPSE | EXPAND`
Required: No
** SortingConfigurations **
A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.
Type: Array of [SortingConfiguration](API_SortingConfiguration.md) objects
Array Members: Minimum number of 1 item.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/CollapseConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/CollapseConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/CollapseConfiguration)
# CollapsedResultDetail
Provides details about a collapsed group of search results.
## Contents
** DocumentAttribute **
The value of the document attribute that results are collapsed on.
Type: [DocumentAttribute](API_DocumentAttribute.md) object
Required: Yes
** ExpandedResults **
A list of results in the collapsed group.
Type: Array of [ExpandedResultItem](API_ExpandedResultItem.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/CollapsedResultDetail)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/CollapsedResultDetail)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/CollapsedResultDetail)
# ColumnConfiguration
Provides information about how Amazon Kendra should use the columns of a database in an index.
## Contents
** ChangeDetectingColumns **
One to five columns that indicate when a document in the database has changed.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*$`
Required: Yes
** DocumentDataColumnName **
The column that contains the contents of the document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*$`
Required: Yes
** DocumentIdColumnName **
The column that provides the document's identifier.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*$`
Required: Yes
** DocumentTitleColumnName **
The column that contains the title of the document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*$`
Required: No
** FieldMappings **
An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the `UpdateIndex` API.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ColumnConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ColumnConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ColumnConfiguration)
# ConflictingItem
Information about a conflicting query used across different sets of featured results. When you create a featured results set, you must check that the queries are unique per featured results set for each index.
## Contents
** QueryText **
The text of the conflicting query.
Type: String
Required: No
** SetId **
The identifier of the set of featured results that the conflicting query belongs to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** SetName **
The name for the set of featured results that the conflicting query belongs to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ConflictingItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ConflictingItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ConflictingItem)
# ConfluenceAttachmentConfiguration
Configuration of attachment settings for the Confluence data source. Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them.
## Contents
** AttachmentFieldMappings **
Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Confluence data source field names must exist in your Confluence custom metadata.
If you specify the `AttachentFieldMappings` parameter, you must specify at least one field mapping.
Type: Array of [ConfluenceAttachmentToIndexFieldMapping](API_ConfluenceAttachmentToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 11 items.
Required: No
** CrawlAttachments **
`TRUE` to index attachments of pages and blogs in Confluence.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ConfluenceAttachmentConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ConfluenceAttachmentConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ConfluenceAttachmentConfiguration)
# ConfluenceAttachmentToIndexFieldMapping
Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Confuence data source field names must exist in your Confluence custom metadata.
## Contents
** DataSourceFieldName **
The name of the field in the data source.
You must first create the index field using the `UpdateIndex` API.
Type: String
Valid Values: `AUTHOR | CONTENT_TYPE | CREATED_DATE | DISPLAY_URL | FILE_SIZE | ITEM_TYPE | PARENT_ID | SPACE_KEY | SPACE_NAME | URL | VERSION`
Required: No
** DateFieldFormat **
The format for date fields in the data source. If the field specified in `DataSourceFieldName` is a date field you must specify the date format. If the field is not a date field, an exception is thrown.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 40.
Pattern: `^(?!\s).*(?
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 30.
Pattern: `^\P{C}*$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ConfluenceAttachmentToIndexFieldMapping)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ConfluenceAttachmentToIndexFieldMapping)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ConfluenceAttachmentToIndexFieldMapping)
# ConfluenceBlogConfiguration
Configuration of blog settings for the Confluence data source. Blogs are always indexed unless filtered from the index by the `ExclusionPatterns` or `InclusionPatterns` fields in the `ConfluenceConfiguration` object.
## Contents
** BlogFieldMappings **
Maps attributes or field names of Confluence blogs to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Confluence data source field names must exist in your Confluence custom metadata.
If you specify the `BlogFieldMappings` parameter, you must specify at least one field mapping.
Type: Array of [ConfluenceBlogToIndexFieldMapping](API_ConfluenceBlogToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 9 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ConfluenceBlogConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ConfluenceBlogConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ConfluenceBlogConfiguration)
# ConfluenceBlogToIndexFieldMapping
Maps attributes or field names of Confluence blog to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Confluence data source field names must exist in your Confluence custom metadata.
## Contents
** DataSourceFieldName **
The name of the field in the data source.
Type: String
Valid Values: `AUTHOR | DISPLAY_URL | ITEM_TYPE | LABELS | PUBLISH_DATE | SPACE_KEY | SPACE_NAME | URL | VERSION`
Required: No
** DateFieldFormat **
The format for date fields in the data source. If the field specified in `DataSourceFieldName` is a date field you must specify the date format. If the field is not a date field, an exception is thrown.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 40.
Pattern: `^(?!\s).*(?
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 30.
Pattern: `^\P{C}*$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ConfluenceBlogToIndexFieldMapping)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ConfluenceBlogToIndexFieldMapping)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ConfluenceBlogToIndexFieldMapping)
# ConfluenceConfiguration
Provides the configuration information to connect to Confluence as your data source.
## Contents
** SecretArn **
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence Cloud, you use a generated API token as the password.
You can also provide authentication credentials in the form of a personal access token. For more information, see [Using a Confluence data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html).
Type: String
Length Constraints: Minimum length of 1. 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
** ServerUrl **
The URL of your Confluence instance. Use the full URL of the server. For example, *https://server.example.com:port/*. You can also use an IP address, for example, *https://192.168.1.113/*.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^(https?|ftp|file):\/\/([^\s]*)`
Required: Yes
** Version **
The version or the type of Confluence installation to connect to.
Type: String
Valid Values: `CLOUD | SERVER`
Required: Yes
** AttachmentConfiguration **
Configuration information for indexing attachments to Confluence blogs and pages.
Type: [ConfluenceAttachmentConfiguration](API_ConfluenceAttachmentConfiguration.md) object
Required: No
** AuthenticationType **
Whether you want to connect to Confluence using basic authentication of user name and password, or a personal access token. You can use a personal access token for Confluence Server.
Type: String
Valid Values: `HTTP_BASIC | PAT`
Required: No
** BlogConfiguration **
Configuration information for indexing Confluence blogs.
Type: [ConfluenceBlogConfiguration](API_ConfluenceBlogConfiguration.md) object
Required: No
** ExclusionPatterns **
A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** InclusionPatterns **
A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** PageConfiguration **
Configuration information for indexing Confluence pages.
Type: [ConfluencePageConfiguration](API_ConfluencePageConfiguration.md) object
Required: No
** ProxyConfiguration **
Configuration information to connect to your Confluence URL instance via a web proxy. You can use this option for Confluence Server.
You must provide the website host name and port number. For example, the host name of *https://a.example.com/page1.html* is "a.example.com" and the port is 443, the standard port for HTTPS.
Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in AWS Secrets Manager.
It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.
Type: [ProxyConfiguration](API_ProxyConfiguration.md) object
Required: No
** SpaceConfiguration **
Configuration information for indexing Confluence spaces.
Type: [ConfluenceSpaceConfiguration](API_ConfluenceSpaceConfiguration.md) object
Required: No
** VpcConfiguration **
Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see [Configuring a VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
Type: [DataSourceVpcConfiguration](API_DataSourceVpcConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ConfluenceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ConfluenceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ConfluenceConfiguration)
# ConfluencePageConfiguration
Configuration of the page settings for the Confluence data source.
## Contents
** PageFieldMappings **
Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Confluence data source field names must exist in your Confluence custom metadata.
If you specify the `PageFieldMappings` parameter, you must specify at least one field mapping.
Type: Array of [ConfluencePageToIndexFieldMapping](API_ConfluencePageToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 12 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ConfluencePageConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ConfluencePageConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ConfluencePageConfiguration)
# ConfluencePageToIndexFieldMapping
Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Confluence data source field names must exist in your Confluence custom metadata.
## Contents
** DataSourceFieldName **
The name of the field in the data source.
Type: String
Valid Values: `AUTHOR | CONTENT_STATUS | CREATED_DATE | DISPLAY_URL | ITEM_TYPE | LABELS | MODIFIED_DATE | PARENT_ID | SPACE_KEY | SPACE_NAME | URL | VERSION`
Required: No
** DateFieldFormat **
The format for date fields in the data source. If the field specified in `DataSourceFieldName` is a date field you must specify the date format. If the field is not a date field, an exception is thrown.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 40.
Pattern: `^(?!\s).*(?
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 30.
Pattern: `^\P{C}*$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ConfluencePageToIndexFieldMapping)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ConfluencePageToIndexFieldMapping)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ConfluencePageToIndexFieldMapping)
# ConfluenceSpaceConfiguration
Configuration information for indexing Confluence spaces.
## Contents
** CrawlArchivedSpaces **
`TRUE` to index archived spaces.
Type: Boolean
Required: No
** CrawlPersonalSpaces **
`TRUE` to index personal spaces. You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see [Filtering on user context](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html).
Type: Boolean
Required: No
** ExcludeSpaces **
A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the `ExcludeSpaces` and the `IncludeSpaces` list, the space is excluded.
Type: Array of strings
Array Members: Minimum number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: `^\P{C}*$`
Required: No
** IncludeSpaces **
A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the `IncludeSpaces` and the `ExcludeSpaces` list, the space is excluded.
Type: Array of strings
Array Members: Minimum number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: `^\P{C}*$`
Required: No
** SpaceFieldMappings **
Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Confluence data source field names must exist in your Confluence custom metadata.
If you specify the `SpaceFieldMappings` parameter, you must specify at least one field mapping.
Type: Array of [ConfluenceSpaceToIndexFieldMapping](API_ConfluenceSpaceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 4 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ConfluenceSpaceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ConfluenceSpaceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ConfluenceSpaceConfiguration)
# ConfluenceSpaceToIndexFieldMapping
Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Confluence data source field names must exist in your Confluence custom metadata.
## Contents
** DataSourceFieldName **
The name of the field in the data source.
Type: String
Valid Values: `DISPLAY_URL | ITEM_TYPE | SPACE_KEY | URL`
Required: No
** DateFieldFormat **
The format for date fields in the data source. If the field specified in `DataSourceFieldName` is a date field you must specify the date format. If the field is not a date field, an exception is thrown.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 40.
Pattern: `^(?!\s).*(?
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 30.
Pattern: `^\P{C}*$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ConfluenceSpaceToIndexFieldMapping)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ConfluenceSpaceToIndexFieldMapping)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ConfluenceSpaceToIndexFieldMapping)
# ConnectionConfiguration
Provides the configuration information that's required to connect to a database.
## Contents
** DatabaseHost **
The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 253.
Required: Yes
** DatabaseName **
The name of the database containing the document data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*$`
Required: Yes
** DatabasePort **
The port that the database uses for connections.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65535.
Required: Yes
** SecretArn **
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that stores the credentials. The credentials should be a user-password pair. For more information, see [Using a Database Data Source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html). For more information about AWS Secrets Manager, see [ What Is AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) in the * AWS Secrets Manager * user guide.
Type: String
Length Constraints: Minimum length of 1. 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
** TableName **
The name of the table that contains the document data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ConnectionConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ConnectionConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ConnectionConfiguration)
# ContentSourceConfiguration
Provides the configuration information for your content sources, such as data sources, FAQs, and content indexed directly via [BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html).
## Contents
** DataSourceIds **
The identifier of the data sources you want to use for your Amazon Kendra experience.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** DirectPutContent **
`TRUE` to use documents you indexed directly using the `BatchPutDocument` API.
Type: Boolean
Required: No
** FaqIds **
The identifier of the FAQs that you want to use for your Amazon Kendra experience.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ContentSourceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ContentSourceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ContentSourceConfiguration)
# Correction
A corrected misspelled word in a query.
## Contents
** BeginOffset **
The zero-based location in the response string or text where the corrected word starts.
Type: Integer
Required: No
** CorrectedTerm **
The string or text of a corrected misspelled word in a query.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** EndOffset **
The zero-based location in the response string or text where the corrected word ends.
Type: Integer
Required: No
** Term **
The string or text of a misspelled word in a query.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/Correction)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/Correction)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/Correction)
# CustomDocumentEnrichmentConfiguration
Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see [Customizing document metadata during the ingestion process](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).
## Contents
** InlineConfigurations **
Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
Type: Array of [InlineCustomDocumentEnrichmentConfiguration](API_InlineCustomDocumentEnrichmentConfiguration.md) objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Required: No
** PostExtractionHookConfiguration **
Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see [Advanced data manipulation](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation).
Type: [HookConfiguration](API_HookConfiguration.md) object
Required: No
** PreExtractionHookConfiguration **
Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see [Advanced data manipulation](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation).
Type: [HookConfiguration](API_HookConfiguration.md) object
Required: No
** RoleArn **
The Amazon Resource Name (ARN) of an IAM role with permission to run `PreExtractionHookConfiguration` and `PostExtractionHookConfiguration` for altering document metadata and content during the document ingestion process. For more information, see [an IAM 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: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/CustomDocumentEnrichmentConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/CustomDocumentEnrichmentConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/CustomDocumentEnrichmentConfiguration)
# DatabaseConfiguration
Provides the configuration information to an [Amazon Kendra supported database](https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html).
## Contents
** ColumnConfiguration **
Information about where the index should get the document information from the database.
Type: [ColumnConfiguration](API_ColumnConfiguration.md) object
Required: Yes
** ConnectionConfiguration **
Configuration information that's required to connect to a database.
Type: [ConnectionConfiguration](API_ConnectionConfiguration.md) object
Required: Yes
** DatabaseEngineType **
The type of database engine that runs the database.
Type: String
Valid Values: `RDS_AURORA_MYSQL | RDS_AURORA_POSTGRESQL | RDS_MYSQL | RDS_POSTGRESQL`
Required: Yes
** AclConfiguration **
Information about the database column that provides information for user context filtering.
Type: [AclConfiguration](API_AclConfiguration.md) object
Required: No
** SqlConfiguration **
Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
Type: [SqlConfiguration](API_SqlConfiguration.md) object
Required: No
** VpcConfiguration **
Provides the configuration information to connect to an Amazon VPC.
Type: [DataSourceVpcConfiguration](API_DataSourceVpcConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DatabaseConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DatabaseConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DatabaseConfiguration)
# DataSourceConfiguration
Provides the configuration information for an Amazon Kendra data source.
## Contents
** AlfrescoConfiguration **
*This member has been deprecated.*
Provides the configuration information to connect to Alfresco as your data source.
Support for `AlfrescoConfiguration` ended May 2023. We recommend migrating to or using the Alfresco data source template schema / [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API.
Type: [AlfrescoConfiguration](API_AlfrescoConfiguration.md) object
Required: No
** BoxConfiguration **
Provides the configuration information to connect to Box as your data source.
Type: [BoxConfiguration](API_BoxConfiguration.md) object
Required: No
** ConfluenceConfiguration **
Provides the configuration information to connect to Confluence as your data source.
Type: [ConfluenceConfiguration](API_ConfluenceConfiguration.md) object
Required: No
** DatabaseConfiguration **
Provides the configuration information to connect to a database as your data source.
Type: [DatabaseConfiguration](API_DatabaseConfiguration.md) object
Required: No
** FsxConfiguration **
Provides the configuration information to connect to Amazon FSx as your data source.
Amazon Kendra now supports an upgraded Amazon FSx Windows connector.
You must now use the [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) object instead of the `FsxConfiguration` object to configure your connector.
Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.
We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.
Type: [FsxConfiguration](API_FsxConfiguration.md) object
Required: No
** GitHubConfiguration **
Provides the configuration information to connect to GitHub as your data source.
Amazon Kendra now supports an upgraded GitHub connector.
You must now use the [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) object instead of the `GitHubConfiguration` object to configure your connector.
Connectors configured using the older console and API architecture will continue to function as configured. However, you won’t be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.
We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.
Type: [GitHubConfiguration](API_GitHubConfiguration.md) object
Required: No
** GoogleDriveConfiguration **
Provides the configuration information to connect to Google Drive as your data source.
Type: [GoogleDriveConfiguration](API_GoogleDriveConfiguration.md) object
Required: No
** JiraConfiguration **
Provides the configuration information to connect to Jira as your data source.
Type: [JiraConfiguration](API_JiraConfiguration.md) object
Required: No
** OneDriveConfiguration **
Provides the configuration information to connect to Microsoft OneDrive as your data source.
Type: [OneDriveConfiguration](API_OneDriveConfiguration.md) object
Required: No
** QuipConfiguration **
Provides the configuration information to connect to Quip as your data source.
Type: [QuipConfiguration](API_QuipConfiguration.md) object
Required: No
** S3Configuration **
Provides the configuration information to connect to an Amazon S3 bucket as your data source.
Amazon Kendra now supports an upgraded Amazon S3 connector.
You must now use the [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) object instead of the `S3DataSourceConfiguration` object to configure your connector.
Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.
We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.
Type: [S3DataSourceConfiguration](API_S3DataSourceConfiguration.md) object
Required: No
** SalesforceConfiguration **
Provides the configuration information to connect to Salesforce as your data source.
Type: [SalesforceConfiguration](API_SalesforceConfiguration.md) object
Required: No
** ServiceNowConfiguration **
Provides the configuration information to connect to ServiceNow as your data source.
Type: [ServiceNowConfiguration](API_ServiceNowConfiguration.md) object
Required: No
** SharePointConfiguration **
Provides the configuration information to connect to Microsoft SharePoint as your data source.
Type: [SharePointConfiguration](API_SharePointConfiguration.md) object
Required: No
** SlackConfiguration **
Provides the configuration information to connect to Slack as your data source.
Amazon Kendra now supports an upgraded Slack connector.
You must now use the [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) object instead of the `SlackConfiguration` object to configure your connector.
Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.
We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.
Type: [SlackConfiguration](API_SlackConfiguration.md) object
Required: No
** TemplateConfiguration **
Provides a template for the configuration information to connect to your data source.
Type: [TemplateConfiguration](API_TemplateConfiguration.md) object
Required: No
** WebCrawlerConfiguration **
Provides the configuration information required for Amazon Kendra Web Crawler.
Type: [WebCrawlerConfiguration](API_WebCrawlerConfiguration.md) object
Required: No
** WorkDocsConfiguration **
Provides the configuration information to connect to WorkDocs as your data source.
Type: [WorkDocsConfiguration](API_WorkDocsConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DataSourceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DataSourceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DataSourceConfiguration)
# DataSourceGroup
Data source information for user context filtering.
## Contents
** DataSourceId **
The identifier of the data source group you want to add to your list of data source groups. This is for filtering search results based on the groups' access to documents in that data source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** GroupId **
The identifier of the group you want to add to your list of groups. This is for filtering search results based on the groups' access to documents.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `^\P{C}*$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DataSourceGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DataSourceGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DataSourceGroup)
# DataSourceSummary
Summary information for a Amazon Kendra data source.
## Contents
** CreatedAt **
The Unix timestamp when the data source connector was created.
Type: Timestamp
Required: No
** Id **
The identifier for the data source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** LanguageCode **
The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see [Adding documents in languages other than English](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
Type: String
Length Constraints: Minimum length of 2. Maximum length of 10.
Pattern: `[a-zA-Z-]*`
Required: No
** Name **
The name of the data source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** Status **
The status of the data source. When the status is `ACTIVE` the data source is ready to use.
Type: String
Valid Values: `CREATING | DELETING | FAILED | UPDATING | ACTIVE`
Required: No
** Type **
The type of the data source.
Type: String
Valid Values: `S3 | SHAREPOINT | DATABASE | SALESFORCE | ONEDRIVE | SERVICENOW | CUSTOM | CONFLUENCE | GOOGLEDRIVE | WEBCRAWLER | WORKDOCS | FSX | SLACK | BOX | QUIP | JIRA | GITHUB | ALFRESCO | TEMPLATE`
Required: No
** UpdatedAt **
The Unix timestamp when the data source connector was last updated.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DataSourceSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DataSourceSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DataSourceSummary)
# DataSourceSyncJob
Provides information about a data source synchronization job.
## Contents
** DataSourceErrorCode **
If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** EndTime **
The Unix timestamp when the synchronization job completed.
Type: Timestamp
Required: No
** ErrorCode **
If the `Status` field is set to `FAILED`, the `ErrorCode` field indicates the reason the synchronization failed.
Type: String
Valid Values: `InternalError | InvalidRequest`
Required: No
** ErrorMessage **
If the `Status` field is set to `ERROR`, the `ErrorMessage` field contains a description of the error that caused the synchronization to fail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
Required: No
** ExecutionId **
A identifier for the synchronization job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** Metrics **
Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.
Type: [DataSourceSyncJobMetrics](API_DataSourceSyncJobMetrics.md) object
Required: No
** StartTime **
The Unix timestamp when the synchronization job started.
Type: Timestamp
Required: No
** Status **
The execution status of the synchronization job. When the `Status` field is set to `SUCCEEDED`, the synchronization job is done. If the status code is set to `FAILED`, the `ErrorCode` and `ErrorMessage` fields give you the reason for the failure.
Type: String
Valid Values: `FAILED | SUCCEEDED | SYNCING | INCOMPLETE | STOPPING | ABORTED | SYNCING_INDEXING`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DataSourceSyncJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DataSourceSyncJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DataSourceSyncJob)
# DataSourceSyncJobMetrics
Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.
## Contents
** DocumentsAdded **
The number of documents added from the data source up to now in the data source sync.
Type: String
Pattern: `(([1-9][0-9]*)|0)`
Required: No
** DocumentsDeleted **
The number of documents deleted from the data source up to now in the data source sync run.
Type: String
Pattern: `(([1-9][0-9]*)|0)`
Required: No
** DocumentsFailed **
The number of documents that failed to sync from the data source up to now in the data source sync run.
Type: String
Pattern: `(([1-9][0-9]*)|0)`
Required: No
** DocumentsModified **
The number of documents modified in the data source up to now in the data source sync run.
Type: String
Pattern: `(([1-9][0-9]*)|0)`
Required: No
** DocumentsScanned **
The current number of documents crawled by the current sync job in the data source.
Type: String
Pattern: `(([1-9][0-9]*)|0)`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DataSourceSyncJobMetrics)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DataSourceSyncJobMetrics)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DataSourceSyncJobMetrics)
# DataSourceSyncJobMetricTarget
Maps a particular data source sync job to a particular data source.
## Contents
** DataSourceId **
The ID of the data source that is running the sync job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: Yes
** DataSourceSyncJobId **
The ID of the sync job that is running on the data source.
If the ID of a sync job is not provided and there is a sync job running, then the ID of this sync job is used and metrics are generated for this sync job.
If the ID of a sync job is not provided and there is no sync job running, then no metrics are generated and documents are indexed/deleted at the index level without sync job metrics included.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DataSourceSyncJobMetricTarget)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DataSourceSyncJobMetricTarget)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DataSourceSyncJobMetricTarget)
# DataSourceToIndexFieldMapping
Maps attributes or field names of the documents synced from the data source to Amazon Kendra index field names. You can set up field mappings for each data source when calling [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) or [UpdateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateDataSource.html) API. To create custom fields, use the `UpdateIndex` API to first create an index field and then map to the data source field. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
## Contents
** DataSourceFieldName **
The name of the field in the data source. You must first create the index field using the `UpdateIndex` API.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_.]*$`
Required: Yes
** IndexFieldName **
The name of the index field to map to the data source field. The index field type must match the data source field type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 30.
Pattern: `^\P{C}*$`
Required: Yes
** DateFieldFormat **
The format for date fields in the data source. If the field specified in `DataSourceFieldName` is a date field, you must specify the date format. If the field is not a date field, an exception is thrown.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 40.
Pattern: `^(?!\s).*(?
A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `[-0-9a-zA-Z]+`
Required: Yes
** SubnetIds **
A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 6 items.
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `[\-0-9a-zA-Z]+`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DataSourceVpcConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DataSourceVpcConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DataSourceVpcConfiguration)
# Document
A document in an index.
## Contents
** Id **
A identifier of the document in the index.
Note, each document ID must be unique per index. You cannot create a data source to index your documents with their unique IDs and then use the `BatchPutDocument` API to index the same documents, or vice versa. You can delete a data source and then use the `BatchPutDocument` API to index the same documents, or vice versa.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
** AccessControlConfigurationId **
The identifier of the access control configuration that you want to apply to the document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9-]+`
Required: No
** AccessControlList **
Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
Type: Array of [Principal](API_Principal.md) objects
Required: No
** Attributes **
Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.
For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.
Type: Array of [DocumentAttribute](API_DocumentAttribute.md) objects
Required: No
** Blob **
The contents of the document.
Documents passed to the `Blob` parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an AWS SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.
Type: Base64-encoded binary data object
Required: No
** ContentType **
The file type of the document in the `Blob` field.
If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you must add the `HTML` start and closing tags (`content`) around the content.
Type: String
Valid Values: `PDF | HTML | MS_WORD | PLAIN_TEXT | PPT | RTF | XML | XSLT | MS_EXCEL | CSV | JSON | MD`
Required: No
** HierarchicalAccessControlList **
The list of [principal](https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) lists that define the hierarchy for which documents users should have access to.
Type: Array of [HierarchicalPrincipal](API_HierarchicalPrincipal.md) objects
Array Members: Minimum number of 1 item. Maximum number of 30 items.
Required: No
** S3Path **
Information required to find a specific file in an Amazon S3 bucket.
Type: [S3Path](API_S3Path.md) object
Required: No
** Title **
The title of the document.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/Document)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/Document)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/Document)
# DocumentAttribute
A document attribute or metadata field. To create custom document attributes, see [Custom attributes](https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html).
## Contents
** Key **
The identifier for the attribute.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `[a-zA-Z0-9_][a-zA-Z0-9_-]*`
Required: Yes
** Value **
The value of the attribute.
Type: [DocumentAttributeValue](API_DocumentAttributeValue.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DocumentAttribute)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DocumentAttribute)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DocumentAttribute)
# DocumentAttributeCondition
The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra. You use this with [DocumentAttributeTarget to apply the condition](https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeTarget.html).
For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source\$1URI' field. Set the condition that if the 'Source\$1URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.
Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using `DocumentAttributeTarget`. Amazon Kendra then will map your newly created metadata field to your index field.
## Contents
** ConditionDocumentAttributeKey **
The identifier of the document attribute used for the condition.
For example, 'Source\$1URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Kendra currently does not support `_document_body` as an attribute key used for the condition.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `[a-zA-Z0-9_][a-zA-Z0-9_-]*`
Required: Yes
** Operator **
The condition operator.
For example, you can use 'Contains' to partially match a string.
Type: String
Valid Values: `GreaterThan | GreaterThanOrEquals | LessThan | LessThanOrEquals | Equals | NotEquals | Contains | NotContains | Exists | NotExists | BeginsWith`
Required: Yes
** ConditionOnValue **
The value used by the operator.
For example, you can specify the value 'financial' for strings in the 'Source\$1URI' field that partially match or contain this value.
Type: [DocumentAttributeValue](API_DocumentAttributeValue.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DocumentAttributeCondition)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DocumentAttributeCondition)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DocumentAttributeCondition)
# DocumentAttributeTarget
The target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra.
For example, you can delete customer identification numbers associated with the documents, stored in the document metadata field called 'Customer\$1ID'. You set the target key as 'Customer\$1ID' and the deletion flag to `TRUE`. This removes all customer ID values in the field 'Customer\$1ID'. This would scrub personally identifiable information from each document's metadata.
Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using `DocumentAttributeTarget`. Amazon Kendra then will map your newly created metadata field to your index field.
You can also use this with [DocumentAttributeCondition](https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeCondition.html).
## Contents
** TargetDocumentAttributeKey **
The identifier of the target document attribute or metadata field.
For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `[a-zA-Z0-9_][a-zA-Z0-9_-]*`
Required: No
** TargetDocumentAttributeValue **
The target value you want to create for the target attribute.
For example, 'Finance' could be the target value for the target attribute key 'Department'.
Type: [DocumentAttributeValue](API_DocumentAttributeValue.md) object
Required: No
** TargetDocumentAttributeValueDeletion **
`TRUE` to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to `TRUE`. To create a target value (`TargetDocumentAttributeValue`), set this to `FALSE`.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DocumentAttributeTarget)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DocumentAttributeTarget)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DocumentAttributeTarget)
# DocumentAttributeValue
The value of a document attribute. You can only provide one value for a document attribute.
## Contents
** DateValue **
A date expressed as an ISO 8601 string.
It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10\$101:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
Type: Timestamp
Required: No
** LongValue **
A long integer value.
Type: Long
Required: No
** StringListValue **
A list of strings. The default maximum length or number of strings is 10.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** StringValue **
A string, such as "department".
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DocumentAttributeValue)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DocumentAttributeValue)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DocumentAttributeValue)
# DocumentAttributeValueCountPair
Provides the count of documents that match a particular document attribute or field when doing a faceted search.
## Contents
** Count **
The number of documents in the response that have the attribute/field value for the key.
Type: Integer
Required: No
** DocumentAttributeValue **
The value of the attribute/field. For example, "HR".
Type: [DocumentAttributeValue](API_DocumentAttributeValue.md) object
Required: No
** FacetResults **
Contains the results of a document attribute/field that is a nested facet. A `FacetResult` contains the counts for each facet nested within a facet.
For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.
Type: Array of [FacetResult](API_FacetResult.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DocumentAttributeValueCountPair)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DocumentAttributeValueCountPair)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DocumentAttributeValueCountPair)
# DocumentInfo
Identifies a document for which to retrieve status information
## Contents
** DocumentId **
The identifier of the document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
** Attributes **
Attributes that identify a specific version of a document to check.
The only valid attributes are:
+ version
+ datasourceId
+ jobExecutionId
The attributes follow these rules:
+ `dataSourceId` and `jobExecutionId` must be used together.
+ `version` is ignored if `dataSourceId` and `jobExecutionId` are not provided.
+ If `dataSourceId` and `jobExecutionId` are provided, but `version` is not, the version defaults to "0".
Type: Array of [DocumentAttribute](API_DocumentAttribute.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DocumentInfo)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DocumentInfo)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DocumentInfo)
# DocumentMetadataConfiguration
Specifies the properties, such as relevance tuning and searchability, of an index field.
## Contents
** Name **
The name of the index field.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 30.
Required: Yes
** Type **
The data type of the index field.
Type: String
Valid Values: `STRING_VALUE | STRING_LIST_VALUE | LONG_VALUE | DATE_VALUE`
Required: Yes
** Relevance **
Provides tuning parameters to determine how the field affects the search results.
Type: [Relevance](API_Relevance.md) object
Required: No
** Search **
Provides information about how the field is used during a search.
Type: [Search](API_Search.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DocumentMetadataConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DocumentMetadataConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DocumentMetadataConfiguration)
# DocumentRelevanceConfiguration
Overrides the document relevance properties of a custom index field.
## Contents
** Name **
The name of the index field.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 30.
Required: Yes
** Relevance **
Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.
Type: [Relevance](API_Relevance.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DocumentRelevanceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DocumentRelevanceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DocumentRelevanceConfiguration)
# DocumentsMetadataConfiguration
Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.
## Contents
** S3Prefix **
A prefix used to filter metadata configuration files in the AWS S3 bucket. The S3 bucket might contain multiple metadata files. Use `S3Prefix` to include only the desired metadata files.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DocumentsMetadataConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DocumentsMetadataConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DocumentsMetadataConfiguration)
# EntityConfiguration
Provides the configuration information for users or groups in your IAM Identity Center identity source to grant access your Amazon Kendra experience.
## Contents
** EntityId **
The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 47.
Pattern: `^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$`
Required: Yes
** EntityType **
Specifies whether you are configuring a `User` or a `Group`.
Type: String
Valid Values: `USER | GROUP`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/EntityConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/EntityConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/EntityConfiguration)
# EntityDisplayData
Information about the user entity.
## Contents
** FirstName **
The first name of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[\S\s]*$`
Required: No
** GroupName **
The name of the group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[\S\s]*$`
Required: No
** IdentifiedUserName **
The user name of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[\S\s]*$`
Required: No
** LastName **
The last name of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[\S\s]*$`
Required: No
** UserName **
The name of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[\S\s]*$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/EntityDisplayData)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/EntityDisplayData)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/EntityDisplayData)
# EntityPersonaConfiguration
Provides the configuration information for users or groups in your IAM Identity Center identity source for access to your Amazon Kendra experience. Specific permissions are defined for each user or group once they are granted access to your Amazon Kendra experience.
## Contents
** EntityId **
The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 47.
Pattern: `^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$`
Required: Yes
** Persona **
The persona that defines the specific permissions of the user or group in your IAM Identity Center identity source. The available personas or access roles are `Owner` and `Viewer`. For more information on these personas, see [Providing access to your search page](https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience).
Type: String
Valid Values: `OWNER | VIEWER`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/EntityPersonaConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/EntityPersonaConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/EntityPersonaConfiguration)
# ExpandConfiguration
Specifies the configuration information needed to customize how collapsed search result groups expand.
## Contents
** MaxExpandedResultsPerItem **
The number of expanded results to show per collapsed primary document. For instance, if you set this value to 3, then at most 3 results per collapsed group will be displayed.
Type: Integer
Required: No
** MaxResultItemsToExpand **
The number of collapsed search result groups to expand. If you set this value to 10, for example, only the first 10 out of 100 result groups will have expand functionality.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ExpandConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ExpandConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ExpandConfiguration)
# ExpandedResultItem
A single expanded result in a collapsed group of search results.
An expanded result item contains information about an expanded result document within a collapsed group of search results. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.
## Contents
** DocumentAttributes **
An array of document attributes assigned to a document in the search results. For example, the document author ("\$1author") or the source URI ("\$1source\$1uri") of the document.
Type: Array of [DocumentAttribute](API_DocumentAttribute.md) objects
Required: No
** DocumentExcerpt **
Provides text and information about where to highlight the text.
Type: [TextWithHighlights](API_TextWithHighlights.md) object
Required: No
** DocumentId **
The idenitifier of the document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** DocumentTitle **
Provides text and information about where to highlight the text.
Type: [TextWithHighlights](API_TextWithHighlights.md) object
Required: No
** DocumentURI **
The URI of the original location of the document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^(https?|ftp|file):\/\/([^\s]*)`
Required: No
** Id **
The identifier for the expanded result.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 73.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ExpandedResultItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ExpandedResultItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ExpandedResultItem)
# ExperienceConfiguration
Provides the configuration information for your Amazon Kendra experience. This includes the data source IDs and/or FAQ IDs, and user or group information to grant access to your Amazon Kendra experience.
## Contents
** ContentSourceConfiguration **
The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the `BatchPutDocument` API. This is the content you want to use for your Amazon Kendra experience.
Type: [ContentSourceConfiguration](API_ContentSourceConfiguration.md) object
Required: No
** UserIdentityConfiguration **
The IAM Identity Center field name that contains the identifiers of your users, such as their emails.
Type: [UserIdentityConfiguration](API_UserIdentityConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ExperienceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ExperienceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ExperienceConfiguration)
# ExperienceEndpoint
Provides the configuration information for the endpoint for your Amazon Kendra experience.
## Contents
** Endpoint **
The endpoint of your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
Required: No
** EndpointType **
The type of endpoint for your Amazon Kendra experience. The type currently available is `HOME`, which is a unique and fully hosted URL to the home page of your Amazon Kendra experience.
Type: String
Valid Values: `HOME`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ExperienceEndpoint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ExperienceEndpoint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ExperienceEndpoint)
# ExperienceEntitiesSummary
Summary information for users or groups in your IAM Identity Center identity source with granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see [Building a search experience with no code](https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).
## Contents
** DisplayData **
Information about the user entity.
Type: [EntityDisplayData](API_EntityDisplayData.md) object
Required: No
** EntityId **
The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 47.
Pattern: `^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$`
Required: No
** EntityType **
Shows the type as `User` or `Group`.
Type: String
Valid Values: `USER | GROUP`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ExperienceEntitiesSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ExperienceEntitiesSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ExperienceEntitiesSummary)
# ExperiencesSummary
Summary information for your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see [Building a search experience with no code](https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).
## Contents
** CreatedAt **
The Unix timestamp when your Amazon Kendra experience was created.
Type: Timestamp
Required: No
** Endpoints **
The endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
Type: Array of [ExperienceEndpoint](API_ExperienceEndpoint.md) objects
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Required: No
** Id **
The identifier of your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** Name **
The name of your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** Status **
The processing status of your Amazon Kendra experience.
Type: String
Valid Values: `CREATING | ACTIVE | DELETING | FAILED`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ExperiencesSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ExperiencesSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ExperiencesSummary)
# Facet
Information about a document attribute or field. You can use document attributes as facets.
For example, the document attribute or facet "Department" includes the values "HR", "Engineering", and "Accounting". You can display these values in the search results so that documents can be searched by department.
You can display up to 10 facet values per facet for a query. If you want to increase this limit, contact [Support](http://aws.amazon.com/contact-us/).
## Contents
** DocumentAttributeKey **
The unique key for the document attribute.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `[a-zA-Z0-9_][a-zA-Z0-9_-]*`
Required: No
** Facets **
An array of document attributes that are nested facets within a facet.
For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. This helps your users further narrow their search.
You can only have one nested facet within a facet. If you want to increase this limit, contact [Support](http://aws.amazon.com/contact-us/).
Type: Array of [Facet](#API_Facet) objects
Required: No
** MaxResults **
Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact [Support](http://aws.amazon.com/contact-us/).
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 5000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/Facet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/Facet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/Facet)
# FacetResult
The facet values for the documents in the response.
## Contents
** DocumentAttributeKey **
The key for the facet values. This is the same as the `DocumentAttributeKey` provided in the query.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `[a-zA-Z0-9_][a-zA-Z0-9_-]*`
Required: No
** DocumentAttributeValueCountPairs **
An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.
Type: Array of [DocumentAttributeValueCountPair](API_DocumentAttributeValueCountPair.md) objects
Required: No
** DocumentAttributeValueType **
The data type of the facet value. This is the same as the type defined for the index field when it was created.
Type: String
Valid Values: `STRING_VALUE | STRING_LIST_VALUE | LONG_VALUE | DATE_VALUE`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/FacetResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/FacetResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/FacetResult)
# FailedEntity
Information on the users or groups in your IAM Identity Center identity source that failed to properly configure with your Amazon Kendra experience.
## Contents
** EntityId **
The identifier of the user or group in your IAM Identity Center identity source. For example, a user ID could be an email.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 47.
Pattern: `^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$`
Required: No
** ErrorMessage **
The reason the user or group in your IAM Identity Center identity source failed to properly configure with your Amazon Kendra experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/FailedEntity)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/FailedEntity)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/FailedEntity)
# FaqStatistics
Provides statistical information about the FAQ questions and answers for an index.
## Contents
** IndexedQuestionAnswersCount **
The total number of FAQ questions and answers for an index.
Type: Integer
Valid Range: Minimum value of 0.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/FaqStatistics)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/FaqStatistics)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/FaqStatistics)
# FaqSummary
Summary information for frequently asked questions and answers included in an index.
## Contents
** CreatedAt **
The Unix timestamp when the FAQ was created.
Type: Timestamp
Required: No
** FileFormat **
The file type used to create the FAQ.
Type: String
Valid Values: `CSV | CSV_WITH_HEADER | JSON`
Required: No
** Id **
The identifier of the FAQ.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** 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](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
Type: String
Length Constraints: Minimum length of 2. Maximum length of 10.
Pattern: `[a-zA-Z-]*`
Required: No
** Name **
The name that you assigned the FAQ when you created or updated the FAQ.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** Status **
The current status of the FAQ. When the status is `ACTIVE` the FAQ is ready for use.
Type: String
Valid Values: `CREATING | UPDATING | ACTIVE | DELETING | FAILED`
Required: No
** UpdatedAt **
The Unix timestamp when the FAQ was last updated.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/FaqSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/FaqSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/FaqSummary)
# FeaturedDocument
A featured document. This document is displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then the document is featured in the search results.
## Contents
** Id **
The identifier of the document to feature in the search results. You can use the [Query](https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html) API to search for specific documents with their document IDs included in the result items, or you can use the console.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/FeaturedDocument)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/FeaturedDocument)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/FeaturedDocument)
# FeaturedDocumentMissing
A document ID doesn't exist but you have specified as a featured document. Amazon Kendra cannot feature the document if it doesn't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the [BatchGetDocumentStatus](https://docs.aws.amazon.com/kendra/latest/dg/API_BatchGetDocumentStatus.html) API.
## Contents
** Id **
The identifier of the document that doesn't exist but you have specified as a featured document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/FeaturedDocumentMissing)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/FeaturedDocumentMissing)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/FeaturedDocumentMissing)
# FeaturedDocumentWithMetadata
A featured document with its metadata information. This document is displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then the document is featured in the search results.
## Contents
** Id **
The identifier of the featured document with its metadata. You can use the [Query](https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html) API to search for specific documents with their document IDs included in the result items, or you can use the console.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** Title **
The main title of the featured document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** URI **
The source URI location of the featured document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^(https?|ftp|file):\/\/([^\s]*)`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/FeaturedDocumentWithMetadata)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/FeaturedDocumentWithMetadata)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/FeaturedDocumentWithMetadata)
# FeaturedResultsItem
A single featured result item. A featured result is displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then certain documents are featured in the search results.
## Contents
** AdditionalAttributes **
One or more additional attributes associated with the featured result.
Type: Array of [AdditionalResultAttribute](API_AdditionalResultAttribute.md) objects
Required: No
** DocumentAttributes **
An array of document attributes assigned to a featured document in the search results. For example, the document author (`_author`) or the source URI (`_source_uri`) of the document.
Type: Array of [DocumentAttribute](API_DocumentAttribute.md) objects
Required: No
** DocumentExcerpt **
Provides text and information about where to highlight the text.
Type: [TextWithHighlights](API_TextWithHighlights.md) object
Required: No
** DocumentId **
The identifier of the featured document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** DocumentTitle **
Provides text and information about where to highlight the text.
Type: [TextWithHighlights](API_TextWithHighlights.md) object
Required: No
** DocumentURI **
The source URI location of the featured document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^(https?|ftp|file):\/\/([^\s]*)`
Required: No
** FeedbackToken **
A token that identifies a particular featured result from a particular query. Use this token to provide click-through feedback for the result. For more information, see [Submitting feedback](https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*.\P{C}*$`
Required: No
** Id **
The identifier of the featured result.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 73.
Required: No
** Type **
The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.
Type: String
Valid Values: `DOCUMENT | QUESTION_ANSWER | ANSWER`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/FeaturedResultsItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/FeaturedResultsItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/FeaturedResultsItem)
# FeaturedResultsSet
A set of featured results that are displayed at the top of your search results. Featured results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
## Contents
** CreationTimestamp **
The Unix timestamp when the set of featured results was created.
Type: Long
Required: No
** Description **
The description for the set of featured results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: `^\P{C}*$`
Required: No
** FeaturedDocuments **
The list of document IDs for the documents you want to feature at the top of the search results page. You can use the [Query](https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html) API to search for specific documents with their document IDs included in the result items, or you can use the console.
You can add up to four featured documents. You can request to increase this limit by contacting [Support](http://aws.amazon.com/contact-us/).
Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
Type: Array of [FeaturedDocument](API_FeaturedDocument.md) objects
Required: No
** FeaturedResultsSetId **
The identifier of the set of featured results.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `^[a-zA-Z-0-9]*`
Required: No
** FeaturedResultsSetName **
The name for the set of featured results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][ a-zA-Z0-9_-]*`
Required: No
** LastUpdatedTimestamp **
The Unix timestamp when the set of featured results was last updated.
Type: Long
Required: No
** QueryTexts **
The list of queries for featuring results.
Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 49 items.
Required: No
** Status **
The current status of the set of featured results. When the value is `ACTIVE`, featured results are ready for use. You can still configure your settings before setting the status to `ACTIVE`. You can set the status to `ACTIVE` or `INACTIVE` using the [UpdateFeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html) API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is `ACTIVE` or `INACTIVE`.
Type: String
Valid Values: `ACTIVE | INACTIVE`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/FeaturedResultsSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/FeaturedResultsSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/FeaturedResultsSet)
# FeaturedResultsSetSummary
Summary information for a set of featured results. Featured results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
## Contents
** CreationTimestamp **
The Unix timestamp when the set of featured results was created.
Type: Long
Required: No
** FeaturedResultsSetId **
The identifier of the set of featured results.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `^[a-zA-Z-0-9]*`
Required: No
** FeaturedResultsSetName **
The name for the set of featured results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][ a-zA-Z0-9_-]*`
Required: No
** LastUpdatedTimestamp **
The Unix timestamp when the set of featured results was last updated.
Type: Long
Required: No
** Status **
The current status of the set of featured results. When the value is `ACTIVE`, featured results are ready for use. You can still configure your settings before setting the status to `ACTIVE`. You can set the status to `ACTIVE` or `INACTIVE` using the [UpdateFeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html) API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is `ACTIVE` or `INACTIVE`.
Type: String
Valid Values: `ACTIVE | INACTIVE`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/FeaturedResultsSetSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/FeaturedResultsSetSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/FeaturedResultsSetSummary)
# FsxConfiguration
Provides the configuration information to connect to Amazon FSx as your data source.
**Note**
Amazon Kendra now supports an upgraded Amazon FSx Windows connector.
You must now use the [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) object instead of the `FsxConfiguration` object to configure your connector.
Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.
We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.
## Contents
** FileSystemId **
The identifier of the Amazon FSx file system.
You can find your file system ID on the file system dashboard in the Amazon FSx console. For information on how to create a file system in Amazon FSx console, using Windows File Server as an example, see [Amazon FSx Getting started guide](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/getting-started-step1.html).
Type: String
Length Constraints: Minimum length of 11. Maximum length of 21.
Pattern: `^(fs-[0-9a-f]{8,})$`
Required: Yes
** FileSystemType **
The Amazon FSx file system type. Windows is currently the only supported type.
Type: String
Valid Values: `WINDOWS`
Required: Yes
** VpcConfiguration **
Configuration information for an Amazon Virtual Private Cloud to connect to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.
Type: [DataSourceVpcConfiguration](API_DataSourceVpcConfiguration.md) object
Required: Yes
** ExclusionPatterns **
A list of regular expression patterns to exclude certain files in your Amazon FSx file system. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** FieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map Amazon FSx data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Amazon FSx fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Amazon FSx data source field names must exist in your Amazon FSx custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** InclusionPatterns **
A list of regular expression patterns to include certain files in your Amazon FSx file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** SecretArn **
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key-value pairs required to connect to your Amazon FSx file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys:
+ username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, *user@corp.example.com*. The Active Directory user account must have read and mounting access to the Amazon FSx file system for Windows.
+ password—The password of the Active Directory user account with read and mounting access to the Amazon FSx Windows file system.
Type: String
Length Constraints: Minimum length of 1. 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: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/FsxConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/FsxConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/FsxConfiguration)
# GitHubConfiguration
Provides the configuration information to connect to GitHub as your data source.
**Note**
Amazon Kendra now supports an upgraded GitHub connector.
You must now use the [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) object instead of the `GitHubConfiguration` object to configure your connector.
Connectors configured using the older console and API architecture will continue to function as configured. However, you won’t be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.
We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.
## Contents
** SecretArn **
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key-value pairs required to connect to your GitHub. The secret must contain a JSON structure with the following keys:
+ personalToken—The access token created in GitHub. For more information on creating a token in GitHub, see [Using a GitHub data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-github.html).
Type: String
Length Constraints: Minimum length of 1. 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
** ExclusionFileNamePatterns **
A list of regular expression patterns to exclude certain file names in your GitHub repository or repositories. File names that match the patterns are excluded from the index. File names that don't match the patterns are included in the index. If a file matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** ExclusionFileTypePatterns **
A list of regular expression patterns to exclude certain file types in your GitHub repository or repositories. File types that match the patterns are excluded from the index. File types that don't match the patterns are included in the index. If a file matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** ExclusionFolderNamePatterns **
A list of regular expression patterns to exclude certain folder names in your GitHub repository or repositories. Folder names that match the patterns are excluded from the index. Folder names that don't match the patterns are included in the index. If a folder matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the folder isn't included in the index.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** GitHubCommitConfigurationFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of GitHub commits to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to GitHub fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The GitHub data source field names must exist in your GitHub custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** GitHubDocumentCrawlProperties **
Configuration information to include certain types of GitHub content. You can configure to index repository files only, or also include issues and pull requests, comments, and comment attachments.
Type: [GitHubDocumentCrawlProperties](API_GitHubDocumentCrawlProperties.md) object
Required: No
** GitHubIssueAttachmentConfigurationFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of GitHub issue attachments to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to GitHub fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The GitHub data source field names must exist in your GitHub custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** GitHubIssueCommentConfigurationFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of GitHub issue comments to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to GitHub fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The GitHub data source field names must exist in your GitHub custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** GitHubIssueDocumentConfigurationFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of GitHub issues to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to GitHub fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The GitHub data source field names must exist in your GitHub custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** GitHubPullRequestCommentConfigurationFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of GitHub pull request comments to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to GitHub fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The GitHub data source field names must exist in your GitHub custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** GitHubPullRequestDocumentAttachmentConfigurationFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of GitHub pull request attachments to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to GitHub fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The GitHub data source field names must exist in your GitHub custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** GitHubPullRequestDocumentConfigurationFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of GitHub pull requests to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to GitHub fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The GitHub data source field names must exist in your GitHub custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** GitHubRepositoryConfigurationFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map GitHub repository attributes or field names to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to GitHub fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The GitHub data source field names must exist in your GitHub custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** InclusionFileNamePatterns **
A list of regular expression patterns to include certain file names in your GitHub repository or repositories. File names that match the patterns are included in the index. File names that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** InclusionFileTypePatterns **
A list of regular expression patterns to include certain file types in your GitHub repository or repositories. File types that match the patterns are included in the index. File types that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** InclusionFolderNamePatterns **
A list of regular expression patterns to include certain folder names in your GitHub repository or repositories. Folder names that match the patterns are included in the index. Folder names that don't match the patterns are excluded from the index. If a folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the folder isn't included in the index.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** OnPremiseConfiguration **
Configuration information to connect to GitHub Enterprise Server (on premises).
Type: [OnPremiseConfiguration](API_OnPremiseConfiguration.md) object
Required: No
** RepositoryFilter **
A list of names of the specific repositories you want to index.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `^[A-Za-z0-9_.-]+$`
Required: No
** SaaSConfiguration **
Configuration information to connect to GitHub Enterprise Cloud (SaaS).
Type: [SaaSConfiguration](API_SaaSConfiguration.md) object
Required: No
** Type **
The type of GitHub service you want to connect to—GitHub Enterprise Cloud (SaaS) or GitHub Enterprise Server (on premises).
Type: String
Valid Values: `SAAS | ON_PREMISE`
Required: No
** UseChangeLog **
`TRUE` to use the GitHub change log to determine which documents require updating in the index. Depending on the GitHub change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in GitHub.
Type: Boolean
Required: No
** VpcConfiguration **
Configuration information of an Amazon Virtual Private Cloud to connect to your GitHub. For more information, see [Configuring a VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
Type: [DataSourceVpcConfiguration](API_DataSourceVpcConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/GitHubConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/GitHubConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/GitHubConfiguration)
# GitHubDocumentCrawlProperties
Provides the configuration information to include certain types of GitHub content. You can configure to index repository files only, or also include issues and pull requests, comments, and comment attachments.
## Contents
** CrawlIssue **
`TRUE` to index all issues within a repository.
Type: Boolean
Required: No
** CrawlIssueComment **
`TRUE` to index all comments on issues.
Type: Boolean
Required: No
** CrawlIssueCommentAttachment **
`TRUE` to include all comment attachments for issues.
Type: Boolean
Required: No
** CrawlPullRequest **
`TRUE` to index all pull requests within a repository.
Type: Boolean
Required: No
** CrawlPullRequestComment **
`TRUE` to index all comments on pull requests.
Type: Boolean
Required: No
** CrawlPullRequestCommentAttachment **
`TRUE` to include all comment attachments for pull requests.
Type: Boolean
Required: No
** CrawlRepositoryDocuments **
`TRUE` to index all files with a repository.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/GitHubDocumentCrawlProperties)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/GitHubDocumentCrawlProperties)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/GitHubDocumentCrawlProperties)
# GoogleDriveConfiguration
Provides the configuration information to connect to Google Drive as your data source.
## Contents
** SecretArn **
The Amazon Resource Name (ARN) of a AWS Secrets Managersecret that contains the credentials required to connect to Google Drive. For more information, see [Using a Google Workspace Drive data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html).
Type: String
Length Constraints: Minimum length of 1. 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
** ExcludeMimeTypes **
A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.
For a list of MIME types, see [Using a Google Workspace Drive data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html).
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 30 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `^\P{C}*$`
Required: No
** ExcludeSharedDrives **
A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `^\P{C}*$`
Required: No
** ExcludeUserAccounts **
A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `^\P{C}*$`
Required: No
** ExclusionPatterns **
A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** FieldMappings **
Maps Google Drive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Google Drive fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Google Drive data source field names must exist in your Google Drive custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** InclusionPatterns **
A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/GoogleDriveConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/GoogleDriveConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/GoogleDriveConfiguration)
# GroupMembers
A list of users that belong to a group. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
## Contents
** MemberGroups **
A list of users that belong to a group. This can also include sub groups. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company A".
Type: Array of [MemberGroup](API_MemberGroup.md) objects
Array Members: Minimum number of 1 item. Maximum number of 1000 items.
Required: No
** MemberUsers **
A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
Type: Array of [MemberUser](API_MemberUser.md) objects
Array Members: Minimum number of 1 item. Maximum number of 1000 items.
Required: No
** S3PathforGroupMembers **
If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.
You can download this [example S3 file](https://docs.aws.amazon.com/kendra/latest/dg/samples/group_members.zip) that uses the correct format for listing group members. Note, `dataSourceId` is optional. The value of `type` for a group is always `GROUP` and for a user it is always `USER`.
Type: [S3Path](API_S3Path.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/GroupMembers)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/GroupMembers)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/GroupMembers)
# GroupOrderingIdSummary
Summary information on the processing of `PUT` and `DELETE` actions for mapping users to their groups.
## Contents
** FailureReason **
The reason an action could not be processed. An action can be a `PUT` or `DELETE` action for mapping users to their groups.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
Required: No
** LastUpdatedAt **
The Unix timestamp when an action was last updated. An action can be a `PUT` or `DELETE` action for mapping users to their groups.
Type: Timestamp
Required: No
** OrderingId **
The order in which actions should complete processing. An action can be a `PUT` or `DELETE` action for mapping users to their groups.
Type: Long
Valid Range: Minimum value of 0. Maximum value of 32535158400000.
Required: No
** ReceivedAt **
The Unix timestamp when an action was received by Amazon Kendra. An action can be a `PUT` or `DELETE` action for mapping users to their groups.
Type: Timestamp
Required: No
** Status **
The current processing status of actions for mapping users to their groups. The status can be either `PROCESSING`, `SUCCEEDED`, `DELETING`, `DELETED`, or `FAILED`.
Type: String
Valid Values: `FAILED | SUCCEEDED | PROCESSING | DELETING | DELETED`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/GroupOrderingIdSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/GroupOrderingIdSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/GroupOrderingIdSummary)
# GroupSummary
Summary information for groups.
## Contents
** GroupId **
The identifier of the group you want group summary information on.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `^\P{C}*$`
Required: No
** OrderingId **
The timestamp identifier used for the latest `PUT` or `DELETE` action.
Type: Long
Valid Range: Minimum value of 0. Maximum value of 32535158400000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/GroupSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/GroupSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/GroupSummary)
# HierarchicalPrincipal
Information to define the hierarchy for which documents users should have access to.
## Contents
** PrincipalList **
A list of [principal](https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) lists that define the hierarchy for which documents users should have access to. Each hierarchical list specifies which user or group has allow or deny access for each document.
Type: Array of [Principal](API_Principal.md) objects
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/HierarchicalPrincipal)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/HierarchicalPrincipal)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/HierarchicalPrincipal)
# Highlight
Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.
## Contents
** BeginOffset **
The zero-based location in the response string where the highlight starts.
Type: Integer
Required: Yes
** EndOffset **
The zero-based location in the response string where the highlight ends.
Type: Integer
Required: Yes
** TopAnswer **
Indicates whether the response is the best response. True if this is the best response; otherwise, false.
Type: Boolean
Required: No
** Type **
The highlight type.
Type: String
Valid Values: `STANDARD | THESAURUS_SYNONYM`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/Highlight)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/Highlight)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/Highlight)
# HookConfiguration
Provides the configuration information for invoking a Lambda function in AWS Lambda to alter document metadata and content when ingesting documents into Amazon Kendra. You can configure your Lambda function using [PreExtractionHookConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html) if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Kendra structured documents, you must configure your Lambda function using [PostExtractionHookConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html). You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see [Customizing document metadata during the ingestion process](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).
## Contents
** LambdaArn **
The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function during ingestion. For more information, see [an IAM roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `/arn:aws[a-zA-Z-]*:lambda:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?/`
Required: Yes
** S3Bucket **
Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see [Data contracts for Lambda functions](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda).
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern: `[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`
Required: Yes
** InvocationCondition **
The condition used for when a Lambda function should be invoked.
For example, you can specify a condition that if there are empty date-time values, then Amazon Kendra should invoke a function that inserts the current date-time.
Type: [DocumentAttributeCondition](API_DocumentAttributeCondition.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/HookConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/HookConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/HookConfiguration)
# IndexConfigurationSummary
Summary information on the configuration of an index.
## Contents
** CreatedAt **
The Unix timestamp when the index was created.
Type: Timestamp
Required: Yes
** Status **
The current status of the index. When the status is `ACTIVE`, the index is ready to search.
Type: String
Valid Values: `CREATING | ACTIVE | DELETING | FAILED | UPDATING | SYSTEM_UPDATING`
Required: Yes
** UpdatedAt **
The Unix timestamp when the index was last updated.
Type: Timestamp
Required: Yes
** Edition **
Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
Type: String
Valid Values: `DEVELOPER_EDITION | ENTERPRISE_EDITION | GEN_AI_ENTERPRISE_EDITION`
Required: No
** Id **
A identifier for the index. Use this to identify the index when you are using APIs such as `Query`, `DescribeIndex`, `UpdateIndex`, and `DeleteIndex`.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: No
** Name **
The name of the index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/IndexConfigurationSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/IndexConfigurationSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/IndexConfigurationSummary)
# IndexStatistics
Provides information about the number of documents and the number of questions and answers in an index.
## Contents
** FaqStatistics **
The number of question and answer topics in the index.
Type: [FaqStatistics](API_FaqStatistics.md) object
Required: Yes
** TextDocumentStatistics **
The number of text documents indexed.
Type: [TextDocumentStatistics](API_TextDocumentStatistics.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/IndexStatistics)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/IndexStatistics)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/IndexStatistics)
# InlineCustomDocumentEnrichmentConfiguration
Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Kendra. To apply advanced logic, to go beyond what you can do with basic logic, see [HookConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_HookConfiguration.html).
For more information, see [Customizing document metadata during the ingestion process](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).
## Contents
** Condition **
Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra.
Type: [DocumentAttributeCondition](API_DocumentAttributeCondition.md) object
Required: No
** DocumentContentDeletion **
`TRUE` to delete content if the condition used for the target attribute is met.
Type: Boolean
Required: No
** Target **
Configuration of the target document attribute or metadata field when ingesting documents into Amazon Kendra. You can also include a value.
Type: [DocumentAttributeTarget](API_DocumentAttributeTarget.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/InlineCustomDocumentEnrichmentConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/InlineCustomDocumentEnrichmentConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/InlineCustomDocumentEnrichmentConfiguration)
# JiraConfiguration
Provides the configuration information to connect to Jira as your data source.
## Contents
** JiraAccountUrl **
The URL of the Jira account. For example, *company.atlassian.net*.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^https:\/\/[a-zA-Z0-9_\-\.]+(\.atlassian\.net\/)$`
Required: Yes
** SecretArn **
The Amazon Resource Name (ARN) of a secret in AWS Secrets Manager contains the key-value pairs required to connect to your Jira data source. The secret must contain a JSON structure with the following keys:
+ jiraId—The Jira user name or email.
+ jiraCredentials—The Jira API token. For more information, see [Using a Jira data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-jira.html).
Type: String
Length Constraints: Minimum length of 1. 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
** AttachmentFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira attachments to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Jira fields. For more information, see [ Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Jira data source field names must exist in your Jira custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** CommentFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira comments to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Jira fields. For more information, see [ Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Jira data source field names must exist in your Jira custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** ExclusionPatterns **
A list of regular expression patterns to exclude certain file paths, file names, and file types in your Jira data source. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** InclusionPatterns **
A list of regular expression patterns to include certain file paths, file names, and file types in your Jira data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** IssueFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira issues to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Jira fields. For more information, see [ Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Jira data source field names must exist in your Jira custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** IssueSubEntityFilter **
Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 3 items.
Valid Values: `COMMENTS | ATTACHMENTS | WORKLOGS`
Required: No
** IssueType **
Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** Project **
Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** ProjectFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira projects to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Jira fields. For more information, see [ Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Jira data source field names must exist in your Jira custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** Status **
Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** UseChangeLog **
`TRUE` to use the Jira change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Jira.
Type: Boolean
Required: No
** VpcConfiguration **
Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. For more information, see [Configuring a VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
Type: [DataSourceVpcConfiguration](API_DataSourceVpcConfiguration.md) object
Required: No
** WorkLogFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira work logs to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Jira fields. For more information, see [ Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Jira data source field names must exist in your Jira custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/JiraConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/JiraConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/JiraConfiguration)
# JsonTokenTypeConfiguration
Provides the configuration information for the JSON token type.
## Contents
** GroupAttributeField **
The group attribute field.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
** UserNameAttributeField **
The user name attribute field.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/JsonTokenTypeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/JsonTokenTypeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/JsonTokenTypeConfiguration)
# JwtTokenTypeConfiguration
Provides the configuration information for the JWT token type.
## Contents
** KeyLocation **
The location of the key.
Type: String
Valid Values: `URL | SECRET_MANAGER`
Required: Yes
** ClaimRegex **
The regular expression that identifies the claim.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^\P{C}*$`
Required: No
** GroupAttributeField **
The group attribute field.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^\P{C}*$`
Required: No
** Issuer **
The issuer of the token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65.
Pattern: `^\P{C}*$`
Required: No
** SecretManagerArn **
The Amazon Resource Name (arn) of the secret.
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: No
** URL **
The signing key URL.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^(https?|ftp|file):\/\/([^\s]*)`
Required: No
** UserNameAttributeField **
The user name attribute field.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^\P{C}*$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/JwtTokenTypeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/JwtTokenTypeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/JwtTokenTypeConfiguration)
# MemberGroup
The sub groups that belong to a group.
## Contents
** GroupId **
The identifier of the sub group you want to map to a group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `^\P{C}*$`
Required: Yes
** DataSourceId **
The identifier of the data source for the sub group you want to map to a group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/MemberGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/MemberGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/MemberGroup)
# MemberUser
The users that belong to a group.
## Contents
** UserId **
The identifier of the user you want to map to a group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `^\P{C}*$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/MemberUser)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/MemberUser)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/MemberUser)
# OneDriveConfiguration
Provides the configuration information to connect to OneDrive as your data source.
## Contents
** OneDriveUsers **
A list of user accounts whose documents should be indexed.
Type: [OneDriveUsers](API_OneDriveUsers.md) object
Required: Yes
** SecretArn **
The Amazon Resource Name (ARN) of an AWS Secrets Managersecret that contains the user name and password to connect to OneDrive. The user name should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.
Type: String
Length Constraints: Minimum length of 1. 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
** TenantDomain **
The Azure Active Directory domain of the organization.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `^([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-z]{2,}$`
Required: Yes
** DisableLocalGroups **
`TRUE` to disable local groups information.
Type: Boolean
Required: No
** ExclusionPatterns **
A list of regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the file name.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** FieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to OneDrive fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The OneDrive data source field names must exist in your OneDrive custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** InclusionPatterns **
A list of regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the file name.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/OneDriveConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/OneDriveConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/OneDriveConfiguration)
# OneDriveUsers
User accounts whose documents should be indexed.
## Contents
** OneDriveUserList **
A list of users whose documents should be indexed. Specify the user names in email format, for example, `username@tenantdomain`. If you need to index the documents of more than 10 users, use the `OneDriveUserS3Path` field to specify the location of a file containing a list of users.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `^(?!\s).+@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$`
Required: No
** OneDriveUserS3Path **
The S3 bucket location of a file containing a list of users whose documents should be indexed.
Type: [S3Path](API_S3Path.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/OneDriveUsers)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/OneDriveUsers)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/OneDriveUsers)
# OnPremiseConfiguration
Provides the configuration information to connect to GitHub Enterprise Server (on premises).
## Contents
** HostUrl **
The GitHub host URL or API endpoint URL. For example, *https://on-prem-host-url/api/v3/*
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^(https?|ftp|file):\/\/([^\s]*)`
Required: Yes
** OrganizationName **
The name of the organization of the GitHub Enterprise Server (on-premises) account you want to connect to. You can find your organization name by logging into GitHub desktop and selecting **Your organizations** under your profile picture dropdown.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 60.
Pattern: `^[A-Za-z0-9_.-]+$`
Required: Yes
** SslCertificateS3Path **
The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to GitHub if you require a secure SSL connection.
You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see [Create and sign an X509 certificate](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html).
Type: [S3Path](API_S3Path.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/OnPremiseConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/OnPremiseConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/OnPremiseConfiguration)
# PersonasSummary
Summary information for users or groups in your IAM Identity Center identity source. This applies to users and groups with specific permissions that define their level of access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see [Building a search experience with no code](https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).
## Contents
** CreatedAt **
The Unix timestamp when the summary information was created.
Type: Timestamp
Required: No
** EntityId **
The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 47.
Pattern: `^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$`
Required: No
** Persona **
The persona that defines the specific permissions of the user or group in your IAM Identity Center identity source. The available personas or access roles are `Owner` and `Viewer`. For more information on these personas, see [Providing access to your search page](https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience).
Type: String
Valid Values: `OWNER | VIEWER`
Required: No
** UpdatedAt **
The Unix timestamp when the summary information was last updated.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/PersonasSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/PersonasSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/PersonasSummary)
# Principal
Provides user and group information for [user context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html).
## Contents
** Access **
Whether to allow or deny document access to the principal.
Type: String
Valid Values: `ALLOW | DENY`
Required: Yes
** Name **
The name of the user or group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `^\P{C}*$`
Required: Yes
** Type **
The type of principal.
Type: String
Valid Values: `USER | GROUP`
Required: Yes
** DataSourceId **
The identifier of the data source the principal should access documents from.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/Principal)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/Principal)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/Principal)
# ProxyConfiguration
Provides the configuration information for a web proxy to connect to website hosts.
## Contents
** Host **
The name of the website host you want to connect to via a web proxy server.
For example, the host name of https://a.example.com/page1.html is "a.example.com".
Type: String
Length Constraints: Minimum length of 1. Maximum length of 253.
Pattern: `([^\s]*)`
Required: Yes
** Port **
The port number of the website host you want to connect to via a web proxy server.
For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65535.
Required: Yes
** Credentials **
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret. You create a secret to store your credentials in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)
The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.
Type: String
Length Constraints: Minimum length of 1. 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: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ProxyConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ProxyConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ProxyConfiguration)
# QueryResultItem
A single query result.
A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.
## Contents
** AdditionalAttributes **
One or more additional fields/attributes associated with the query result.
Type: Array of [AdditionalResultAttribute](API_AdditionalResultAttribute.md) objects
Required: No
** CollapsedResultDetail **
Provides details about a collapsed group of search results.
Type: [CollapsedResultDetail](API_CollapsedResultDetail.md) object
Required: No
** DocumentAttributes **
An array of document fields/attributes assigned to a document in the search results. For example, the document author (`_author`) or the source URI (`_source_uri`) of the document.
Type: Array of [DocumentAttribute](API_DocumentAttribute.md) objects
Required: No
** DocumentExcerpt **
An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.
Type: [TextWithHighlights](API_TextWithHighlights.md) object
Required: No
** DocumentId **
The identifier for the document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** DocumentTitle **
The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.
Type: [TextWithHighlights](API_TextWithHighlights.md) object
Required: No
** DocumentURI **
The URI of the original location of the document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^(https?|ftp|file):\/\/([^\s]*)`
Required: No
** FeedbackToken **
A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see [Submitting feedback](https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*.\P{C}*$`
Required: No
** Format **
If the `Type` of document within the response is `ANSWER`, then it is either a `TABLE` answer or `TEXT` answer. If it's a table answer, a table excerpt is returned in `TableExcerpt`. If it's a text answer, a text excerpt is returned in `DocumentExcerpt`.
Type: String
Valid Values: `TABLE | TEXT`
Required: No
** Id **
The unique identifier for the query result item id (`Id`) and the query result item document id (`DocumentId`) combined. The value of this field changes with every request, even when you have the same documents.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 73.
Required: No
** ScoreAttributes **
Indicates the confidence level of Amazon Kendra providing a relevant result for the query. Each result is placed into a bin that indicates the confidence, `VERY_HIGH`, `HIGH`, `MEDIUM` and `LOW`. You can use the score to determine if a response meets the confidence needed for your application.
The field is only set to `LOW` when the `Type` field is set to `DOCUMENT` and Amazon Kendra is not confident that the result is relevant to the query.
Type: [ScoreAttributes](API_ScoreAttributes.md) object
Required: No
** TableExcerpt **
An excerpt from a table within a document.
Type: [TableExcerpt](API_TableExcerpt.md) object
Required: No
** Type **
The type of document within the response. For example, a response could include a question-answer that's relevant to the query.
Type: String
Valid Values: `DOCUMENT | QUESTION_ANSWER | ANSWER`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/QueryResultItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/QueryResultItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/QueryResultItem)
# QuerySuggestionsBlockListSummary
Summary information on a query suggestions block list.
This includes information on the block list ID, block list name, when the block list was created, when the block list was last updated, and the count of block words/phrases in the block list.
For information on the current quota limits for block lists, see [Quotas for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
## Contents
** CreatedAt **
The Unix timestamp when the block list was created.
Type: Timestamp
Required: No
** Id **
The identifier of a block list.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: No
** ItemCount **
The number of items in the block list file.
Type: Integer
Required: No
** Name **
The name of the block list.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*`
Required: No
** Status **
The status of the block list.
Type: String
Valid Values: `ACTIVE | CREATING | DELETING | UPDATING | ACTIVE_BUT_UPDATE_FAILED | FAILED`
Required: No
** UpdatedAt **
The Unix timestamp when the block list was last updated.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/QuerySuggestionsBlockListSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/QuerySuggestionsBlockListSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/QuerySuggestionsBlockListSummary)
# QuipConfiguration
Provides the configuration information to connect to Quip as your data source.
## Contents
** Domain **
The Quip site domain. For example, *https://quip-company.quipdomain.com/browse*. The domain in this example is "quipdomain".
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^(?!-)[A-Za-z0-9-].*(?
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip. The secret must contain a JSON structure with the following keys:
+ accessToken—The token created in Quip. For more information, see [Using a Quip data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-quip.html).
Type: String
Length Constraints: Minimum length of 1. 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
** AttachmentFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Quip attachments to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Quip fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Quip field names must exist in your Quip custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** CrawlAttachments **
`TRUE` to index attachments.
Type: Boolean
Required: No
** CrawlChatRooms **
`TRUE` to index the contents of chat rooms.
Type: Boolean
Required: No
** CrawlFileComments **
`TRUE` to index file comments.
Type: Boolean
Required: No
** ExclusionPatterns **
A list of regular expression patterns to exclude certain files in your Quip file system. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** FolderIds **
The identifiers of the Quip folders you want to index. You can find the folder ID in your browser URL when you access your folder in Quip. For example, *https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name*. The folder ID in this example is "zlLuOVNSarTL".
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: No
** InclusionPatterns **
A list of regular expression patterns to include certain files in your Quip file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** MessageFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Quip messages to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Quip fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Quip field names must exist in your Quip custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** ThreadFieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map attributes or field names of Quip threads to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Quip fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Quip field names must exist in your Quip custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** VpcConfiguration **
Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see [Configuring a VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
Type: [DataSourceVpcConfiguration](API_DataSourceVpcConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/QuipConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/QuipConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/QuipConfiguration)
# Relevance
Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.
## Contents
** Duration **
Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use "2628000s". Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don't specify a value, the default is 3 months. The value of the field is a numeric string followed by the character "s", for example "86400s" for one day, or "604800s" for one week.
Only applies to `DATE` fields.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10.
Pattern: `[0-9]+[s]`
Required: No
** Freshness **
Indicates that this field determines how "fresh" a document is. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is "fresher" than document 2. Only applies to `DATE` fields.
Type: Boolean
Required: No
** Importance **
The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No
** RankOrder **
Determines how values should be interpreted.
When the `RankOrder` field is `ASCENDING`, higher numbers are better. For example, a document with a rating score of 10 is higher ranking than a document with a rating score of 1.
When the `RankOrder` field is `DESCENDING`, lower numbers are better. For example, in a task tracking application, a priority 1 task is more important than a priority 5 task.
Only applies to `LONG` fields.
Type: String
Valid Values: `ASCENDING | DESCENDING`
Required: No
** ValueImportanceMap **
A list of values that should be given a different boost when they appear in the result list. For example, if you are boosting a field called "department", query terms that match the department field are boosted in the result. However, you can add entries from the department field to boost documents with those values higher.
For example, you can add entries to the map with names of departments. If you add "HR",5 and "Legal",3 those departments are given special attention when they appear in the metadata of a document. When those terms appear they are given the specified importance instead of the regular importance for the boost.
Type: String to integer map
Key Length Constraints: Minimum length of 1. Maximum length of 50.
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/Relevance)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/Relevance)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/Relevance)
# RelevanceFeedback
Provides feedback on how relevant a document is to a search. Your application uses the `SubmitFeedback` API to provide relevance information.
## Contents
** RelevanceValue **
Whether the document was relevant or not relevant to the search.
Type: String
Valid Values: `RELEVANT | NOT_RELEVANT`
Required: Yes
** ResultId **
The identifier of the search result that the user provided relevance feedback for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 73.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/RelevanceFeedback)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/RelevanceFeedback)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/RelevanceFeedback)
# RetrieveResultItem
A single retrieved relevant passage result.
## Contents
** Content **
The contents of the relevant passage.
Type: String
Required: No
** DocumentAttributes **
An array of document fields/attributes assigned to a document in the search results. For example, the document author (`_author`) or the source URI (`_source_uri`) of the document.
Type: Array of [DocumentAttribute](API_DocumentAttribute.md) objects
Required: No
** DocumentId **
The identifier of the document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** DocumentTitle **
The title of the document.
Type: String
Required: No
** DocumentURI **
The URI of the original location of the document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^(https?|ftp|file):\/\/([^\s]*)`
Required: No
** Id **
The identifier of the relevant passage result.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 73.
Required: No
** ScoreAttributes **
The confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.
Type: [ScoreAttributes](API_ScoreAttributes.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/RetrieveResultItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/RetrieveResultItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/RetrieveResultItem)
# S3DataSourceConfiguration
Provides the configuration information to connect to an Amazon S3 bucket.
**Note**
Amazon Kendra now supports an upgraded Amazon S3 connector.
You must now use the [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) object instead of the `S3DataSourceConfiguration` object to configure your connector.
Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.
We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.
## Contents
** BucketName **
The name of the bucket that contains the documents.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern: `[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`
Required: Yes
** AccessControlListConfiguration **
Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see [Access control for S3 data sources](https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html).
Type: [AccessControlListConfiguration](API_AccessControlListConfiguration.md) object
Required: No
** DocumentsMetadataConfiguration **
Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.
Type: [DocumentsMetadataConfiguration](API_DocumentsMetadataConfiguration.md) object
Required: No
** ExclusionPatterns **
A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to exclude from your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:
+ */myapp/config/\$1*—All files inside config directory.
+ *\$1\$1/\$1.png*—All .png files in all directories.
+ *\$1\$1/\$1.\$1png, ico, md\$1*—All .png, .ico or .md files in all directories.
+ */myapp/src/\$1\$1/\$1.ts*—All .ts files inside src directory (and all its subdirectories).
+ *\$1\$1/\$1(\$1.module).ts*—All .ts files but not .module.ts
+ *\$1.png , \$1.jpg*—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
+ *\$1internal\$1*—All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal\$1only', 'company\$1internal'.
+ *\$1\$1/\$1internal\$1*—All internal-related files in a directory and its subdirectories.
For more examples, see [Use of Exclude and Include Filters](https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters) in the AWS CLI Command Reference.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** InclusionPatterns **
A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to include in your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:
+ */myapp/config/\$1*—All files inside config directory.
+ *\$1\$1/\$1.png*—All .png files in all directories.
+ *\$1\$1/\$1.\$1png, ico, md\$1*—All .png, .ico or .md files in all directories.
+ */myapp/src/\$1\$1/\$1.ts*—All .ts files inside src directory (and all its subdirectories).
+ *\$1\$1/\$1(\$1.module).ts*—All .ts files but not .module.ts
+ *\$1.png , \$1.jpg*—All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
+ *\$1internal\$1*—All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal\$1only', 'company\$1internal'.
+ *\$1\$1/\$1internal\$1*—All internal-related files in a directory and its subdirectories.
For more examples, see [Use of Exclude and Include Filters](https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters) in the AWS CLI Command Reference.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** InclusionPrefixes **
A list of S3 prefixes for the documents that should be included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/S3DataSourceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/S3DataSourceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/S3DataSourceConfiguration)
# S3Path
Information required to find a specific file in an Amazon S3 bucket.
## Contents
** Bucket **
The name of the S3 bucket that contains the file.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern: `[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`
Required: Yes
** Key **
The name of the file.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/S3Path)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/S3Path)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/S3Path)
# SaaSConfiguration
Provides the configuration information to connect to GitHub Enterprise Cloud (SaaS).
## Contents
** HostUrl **
The GitHub host URL or API endpoint URL. For example, *https://api.github.com*.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^(https?|ftp|file):\/\/([^\s]*)`
Required: Yes
** OrganizationName **
The name of the organization of the GitHub Enterprise Cloud (SaaS) account you want to connect to. You can find your organization name by logging into GitHub desktop and selecting **Your organizations** under your profile picture dropdown.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 60.
Pattern: `^[A-Za-z0-9_.-]+$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SaaSConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SaaSConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SaaSConfiguration)
# SalesforceChatterFeedConfiguration
The configuration information for syncing a Salesforce chatter feed. The contents of the object comes from the Salesforce FeedItem table.
## Contents
** DocumentDataFieldName **
The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the `Body` column.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_.]*$`
Required: Yes
** DocumentTitleFieldName **
The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the `Title` column.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_.]*$`
Required: No
** FieldMappings **
Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** IncludeFilterTypes **
Filters the documents in the feed based on status of the user. When you specify `ACTIVE_USERS` only documents from users who have an active account are indexed. When you specify `STANDARD_USER` only documents for Salesforce standard users are documented. You can specify both.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Valid Values: `ACTIVE_USER | STANDARD_USER`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SalesforceChatterFeedConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SalesforceChatterFeedConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SalesforceChatterFeedConfiguration)
# SalesforceConfiguration
Provides the configuration information to connect to Salesforce as your data source.
## Contents
** SecretArn **
The Amazon Resource Name (ARN) of an AWS Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:
+ authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
+ consumerKey - The application public key generated when you created your Salesforce application.
+ consumerSecret - The application private key generated when you created your Salesforce application.
+ password - The password associated with the user logging in to the Salesforce instance.
+ securityToken - The token associated with the user logging in to the Salesforce instance.
+ username - The user name of the user logging in to the Salesforce instance.
Type: String
Length Constraints: Minimum length of 1. 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
** ServerUrl **
The instance URL for the Salesforce site that you want to index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^(https?|ftp|file):\/\/([^\s]*)`
Required: Yes
** ChatterFeedConfiguration **
Configuration information for Salesforce chatter feeds.
Type: [SalesforceChatterFeedConfiguration](API_SalesforceChatterFeedConfiguration.md) object
Required: No
** CrawlAttachments **
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
Type: Boolean
Required: No
** ExcludeAttachmentFilePatterns **
A list of regular expression patterns to exclude certain documents in your Salesforce. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** IncludeAttachmentFilePatterns **
A list of regular expression patterns to include certain documents in your Salesforce. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** KnowledgeArticleConfiguration **
Configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.
Type: [SalesforceKnowledgeArticleConfiguration](API_SalesforceKnowledgeArticleConfiguration.md) object
Required: No
** StandardObjectAttachmentConfiguration **
Configuration information for processing attachments to Salesforce standard objects.
Type: [SalesforceStandardObjectAttachmentConfiguration](API_SalesforceStandardObjectAttachmentConfiguration.md) object
Required: No
** StandardObjectConfigurations **
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
Type: Array of [SalesforceStandardObjectConfiguration](API_SalesforceStandardObjectConfiguration.md) objects
Array Members: Minimum number of 1 item. Maximum number of 17 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SalesforceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SalesforceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SalesforceConfiguration)
# SalesforceCustomKnowledgeArticleTypeConfiguration
Provides the configuration information for indexing Salesforce custom articles.
## Contents
** DocumentDataFieldName **
The name of the field in the custom knowledge article that contains the document data to index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_.]*$`
Required: Yes
** Name **
The name of the configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*$`
Required: Yes
** DocumentTitleFieldName **
The name of the field in the custom knowledge article that contains the document title.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_.]*$`
Required: No
** FieldMappings **
Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Salesforce fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Salesforce data source field names must exist in your Salesforce custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SalesforceCustomKnowledgeArticleTypeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SalesforceCustomKnowledgeArticleTypeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SalesforceCustomKnowledgeArticleTypeConfiguration)
# SalesforceKnowledgeArticleConfiguration
Provides the configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both
## Contents
** IncludedStates **
Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 3 items.
Valid Values: `DRAFT | PUBLISHED | ARCHIVED`
Required: Yes
** CustomKnowledgeArticleTypeConfigurations **
Configuration information for custom Salesforce knowledge articles.
Type: Array of [SalesforceCustomKnowledgeArticleTypeConfiguration](API_SalesforceCustomKnowledgeArticleTypeConfiguration.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
** StandardKnowledgeArticleTypeConfiguration **
Configuration information for standard Salesforce knowledge articles.
Type: [SalesforceStandardKnowledgeArticleTypeConfiguration](API_SalesforceStandardKnowledgeArticleTypeConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SalesforceKnowledgeArticleConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SalesforceKnowledgeArticleConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SalesforceKnowledgeArticleConfiguration)
# SalesforceStandardKnowledgeArticleTypeConfiguration
Provides the configuration information for standard Salesforce knowledge articles.
## Contents
** DocumentDataFieldName **
The name of the field that contains the document data to index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_.]*$`
Required: Yes
** DocumentTitleFieldName **
The name of the field that contains the document title.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_.]*$`
Required: No
** FieldMappings **
Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Salesforce fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Salesforce data source field names must exist in your Salesforce custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SalesforceStandardKnowledgeArticleTypeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SalesforceStandardKnowledgeArticleTypeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SalesforceStandardKnowledgeArticleTypeConfiguration)
# SalesforceStandardObjectAttachmentConfiguration
Provides the configuration information for processing attachments to Salesforce standard objects.
## Contents
** DocumentTitleFieldName **
The name of the field used for the document title.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_.]*$`
Required: No
** FieldMappings **
One or more objects that map fields in attachments to Amazon Kendra index fields.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SalesforceStandardObjectAttachmentConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SalesforceStandardObjectAttachmentConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SalesforceStandardObjectAttachmentConfiguration)
# SalesforceStandardObjectConfiguration
Provides the configuration information for indexing a single standard object.
## Contents
** DocumentDataFieldName **
The name of the field in the standard object table that contains the document contents.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_.]*$`
Required: Yes
** Name **
The name of the standard object.
Type: String
Valid Values: `ACCOUNT | CAMPAIGN | CASE | CONTACT | CONTRACT | DOCUMENT | GROUP | IDEA | LEAD | OPPORTUNITY | PARTNER | PRICEBOOK | PRODUCT | PROFILE | SOLUTION | TASK | USER`
Required: Yes
** DocumentTitleFieldName **
The name of the field in the standard object table that contains the document title.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_.]*$`
Required: No
** FieldMappings **
Maps attributes or field names of the standard object to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Salesforce fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Salesforce data source field names must exist in your Salesforce custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SalesforceStandardObjectConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SalesforceStandardObjectConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SalesforceStandardObjectConfiguration)
# ScoreAttributes
Provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.
## Contents
** ScoreConfidence **
A relative ranking for how relevant the response is to the query.
Type: String
Valid Values: `VERY_HIGH | HIGH | MEDIUM | LOW | NOT_AVAILABLE`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ScoreAttributes)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ScoreAttributes)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ScoreAttributes)
# Search
Provides information about how a custom index field is used during a search.
## Contents
** Displayable **
Determines whether the field is returned in the query response. The default is `true`.
Type: Boolean
Required: No
** Facetable **
Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is `false` .
Type: Boolean
Required: No
** Searchable **
Determines whether the field is used in the search. If the `Searchable` field is `true`, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is `true` for string fields and `false` for number and date fields.
Type: Boolean
Required: No
** Sortable **
Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have `Sortable` set to `true`, Amazon Kendra returns an exception. The default is `false`.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/Search)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/Search)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/Search)
# SeedUrlConfiguration
Provides the configuration information for the seed or starting point URLs to crawl.
*When selecting websites to index, you must adhere to the [Amazon Acceptable Use Policy](https://aws.amazon.com/aup/) and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own web pages, or web pages that you have authorization to index.*
## Contents
** SeedUrls **
The list of seed or starting point URLs of the websites you want to crawl.
The list can include a maximum of 100 seed URLs.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^(https?):\/\/([^\s]*)`
Required: Yes
** WebCrawlerMode **
You can choose one of the following modes:
+ `HOST_ONLY`—crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.
+ `SUBDOMAINS`—crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.
+ `EVERYTHING`—crawl the website host names with subdomains and other domains that the web pages link to.
The default mode is set to `HOST_ONLY`.
Type: String
Valid Values: `HOST_ONLY | SUBDOMAINS | EVERYTHING`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SeedUrlConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SeedUrlConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SeedUrlConfiguration)
# ServerSideEncryptionConfiguration
Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric keys.
## Contents
** KmsKeyId **
The identifier of the AWS KMS key. Amazon Kendra doesn't support asymmetric keys.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ServerSideEncryptionConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ServerSideEncryptionConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ServerSideEncryptionConfiguration)
# ServiceNowConfiguration
Provides the configuration information to connect to ServiceNow as your data source.
## Contents
** HostUrl **
The ServiceNow instance that the data source connects to. The host endpoint should look like the following: *\$1instance\$1.service-now.com.*
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^(?!(^(https?|ftp|file):\/\/))[a-z0-9-]+(\.service-now\.com)$`
Required: Yes
** SecretArn **
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see [Using a ServiceNow data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html).
Type: String
Length Constraints: Minimum length of 1. 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
** ServiceNowBuildVersion **
The identifier of the release that the ServiceNow host is running. If the host is not running the `LONDON` release, use `OTHERS`.
Type: String
Valid Values: `LONDON | OTHERS`
Required: Yes
** AuthenticationType **
The type of authentication used to connect to the ServiceNow instance. If you choose `HTTP_BASIC`, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the `SecretArn` field. If you choose `OAUTH2`, Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password.
When you use `OAUTH2` authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see [Using a ServiceNow data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html).
Type: String
Valid Values: `HTTP_BASIC | OAUTH2`
Required: No
** KnowledgeArticleConfiguration **
Configuration information for crawling knowledge articles in the ServiceNow site.
Type: [ServiceNowKnowledgeArticleConfiguration](API_ServiceNowKnowledgeArticleConfiguration.md) object
Required: No
** ServiceCatalogConfiguration **
Configuration information for crawling service catalogs in the ServiceNow site.
Type: [ServiceNowServiceCatalogConfiguration](API_ServiceNowServiceCatalogConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ServiceNowConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ServiceNowConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ServiceNowConfiguration)
# ServiceNowKnowledgeArticleConfiguration
Provides the configuration information for crawling knowledge articles in the ServiceNow site.
## Contents
** DocumentDataFieldName **
The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_.]*$`
Required: Yes
** CrawlAttachments **
`TRUE` to index attachments to knowledge articles.
Type: Boolean
Required: No
** DocumentTitleFieldName **
The name of the ServiceNow field that is mapped to the index document title field.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_.]*$`
Required: No
** ExcludeAttachmentFilePatterns **
A list of regular expression patterns applied to exclude certain knowledge article attachments. Attachments that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** FieldMappings **
Maps attributes or field names of knoweldge articles to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to ServiceNow fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The ServiceNow data source field names must exist in your ServiceNow custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** FilterQuery **
A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.
The query string must be one generated by the ServiceNow console. For more information, see [Specifying documents to index with a query](https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
Required: No
** IncludeAttachmentFilePatterns **
A list of regular expression patterns applied to include knowledge article attachments. Attachments that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ServiceNowKnowledgeArticleConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ServiceNowKnowledgeArticleConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ServiceNowKnowledgeArticleConfiguration)
# ServiceNowServiceCatalogConfiguration
Provides the configuration information for crawling service catalog items in the ServiceNow site
## Contents
** DocumentDataFieldName **
The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_.]*$`
Required: Yes
** CrawlAttachments **
`TRUE` to index attachments to service catalog items.
Type: Boolean
Required: No
** DocumentTitleFieldName **
The name of the ServiceNow field that is mapped to the index document title field.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_.]*$`
Required: No
** ExcludeAttachmentFilePatterns **
A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
The regex is applied to the file name of the attachment.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** FieldMappings **
Maps attributes or field names of catalogs to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to ServiceNow fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The ServiceNow data source field names must exist in your ServiceNow custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** IncludeAttachmentFilePatterns **
A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
The regex is applied to the file name of the attachment.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ServiceNowServiceCatalogConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ServiceNowServiceCatalogConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ServiceNowServiceCatalogConfiguration)
# SharePointConfiguration
Provides the configuration information to connect to Microsoft SharePoint as your data source.
## Contents
** SecretArn **
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. For more information, see [Microsoft SharePoint](https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html).
Type: String
Length Constraints: Minimum length of 1. 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
** SharePointVersion **
The version of Microsoft SharePoint that you use.
Type: String
Valid Values: `SHAREPOINT_2013 | SHAREPOINT_2016 | SHAREPOINT_ONLINE | SHAREPOINT_2019`
Required: Yes
** Urls **
The Microsoft SharePoint site URLs for the documents you want to index.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^(https?|ftp|file):\/\/([^\s]*)`
Required: Yes
** AuthenticationType **
Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.
Type: String
Valid Values: `HTTP_BASIC | OAUTH2`
Required: No
** CrawlAttachments **
`TRUE` to index document attachments.
Type: Boolean
Required: No
** DisableLocalGroups **
`TRUE` to disable local groups information.
Type: Boolean
Required: No
** DocumentTitleFieldName **
The Microsoft SharePoint attribute field that contains the title of the document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `^[a-zA-Z][a-zA-Z0-9_.]*$`
Required: No
** ExclusionPatterns **
A list of regular expression patterns to exclude certain documents in your SharePoint. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The regex applies to the display URL of the SharePoint document.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** FieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to SharePoint fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The SharePoint data source field names must exist in your SharePoint custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** InclusionPatterns **
A list of regular expression patterns to include certain documents in your SharePoint. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The regex applies to the display URL of the SharePoint document.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** ProxyConfiguration **
Configuration information to connect to your Microsoft SharePoint site URLs via instance via a web proxy. You can use this option for SharePoint Server.
You must provide the website host name and port number. For example, the host name of *https://a.example.com/page1.html* is "a.example.com" and the port is 443, the standard port for HTTPS.
Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in AWS Secrets Manager.
It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.
Type: [ProxyConfiguration](API_ProxyConfiguration.md) object
Required: No
** SslCertificateS3Path **
The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint Server if you require a secure SSL connection.
You can generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see [Create and sign an X509 certificate](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html).
Type: [S3Path](API_S3Path.md) object
Required: No
** UseChangeLog **
`TRUE` to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.
Type: Boolean
Required: No
** VpcConfiguration **
Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint. For more information, see [Configuring a VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
Type: [DataSourceVpcConfiguration](API_DataSourceVpcConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SharePointConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SharePointConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SharePointConfiguration)
# SiteMapsConfiguration
Provides the configuration information for the sitemap URLs to crawl.
*When selecting websites to index, you must adhere to the [Amazon Acceptable Use Policy](https://aws.amazon.com/aup/) and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own web pages, or web pages that you have authorization to index.*
## Contents
** SiteMaps **
The list of sitemap URLs of the websites you want to crawl.
The list can include a maximum of three sitemap URLs.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 3 items.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^(https?):\/\/([^\s]*)`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SiteMapsConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SiteMapsConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SiteMapsConfiguration)
# SlackConfiguration
Provides the configuration information to connect to Slack as your data source.
**Note**
Amazon Kendra now supports an upgraded Slack connector.
You must now use the [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) object instead of the `SlackConfiguration` object to configure your connector.
Connectors configured using the older console and API architecture will continue to function as configured. However, you won’t be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.
We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.
## Contents
** SecretArn **
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key-value pairs required to connect to your Slack workspace team. The secret must contain a JSON structure with the following keys:
+ slackToken—The user or bot token created in Slack. For more information on creating a token in Slack, see [Authentication for a Slack data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html#slack-authentication).
Type: String
Length Constraints: Minimum length of 1. 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
** SinceCrawlDate **
The date to start crawling your data from your Slack workspace team. The date must follow this format: `yyyy-mm-dd`.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `(20\d{2})-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])`
Required: Yes
** SlackEntityList **
Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 4 items.
Valid Values: `PUBLIC_CHANNEL | PRIVATE_CHANNEL | GROUP_MESSAGE | DIRECT_MESSAGE`
Required: Yes
** TeamId **
The identifier of the team in the Slack workspace. For example, *T0123456789*.
You can find your team ID in the URL of the main page of your Slack workspace. When you log in to Slack via a browser, you are directed to the URL of the main page. For example, *https://app.slack.com/client/**T0123456789**/...*.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Z0-9]*`
Required: Yes
** CrawlBotMessage **
`TRUE` to index bot messages from your Slack workspace team.
Type: Boolean
Required: No
** ExcludeArchived **
`TRUE` to exclude archived messages to index from your Slack workspace team.
Type: Boolean
Required: No
** ExclusionPatterns **
A list of regular expression patterns to exclude certain attached files in your Slack workspace team. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** FieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map Slack data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Slack fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Slack data source field names must exist in your Slack custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** InclusionPatterns **
A list of regular expression patterns to include certain attached files in your Slack workspace team. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** LookBackPeriod **
The number of hours for change log to look back from when you last synchronized your data. You can look back up to 7 days or 168 hours.
Change log updates your index only if new content was added since you last synced your data. Updated or deleted content from before you last synced does not get updated in your index. To capture updated or deleted content before you last synced, set the `LookBackPeriod` to the number of hours you want change log to look back.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 168.
Required: No
** PrivateChannelFilter **
The list of private channel names from your Slack workspace team. You use this if you want to index specific private channels, not all private channels. You can also use regular expression patterns to filter private channels.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** PublicChannelFilter **
The list of public channel names to index from your Slack workspace team. You use this if you want to index specific public channels, not all public channels. You can also use regular expression patterns to filter public channels.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** UseChangeLog **
`TRUE` to use the Slack change log to determine which documents require updating in the index. Depending on the Slack change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Slack.
Type: Boolean
Required: No
** VpcConfiguration **
Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. For more information, see [Configuring a VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
Type: [DataSourceVpcConfiguration](API_DataSourceVpcConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SlackConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SlackConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SlackConfiguration)
# SortingConfiguration
Specifies the document attribute to use to sort the response to a Amazon Kendra query. You can specify a single attribute for sorting. The attribute must have the `Sortable` flag set to `true`, otherwise Amazon Kendra returns an exception.
You can sort attributes of the following types.
+ Date value
+ Long value
+ String value
You can't sort attributes of the following type.
+ String list value
## Contents
** DocumentAttributeKey **
The name of the document attribute used to sort the response. You can use any field that has the `Sortable` flag set to true.
You can also sort by any of the following built-in attributes:
+ \$1category
+ \$1created\$1at
+ \$1last\$1updated\$1at
+ \$1version
+ \$1view\$1count
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `[a-zA-Z0-9_][a-zA-Z0-9_-]*`
Required: Yes
** SortOrder **
The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.
Type: String
Valid Values: `DESC | ASC`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SortingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SortingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SortingConfiguration)
# SourceDocument
The document ID and its fields/attributes that are used for a query suggestion, if document fields set to use for query suggestions.
## Contents
** AdditionalAttributes **
The additional fields/attributes to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.
Type: Array of [DocumentAttribute](API_DocumentAttribute.md) objects
Required: No
** DocumentId **
The identifier of the document used for a query suggestion.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** SuggestionAttributes **
The document fields/attributes used for a query suggestion.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `[a-zA-Z0-9_][a-zA-Z0-9_-]*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SourceDocument)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SourceDocument)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SourceDocument)
# SpellCorrectedQuery
A query with suggested spell corrections.
## Contents
** Corrections **
The corrected misspelled word or words in a query.
Type: Array of [Correction](API_Correction.md) objects
Required: No
** SuggestedQueryText **
The query with the suggested spell corrections.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SpellCorrectedQuery)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SpellCorrectedQuery)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SpellCorrectedQuery)
# SpellCorrectionConfiguration
Provides the configuration information for suggested query spell corrections.
Suggested spell corrections are based on words that appear in your indexed documents and how closely a corrected word matches a misspelled word.
This feature is designed with certain defaults or limits. For information on the current limits and how to request more support for some limits, see the [Spell Checker documentation](https://docs.aws.amazon.com/kendra/latest/dg/query-spell-check.html).
## Contents
** IncludeQuerySpellCheckSuggestions **
`TRUE` to suggest spell corrections for queries.
Type: Boolean
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SpellCorrectionConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SpellCorrectionConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SpellCorrectionConfiguration)
# SqlConfiguration
Provides the configuration information to use a SQL database.
## Contents
** QueryIdentifiersEnclosingOption **
Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query.
By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.
PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case.
For MySQL databases, you must enable the `ansi_quotes` option when you set this field to `DOUBLE_QUOTES`.
Type: String
Valid Values: `DOUBLE_QUOTES | NONE`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SqlConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SqlConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SqlConfiguration)
# Status
Provides information about the status of documents submitted for indexing.
## Contents
** DocumentId **
The identifier of the document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** DocumentStatus **
The current status of a document.
If the document was submitted for deletion, the status is `NOT_FOUND` after the document is deleted.
Type: String
Valid Values: `NOT_FOUND | PROCESSING | INDEXED | UPDATED | FAILED | UPDATE_FAILED`
Required: No
** FailureCode **
Indicates the source of the error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** FailureReason **
Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/Status)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/Status)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/Status)
# SuggestableConfig
Provides the configuration information for a document field/attribute that you want to base query suggestions on.
## Contents
** AttributeName **
The name of the document field/attribute.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `[a-zA-Z0-9_][a-zA-Z0-9_-]*`
Required: No
** Suggestable **
`TRUE` means the document field/attribute is suggestible, so the contents within the field can be used for query suggestions.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SuggestableConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SuggestableConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SuggestableConfig)
# Suggestion
A single query suggestion.
## Contents
** Id **
The UUID (universally unique identifier) of a single query suggestion.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 73.
Required: No
** SourceDocuments **
The list of document IDs and their fields/attributes that are used for a single query suggestion, if document fields set to use for query suggestions.
Type: Array of [SourceDocument](API_SourceDocument.md) objects
Required: No
** Value **
The value for the UUID (universally unique identifier) of a single query suggestion.
The value is the text string of a suggestion.
Type: [SuggestionValue](API_SuggestionValue.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/Suggestion)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/Suggestion)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/Suggestion)
# SuggestionHighlight
The text highlights for a single query suggestion.
## Contents
** BeginOffset **
The zero-based location in the response string where the highlight starts.
Type: Integer
Required: No
** EndOffset **
The zero-based location in the response string where the highlight ends.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SuggestionHighlight)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SuggestionHighlight)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SuggestionHighlight)
# SuggestionTextWithHighlights
Provides text and information about where to highlight the query suggestion text.
## Contents
** Highlights **
The beginning and end of the query suggestion text that should be highlighted.
Type: Array of [SuggestionHighlight](API_SuggestionHighlight.md) objects
Required: No
** Text **
The query suggestion text to display to the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SuggestionTextWithHighlights)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SuggestionTextWithHighlights)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SuggestionTextWithHighlights)
# SuggestionValue
The `SuggestionTextWithHighlights` structure information.
## Contents
** Text **
The `SuggestionTextWithHighlights` structure that contains the query suggestion text and highlights.
Type: [SuggestionTextWithHighlights](API_SuggestionTextWithHighlights.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/SuggestionValue)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/SuggestionValue)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/SuggestionValue)
# TableCell
Provides information about a table cell in a table excerpt.
## Contents
** Header **
`TRUE` means that the table cell should be treated as a header.
Type: Boolean
Required: No
** Highlighted **
`TRUE` means that the table cell has a high enough confidence and is relevant to the query, so the value or content should be highlighted.
Type: Boolean
Required: No
** TopAnswer **
`TRUE` if the response of the table cell is the top answer. This is the cell value or content with the highest confidence score or is the most relevant to the query.
Type: Boolean
Required: No
** Value **
The actual value or content within a table cell. A table cell could contain a date value of a year, or a string value of text, for example.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/TableCell)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/TableCell)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/TableCell)
# TableExcerpt
An excerpt from a table within a document. The table excerpt displays up to five columns and three rows, depending on how many table cells are relevant to the query and how many columns are available in the original table. The top most relevant cell is displayed in the table excerpt, along with the next most relevant cells.
## Contents
** Rows **
A list of rows in the table excerpt.
Type: Array of [TableRow](API_TableRow.md) objects
Required: No
** TotalNumberOfRows **
A count of the number of rows in the original table within the document.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/TableExcerpt)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/TableExcerpt)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/TableExcerpt)
# TableRow
Information about a row in a table excerpt.
## Contents
** Cells **
A list of table cells in a row.
Type: Array of [TableCell](API_TableCell.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/TableRow)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/TableRow)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/TableRow)
# Tag
A key-value pair that identifies or categorizes an index, FAQ, data source, or other resource. TA tag key and value can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @.
## Contents
** Key **
The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, data source, or other resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
** Value **
The value associated with the tag. The value may be an empty string but it can't be null.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/Tag)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/Tag)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/Tag)
# TemplateConfiguration
Provides a template for the configuration information to connect to your data source.
## Contents
** Template **
The template schema used for the data source, where templates schemas are supported.
See [Data source template schemas](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html).
Type: JSON value
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/TemplateConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/TemplateConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/TemplateConfiguration)
# TextDocumentStatistics
Provides information about text documents indexed in an index.
## Contents
** IndexedTextBytes **
The total size, in bytes, of the indexed documents.
Type: Long
Valid Range: Minimum value of 0.
Required: Yes
** IndexedTextDocumentsCount **
The number of text documents indexed.
Type: Integer
Valid Range: Minimum value of 0.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/TextDocumentStatistics)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/TextDocumentStatistics)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/TextDocumentStatistics)
# TextWithHighlights
Provides text and information about where to highlight the text.
## Contents
** Highlights **
The beginning and end of the text that should be highlighted.
Type: Array of [Highlight](API_Highlight.md) objects
Required: No
** Text **
The text to display to the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/TextWithHighlights)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/TextWithHighlights)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/TextWithHighlights)
# ThesaurusSummary
An array of summary information for a thesaurus or multiple thesauri.
## Contents
** CreatedAt **
The Unix timestamp when the thesaurus was created.
Type: Timestamp
Required: No
** Id **
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_-]*`
Required: No
** Name **
The name of the thesaurus.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** Status **
The status of the thesaurus.
Type: String
Valid Values: `CREATING | ACTIVE | DELETING | UPDATING | ACTIVE_BUT_UPDATE_FAILED | FAILED`
Required: No
** UpdatedAt **
The Unix timestamp when the thesaurus was last updated.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ThesaurusSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ThesaurusSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ThesaurusSummary)
# TimeRange
Provides a range of time.
## Contents
** EndTime **
The Unix timestamp for the end of the time range.
Type: Timestamp
Required: No
** StartTime **
The Unix timestamp for the beginning of the time range.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/TimeRange)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/TimeRange)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/TimeRange)
# Urls
Provides the configuration information of the URLs to crawl.
You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.
*When selecting websites to index, you must adhere to the [Amazon Acceptable Use Policy](https://aws.amazon.com/aup/) and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own web pages, or web pages that you have authorization to index.*
## Contents
** SeedUrlConfiguration **
Configuration of the seed or starting point URLs of the websites you want to crawl.
You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the web pages link to.
You can list up to 100 seed URLs.
Type: [SeedUrlConfiguration](API_SeedUrlConfiguration.md) object
Required: No
** SiteMapsConfiguration **
Configuration of the sitemap URLs of the websites you want to crawl.
Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.
Type: [SiteMapsConfiguration](API_SiteMapsConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/Urls)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/Urls)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/Urls)
# UserContext
Provides information about the user context for an Amazon Kendra index.
User context filtering is a kind of personalized search with the benefit of controlling access to documents. For example, not all teams that search the company portal for information should access top-secret company documents, nor are these documents relevant to all users. Only specific users or groups of teams given access to top-secret documents should see these documents in their search results.
You provide one of the following:
+ User token
+ User ID, the groups the user belongs to, and any data sources the groups can access.
If you provide both, an exception is thrown.
**Important**
If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can use `UserId`, `Groups`, and `DataSourceGroups` to filter content. If you set the `UserId` to a particular user ID, it also includes all public documents.
Amazon Kendra Gen AI Enterprise Edition indices don't support token based document filtering. If you're using an Amazon Kendra Gen AI Enterprise Edition index, Amazon Kendra returns a `ValidationException` error if the `Token` field has a non-null value.
## Contents
** DataSourceGroups **
The list of data source groups you want to filter search results based on groups' access to documents in that data source.
Type: Array of [DataSourceGroup](API_DataSourceGroup.md) objects
Array Members: Minimum number of 1 item. Maximum number of 2048 items.
Required: No
** Groups **
The list of groups you want to filter search results based on the groups' access to documents.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 2048 items.
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `^\P{C}*$`
Required: No
** Token **
The user context token for filtering search results for a user. It must be a JWT or a JSON token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100000.
Pattern: `^\P{C}*$`
Required: No
** UserId **
The identifier of the user you want to filter search results based on their access to documents.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `^\P{C}*$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/UserContext)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/UserContext)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/UserContext)
# UserGroupResolutionConfiguration
Provides the configuration information to get users and groups from an AWS IAM Identity Center identity source. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can also use the [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) API to map users to their groups so that you only need to provide the user ID when you issue the query.
To set up an IAM Identity Center identity source in the console to use with Amazon Kendra, see [Getting started with an IAM Identity Center identity source](https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html). You must also grant the required permissions to use IAM Identity Center with Amazon Kendra. For more information, see [IAM roles for IAM Identity Center](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-aws-sso).
Amazon Kendra currently does not support using `UserGroupResolutionConfiguration` with an AWS organization member account for your IAM Identity Center identify source. You must create your index in the management account for the organization in order to use `UserGroupResolutionConfiguration`.
**Important**
If you're using an Amazon Kendra Gen AI Enterprise Edition index, `UserGroupResolutionConfiguration` isn't supported.
## Contents
** UserGroupResolutionMode **
The identity store provider (mode) you want to use to get users and groups. AWS IAM Identity Center is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.
Type: String
Valid Values: `AWS_SSO | NONE`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/UserGroupResolutionConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/UserGroupResolutionConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/UserGroupResolutionConfiguration)
# UserIdentityConfiguration
Provides the configuration information for the identifiers of your users.
## Contents
** IdentityAttributeName **
The IAM Identity Center field name that contains the identifiers of your users, such as their emails. This is used for [user context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html) and for granting access to your Amazon Kendra experience. You must set up IAM Identity Center with Amazon Kendra. You must include your users and groups in your Access Control List when you ingest documents into your index. For more information, see [Getting started with an IAM Identity Center identity source](https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/UserIdentityConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/UserIdentityConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/UserIdentityConfiguration)
# UserTokenConfiguration
Provides the configuration information for a token.
**Important**
If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use `UserTokenConfigurations` to configure user context policy, Amazon Kendra returns a `ValidationException` error.
## Contents
** JsonTokenTypeConfiguration **
Information about the JSON token type configuration.
Type: [JsonTokenTypeConfiguration](API_JsonTokenTypeConfiguration.md) object
Required: No
** JwtTokenTypeConfiguration **
Information about the JWT token type configuration.
Type: [JwtTokenTypeConfiguration](API_JwtTokenTypeConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/UserTokenConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/UserTokenConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/UserTokenConfiguration)
# Warning
The warning code and message that explains a problem with a query.
## Contents
** Code **
The code used to show the type of warning for the query.
Type: String
Valid Values: `QUERY_LANGUAGE_INVALID_SYNTAX`
Required: No
** Message **
The message that explains the problem with the query.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/Warning)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/Warning)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/Warning)
# WebCrawlerConfiguration
Provides the configuration information required for Amazon Kendra Web Crawler.
## Contents
** Urls **
Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.
You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.
You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.
*When selecting websites to index, you must adhere to the [Amazon Acceptable Use Policy](https://aws.amazon.com/aup/) and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own web pages, or web pages that you have authorization to index.*
Type: [Urls](API_Urls.md) object
Required: Yes
** AuthenticationConfiguration **
Configuration information required to connect to websites using authentication.
You can connect to websites using basic authentication of user name and password. You use a secret in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) to store your authentication credentials.
You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.
Type: [AuthenticationConfiguration](API_AuthenticationConfiguration.md) object
Required: No
** CrawlDepth **
The 'depth' or number of levels from the seed level to crawl. For example, the seed URL page is depth 1 and any hyperlinks on this page that are also crawled are depth 2.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 10.
Required: No
** MaxContentSizePerPageInMegaBytes **
The maximum size (in MB) of a web page or attachment to crawl.
Files larger than this size (in MB) are skipped/not crawled.
The default maximum size of a web page or attachment is set to 50 MB.
Type: Float
Valid Range: Minimum value of 1.0e-06. Maximum value of 50.
Required: No
** MaxLinksPerPage **
The maximum number of URLs on a web page to include when crawling a website. This number is per web page.
As a website’s web pages are crawled, any URLs the web pages link to are also crawled. URLs on a web page are crawled in order of appearance.
The default maximum links per page is 100.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** MaxUrlsPerMinuteCrawlRate **
The maximum number of URLs crawled per website host per minute.
A minimum of one URL is required.
The default maximum number of URLs crawled per website host per minute is 300.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 300.
Required: No
** ProxyConfiguration **
Configuration information required to connect to your internal websites via a web proxy.
You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.
Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html).
Type: [ProxyConfiguration](API_ProxyConfiguration.md) object
Required: No
** UrlExclusionPatterns **
A list of regular expression patterns to exclude certain URLs to crawl. URLs that match the patterns are excluded from the index. URLs that don't match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** UrlInclusionPatterns **
A list of regular expression patterns to include certain URLs to crawl. URLs that match the patterns are included in the index. URLs that don't match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/WebCrawlerConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/WebCrawlerConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/WebCrawlerConfiguration)
# WorkDocsConfiguration
Provides the configuration information to connect to WorkDocs as your data source.
WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland regions.
## Contents
** OrganizationId **
The identifier of the directory corresponding to your WorkDocs site repository.
You can find the organization ID in the [Directory Service](https://console.aws.amazon.com/directoryservicev2/) by going to **Active Directory**, then **Directories**. Your WorkDocs site directory has an ID, which is the organization ID. You can also set up a new WorkDocs directory in the Directory Service console and enable a WorkDocs site for the directory in the WorkDocs console.
Type: String
Length Constraints: Fixed length of 12.
Pattern: `d-[0-9a-fA-F]{10}`
Required: Yes
** CrawlComments **
`TRUE` to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.
The default is set to `FALSE`.
Type: Boolean
Required: No
** ExclusionPatterns **
A list of regular expression patterns to exclude certain files in your WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** FieldMappings **
A list of `DataSourceToIndexFieldMapping` objects that map WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to WorkDocs fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The WorkDocs data source field names must exist in your WorkDocs custom metadata.
Type: Array of [DataSourceToIndexFieldMapping](API_DataSourceToIndexFieldMapping.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** InclusionPatterns **
A list of regular expression patterns to include certain files in your WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
** UseChangeLog **
`TRUE` to use the WorkDocs change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in WorkDocs.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/WorkDocsConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/WorkDocsConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/WorkDocsConfiguration)
# Amazon Kendra Intelligent Ranking
The following data types are supported by Amazon Kendra Intelligent Ranking:
+ [CapacityUnitsConfiguration](API_Ranking_CapacityUnitsConfiguration.md)
+ [Document](API_Ranking_Document.md)
+ [RescoreExecutionPlanSummary](API_Ranking_RescoreExecutionPlanSummary.md)
+ [RescoreResultItem](API_Ranking_RescoreResultItem.md)
+ [Tag](API_Ranking_Tag.md)
# CapacityUnitsConfiguration
Sets additional capacity units configured for your rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the `Rescore` API. You can add and remove capacity units to fit your usage requirements.
## Contents
** RescoreCapacityUnits **
The amount of extra capacity for your rescore execution plan.
A single extra capacity unit for a rescore execution plan provides 0.01 rescore requests per second. You can add up to 1000 extra capacity units.
Type: Integer
Valid Range: Minimum value of 0.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-ranking-2022-10-19/CapacityUnitsConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-ranking-2022-10-19/CapacityUnitsConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-ranking-2022-10-19/CapacityUnitsConfiguration)
# Document
Information about a document from a search service such as OpenSearch (self managed). Amazon Kendra Intelligent Ranking uses this information to rank and score on.
## Contents
** Id **
The identifier of the document from the search service.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
** OriginalScore **
The original document score or rank from the search service. Amazon Kendra Intelligent Ranking gives the document a new score or rank based on its intelligent search algorithms.
Type: Float
Valid Range: Minimum value of -100000. Maximum value of 100000.
Required: Yes
** Body **
The body text of the search service's document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `^\P{C}*$`
Required: No
** GroupId **
The optional group identifier of the document from the search service. Documents with the same group identifier are grouped together and processed as one document within the service.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** Title **
The title of the search service's document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
** TokenizedBody **
The body text of the search service's document represented as a list of tokens or words. You must choose to provide `Body` or `TokenizedBody`. You cannot provide both.
Type: Array of strings
Array Members: Minimum number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** TokenizedTitle **
The title of the search service's document represented as a list of tokens or words. You must choose to provide `Title` or `TokenizedTitle`. You cannot provide both.
Type: Array of strings
Array Members: Minimum number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-ranking-2022-10-19/Document)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-ranking-2022-10-19/Document)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-ranking-2022-10-19/Document)
# RescoreExecutionPlanSummary
Summary information for a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the `Rescore` API.
## Contents
** CreatedAt **
The Unix timestamp when the rescore execution plan was created.
Type: Timestamp
Required: No
** Id **
The identifier of the rescore execution plan.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`
Required: No
** Name **
The name of the rescore execution plan.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`
Required: No
** Status **
The current status of the rescore execution plan. When the value is `ACTIVE`, the rescore execution plan is ready for use.
Type: String
Valid Values: `CREATING | UPDATING | ACTIVE | DELETING | FAILED`
Required: No
** UpdatedAt **
The Unix timestamp when the rescore execution plan was last updated.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-ranking-2022-10-19/RescoreExecutionPlanSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-ranking-2022-10-19/RescoreExecutionPlanSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-ranking-2022-10-19/RescoreExecutionPlanSummary)
# RescoreResultItem
A result item for a document with a new relevancy score.
## Contents
** DocumentId **
The identifier of the document from the search service.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** Score **
The relevancy score or rank that Amazon Kendra Intelligent Ranking gives to the result.
Type: Float
Valid Range: Minimum value of -100000. Maximum value of 100000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-ranking-2022-10-19/RescoreResultItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-ranking-2022-10-19/RescoreResultItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-ranking-2022-10-19/RescoreResultItem)
# Tag
A key-value pair that identifies or categorizes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the `Rescore` API. You can also use a tag to help control access to a rescore execution plan. A tag key and value can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @.
## Contents
** Key **
The key for the tag. Keys are not case sensitive and must be unique.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
** Value **
The value associated with the tag. The value can be an empty string but it can't be null.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-ranking-2022-10-19/Tag)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-ranking-2022-10-19/Tag)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-ranking-2022-10-19/Tag)
# Common Parameters
The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for that action. For more information about Signature Version 4, see [Signing AWS API requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) in the *IAM User Guide*.
**X-Amz-Algorithm**
The hash algorithm that you used to create the request signature.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Valid Values: `AWS4-HMAC-SHA256`
Required: Conditional
**X-Amz-Credential**
The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4\$1request"). The value is expressed in the following format: *access\$1key*/*YYYYMMDD*/*region*/*service*/aws4\$1request.
For more information, see [Create a signed AWS API request](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) in the *IAM User Guide*.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Required: Conditional
**X-Amz-Date**
The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: `20120325T120000Z`.
Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see [Elements of an AWS API request signature](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html) in the *IAM User Guide*.
Type: string
Required: Conditional
**X-Amz-Security-Token**
The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see [AWS services that work with IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) in the *IAM User Guide*.
Condition: If you're using temporary security credentials from AWS STS, you must include the security token.
Type: string
Required: Conditional
**X-Amz-Signature**
Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Required: Conditional
**X-Amz-SignedHeaders**
Specifies all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see [Create a signed AWS API request](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) in the *IAM User Guide*.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Required: Conditional
# Common Error Types
This section lists common error types that this AWS service may return. Not all services return all error types listed here. For errors specific to an API action for this service, see the topic for that API action.
**AccessDeniedException**
You don't have permission to perform this action. Verify that your IAM policy includes the required permissions.
HTTP Status Code: 403
**ExpiredTokenException**
The security token included in the request has expired. Request a new security token and try again.
HTTP Status Code: 403
**IncompleteSignature**
The request signature doesn't conform to AWS standards. Verify that you're using valid AWS credentials and that your request is properly formatted. If you're using an SDK, ensure it's up to date.
HTTP Status Code: 403
**InternalFailure**
The request can't be processed right now because of an internal server issue. Try again later. If the problem persists, contact AWS Support.
HTTP Status Code: 500
**MalformedHttpRequestException**
The request body can't be processed. This typically happens when the request body can't be decompressed using the specified content encoding algorithm. Verify that the content encoding header matches the compression format used.
HTTP Status Code: 400
**NotAuthorized**
You don't have permissions to perform this action. Verify that your IAM policy includes the required permissions.
HTTP Status Code: 401
**OptInRequired**
Your AWS account needs a subscription for this service. Verify that you've enabled the service in your account.
HTTP Status Code: 403
**RequestAbortedException**
The request was aborted before a response could be returned. This typically happens when the client closes the connection.
HTTP Status Code: 400
**RequestEntityTooLargeException**
The request entity is too large. Reduce the size of the request body and try again.
HTTP Status Code: 413
**RequestTimeoutException**
The request timed out. The server didn't receive the complete request within the expected time frame. Try again.
HTTP Status Code: 408
**ServiceUnavailable**
The service is temporarily unavailable. Try again later.
HTTP Status Code: 503
**ThrottlingException**
Your request rate is too high. The AWS SDKs automatically retry requests that receive this exception. Reduce the frequency of requests.
HTTP Status Code: 400
**UnknownOperationException**
The action or operation isn't recognized. Verify that the action name is spelled correctly and that it's supported by the API version you're using.
HTTP Status Code: 404
**UnrecognizedClientException**
The X.509 certificate or AWS access key ID you provided doesn't exist in our records. Verify that you're using valid credentials and that they haven't expired.
HTTP Status Code: 403
**ValidationError**
The input doesn't meet the required format or constraints. Check that all required parameters are included and that values are valid.
HTTP Status Code: 400