# 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)