AWSkendra (AWS SDK for Java

All Known Subinterfaces:

AWSkendraAsync

All Known Implementing Classes:

AbstractAWSkendra, AbstractAWSkendraAsync, AWSkendraAsyncClient, AWSkendraClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSkendra
```
Interface for accessing kendra.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSkendra instead.

Amazon Kendra is a service for indexing large document sets.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AssociateEntitiesToExperienceResult`	`associateEntitiesToExperience(AssociateEntitiesToExperienceRequest associateEntitiesToExperienceRequest)` Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience.
`AssociatePersonasToEntitiesResult`	`associatePersonasToEntities(AssociatePersonasToEntitiesRequest associatePersonasToEntitiesRequest)` Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience.
`BatchDeleteDocumentResult`	`batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest)` Removes one or more documents from an index.
`BatchGetDocumentStatusResult`	`batchGetDocumentStatus(BatchGetDocumentStatusRequest batchGetDocumentStatusRequest)` Returns the indexing status for one or more documents submitted with the BatchPutDocument API.
`BatchPutDocumentResult`	`batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest)` Adds one or more documents to an index.
`ClearQuerySuggestionsResult`	`clearQuerySuggestions(ClearQuerySuggestionsRequest clearQuerySuggestionsRequest)` Clears existing query suggestions from an index.
`CreateAccessControlConfigurationResult`	`createAccessControlConfiguration(CreateAccessControlConfigurationRequest createAccessControlConfigurationRequest)` Creates an access configuration for your documents.
`CreateDataSourceResult`	`createDataSource(CreateDataSourceRequest createDataSourceRequest)` Creates a data source connector that you want to use with an Amazon Kendra index.
`CreateExperienceResult`	`createExperience(CreateExperienceRequest createExperienceRequest)` Creates an Amazon Kendra experience such as a search application.
`CreateFaqResult`	`createFaq(CreateFaqRequest createFaqRequest)` Creates an new set of frequently asked question (FAQ) questions and answers.
`CreateIndexResult`	`createIndex(CreateIndexRequest createIndexRequest)` Creates an Amazon Kendra index.
`CreateQuerySuggestionsBlockListResult`	`createQuerySuggestionsBlockList(CreateQuerySuggestionsBlockListRequest createQuerySuggestionsBlockListRequest)` Creates a block list to exlcude certain queries from suggestions.
`CreateThesaurusResult`	`createThesaurus(CreateThesaurusRequest createThesaurusRequest)` Creates a thesaurus for an index.
`DeleteAccessControlConfigurationResult`	`deleteAccessControlConfiguration(DeleteAccessControlConfigurationRequest deleteAccessControlConfigurationRequest)` Deletes an access control configuration that you created for your documents in an index.
`DeleteDataSourceResult`	`deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)` Deletes an Amazon Kendra data source connector.
`DeleteExperienceResult`	`deleteExperience(DeleteExperienceRequest deleteExperienceRequest)` Deletes your Amazon Kendra experience such as a search application.
`DeleteFaqResult`	`deleteFaq(DeleteFaqRequest deleteFaqRequest)` Removes an FAQ from an index.
`DeleteIndexResult`	`deleteIndex(DeleteIndexRequest deleteIndexRequest)` Deletes an existing Amazon Kendra index.
`DeletePrincipalMappingResult`	`deletePrincipalMapping(DeletePrincipalMappingRequest deletePrincipalMappingRequest)` Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.
`DeleteQuerySuggestionsBlockListResult`	`deleteQuerySuggestionsBlockList(DeleteQuerySuggestionsBlockListRequest deleteQuerySuggestionsBlockListRequest)` Deletes a block list used for query suggestions for an index.
`DeleteThesaurusResult`	`deleteThesaurus(DeleteThesaurusRequest deleteThesaurusRequest)` Deletes an existing Amazon Kendra thesaurus.
`DescribeAccessControlConfigurationResult`	`describeAccessControlConfiguration(DescribeAccessControlConfigurationRequest describeAccessControlConfigurationRequest)` Gets information about an access control configuration that you created for your documents in an index.
`DescribeDataSourceResult`	`describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)` Gets information about an Amazon Kendra data source connector.
`DescribeExperienceResult`	`describeExperience(DescribeExperienceRequest describeExperienceRequest)` Gets information about your Amazon Kendra experience such as a search application.
`DescribeFaqResult`	`describeFaq(DescribeFaqRequest describeFaqRequest)` Gets information about an FAQ list.
`DescribeIndexResult`	`describeIndex(DescribeIndexRequest describeIndexRequest)` Gets information about an existing Amazon Kendra index.
`DescribePrincipalMappingResult`	`describePrincipalMapping(DescribePrincipalMappingRequest describePrincipalMappingRequest)` Describes the processing of `PUT` and `DELETE` actions for mapping users to their groups.
`DescribeQuerySuggestionsBlockListResult`	`describeQuerySuggestionsBlockList(DescribeQuerySuggestionsBlockListRequest describeQuerySuggestionsBlockListRequest)` Gets information about a block list used for query suggestions for an index.
`DescribeQuerySuggestionsConfigResult`	`describeQuerySuggestionsConfig(DescribeQuerySuggestionsConfigRequest describeQuerySuggestionsConfigRequest)` Gets information on the settings of query suggestions for an index.
`DescribeThesaurusResult`	`describeThesaurus(DescribeThesaurusRequest describeThesaurusRequest)` Gets information about an existing Amazon Kendra thesaurus.
`DisassociateEntitiesFromExperienceResult`	`disassociateEntitiesFromExperience(DisassociateEntitiesFromExperienceRequest disassociateEntitiesFromExperienceRequest)` Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience.
`DisassociatePersonasFromEntitiesResult`	`disassociatePersonasFromEntities(DisassociatePersonasFromEntitiesRequest disassociatePersonasFromEntitiesRequest)` Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetQuerySuggestionsResult`	`getQuerySuggestions(GetQuerySuggestionsRequest getQuerySuggestionsRequest)` Fetches the queries that are suggested to your users.
`GetSnapshotsResult`	`getSnapshots(GetSnapshotsRequest getSnapshotsRequest)` Retrieves search metrics data.
`ListAccessControlConfigurationsResult`	`listAccessControlConfigurations(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest)` Lists one or more access control configurations for an index.
`ListDataSourcesResult`	`listDataSources(ListDataSourcesRequest listDataSourcesRequest)` Lists the data source connectors that you have created.
`ListDataSourceSyncJobsResult`	`listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)` Gets statistics about synchronizing a data source connector.
`ListEntityPersonasResult`	`listEntityPersonas(ListEntityPersonasRequest listEntityPersonasRequest)` Lists specific permissions of users and groups with access to your Amazon Kendra experience.
`ListExperienceEntitiesResult`	`listExperienceEntities(ListExperienceEntitiesRequest listExperienceEntitiesRequest)` Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience.
`ListExperiencesResult`	`listExperiences(ListExperiencesRequest listExperiencesRequest)` Lists one or more Amazon Kendra experiences.
`ListFaqsResult`	`listFaqs(ListFaqsRequest listFaqsRequest)` Gets a list of FAQ lists associated with an index.
`ListGroupsOlderThanOrderingIdResult`	`listGroupsOlderThanOrderingId(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest)` Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
`ListIndicesResult`	`listIndices(ListIndicesRequest listIndicesRequest)` Lists the Amazon Kendra indexes that you created.
`ListQuerySuggestionsBlockListsResult`	`listQuerySuggestionsBlockLists(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest)` Lists the block lists used for query suggestions for an index.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Gets a list of tags associated with a specified resource.
`ListThesauriResult`	`listThesauri(ListThesauriRequest listThesauriRequest)` Lists the thesauri for an index.
`PutPrincipalMappingResult`	`putPrincipalMapping(PutPrincipalMappingRequest putPrincipalMappingRequest)` Maps users to their groups so that you only need to provide the user ID when you issue the query.
`QueryResult`	`query(QueryRequest queryRequest)` Searches an active index.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartDataSourceSyncJobResult`	`startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)` Starts a synchronization job for a data source connector.
`StopDataSourceSyncJobResult`	`stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)` Stops a synchronization job that is currently running.
`SubmitFeedbackResult`	`submitFeedback(SubmitFeedbackRequest submitFeedbackRequest)` Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds the specified tag to the specified index, FAQ, or data source resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes a tag from an index, FAQ, or a data source.
`UpdateAccessControlConfigurationResult`	`updateAccessControlConfiguration(UpdateAccessControlConfigurationRequest updateAccessControlConfigurationRequest)` Updates an access control configuration for your documents in an index.
`UpdateDataSourceResult`	`updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)` Updates an existing Amazon Kendra data source connector.
`UpdateExperienceResult`	`updateExperience(UpdateExperienceRequest updateExperienceRequest)` Updates your Amazon Kendra experience such as a search application.
`UpdateIndexResult`	`updateIndex(UpdateIndexRequest updateIndexRequest)` Updates an existing Amazon Kendra index.
`UpdateQuerySuggestionsBlockListResult`	`updateQuerySuggestionsBlockList(UpdateQuerySuggestionsBlockListRequest updateQuerySuggestionsBlockListRequest)` Updates a block list used for query suggestions for an index.
`UpdateQuerySuggestionsConfigResult`	`updateQuerySuggestionsConfig(UpdateQuerySuggestionsConfigRequest updateQuerySuggestionsConfigRequest)` Updates the settings of query suggestions for an index.
`UpdateThesaurusResult`	`updateThesaurus(UpdateThesaurusRequest updateThesaurusRequest)` Updates a thesaurus for an index.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - associateEntitiesToExperience
```
AssociateEntitiesToExperienceResult associateEntitiesToExperience(AssociateEntitiesToExperienceRequest associateEntitiesToExperienceRequest)
```
    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.
    
    Parameters:
    
    associateEntitiesToExperienceRequest -
    
    Returns:
    
    Result of the AssociateEntitiesToExperience operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ResourceAlreadyExistException - The resource you want to use already exists. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - associatePersonasToEntities
```
AssociatePersonasToEntitiesResult associatePersonasToEntities(AssociatePersonasToEntitiesRequest associatePersonasToEntitiesRequest)
```
    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.
    
    Parameters:
    
    associatePersonasToEntitiesRequest -
    
    Returns:
    
    Result of the AssociatePersonasToEntities operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ResourceAlreadyExistException - The resource you want to use already exists. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - batchDeleteDocument
```
BatchDeleteDocumentResult batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest)
```
    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 Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.
    
    Parameters:
    
    batchDeleteDocumentRequest -
    
    Returns:
    
    Result of the BatchDeleteDocument operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - batchGetDocumentStatus
```
BatchGetDocumentStatusResult batchGetDocumentStatus(BatchGetDocumentStatusRequest batchGetDocumentStatusRequest)
```
    Returns the indexing status for one or more documents submitted with the BatchPutDocument 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 API. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.
    
    Parameters:
    
    batchGetDocumentStatusRequest -
    
    Returns:
    
    Result of the BatchGetDocumentStatus operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - batchPutDocument
```
BatchPutDocumentResult batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest)
```
    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 Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.
    
    For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.
    
    Parameters:
    
    batchPutDocumentRequest -
    
    Returns:
    
    Result of the BatchPutDocument operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas[hyperlink Kendra Quotas pg] for more information, or contact Support to inquire about an increase of limits.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - clearQuerySuggestions
```
ClearQuerySuggestionsResult clearQuerySuggestions(ClearQuerySuggestionsRequest clearQuerySuggestionsRequest)
```
    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 Amazon Web Services GovCloud (US-West) region.
    
    Parameters:
    
    clearQuerySuggestionsRequest -
    
    Returns:
    
    Result of the ClearQuerySuggestions operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - createAccessControlConfiguration
```
CreateAccessControlConfigurationResult createAccessControlConfiguration(CreateAccessControlConfigurationRequest createAccessControlConfigurationRequest)
```
    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 API with the AccessControlConfigurationId included in the Document 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.
    
    Parameters:
    
    createAccessControlConfigurationRequest -
    
    Returns:
    
    Result of the CreateAccessControlConfiguration operation returned by the service.
    
    Throws:
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas[hyperlink Kendra Quotas pg] for more information, or contact Support to inquire about an increase of limits.
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    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.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - createDataSource
```
CreateDataSourceResult createDataSource(CreateDataSourceRequest createDataSourceRequest)
```
    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.
    
    Amazon S3 and custom data sources are the only supported data sources in the Amazon Web Services GovCloud (US-West) region.
    
    For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
    
    Parameters:
    
    createDataSourceRequest -
    
    Returns:
    
    Result of the CreateDataSource operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ResourceAlreadyExistException - The resource you want to use already exists. Please check you have provided the correct resource and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas[hyperlink Kendra Quotas pg] for more information, or contact Support to inquire about an increase of limits.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - createExperience
```
CreateExperienceResult createExperience(CreateExperienceRequest createExperienceRequest)
```
    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.
    
    Parameters:
    
    createExperienceRequest -
    
    Returns:
    
    Result of the CreateExperience operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas[hyperlink Kendra Quotas pg] for more information, or contact Support to inquire about an increase of limits.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - createFaq
```
CreateFaqResult createFaq(CreateFaqRequest createFaqRequest)
```
    Creates an new set of frequently asked question (FAQ) questions and answers.
    
    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.
    
    Parameters:
    
    createFaqRequest -
    
    Returns:
    
    Result of the CreateFaq operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas[hyperlink Kendra Quotas pg] for more information, or contact Support to inquire about an increase of limits.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - createIndex
```
CreateIndexResult createIndex(CreateIndexRequest createIndexRequest)
```
    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.
    
    For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
    
    Parameters:
    
    createIndexRequest -
    
    Returns:
    
    Result of the CreateIndex operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceAlreadyExistException - The resource you want to use already exists. Please check you have provided the correct resource and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas[hyperlink Kendra Quotas pg] for more information, or contact Support to inquire about an increase of limits.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - createQuerySuggestionsBlockList
```
CreateQuerySuggestionsBlockListResult createQuerySuggestionsBlockList(CreateQuerySuggestionsBlockListRequest createQuerySuggestionsBlockListRequest)
```
    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.
    
    CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.
    
    For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list.
    
    Parameters:
    
    createQuerySuggestionsBlockListRequest -
    
    Returns:
    
    Result of the CreateQuerySuggestionsBlockList operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas[hyperlink Kendra Quotas pg] for more information, or contact Support to inquire about an increase of limits.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - createThesaurus
```
CreateThesaurusResult createThesaurus(CreateThesaurusRequest createThesaurusRequest)
```
    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.
    
    Parameters:
    
    createThesaurusRequest -
    
    Returns:
    
    Result of the CreateThesaurus operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas[hyperlink Kendra Quotas pg] for more information, or contact Support to inquire about an increase of limits.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - deleteAccessControlConfiguration
```
DeleteAccessControlConfigurationResult deleteAccessControlConfiguration(DeleteAccessControlConfigurationRequest deleteAccessControlConfigurationRequest)
```
    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.
    
    Parameters:
    
    deleteAccessControlConfigurationRequest -
    
    Returns:
    
    Result of the DeleteAccessControlConfiguration operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - deleteDataSource
```
DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
```
    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.
    
    Parameters:
    
    deleteDataSourceRequest -
    
    Returns:
    
    Result of the DeleteDataSource operation returned by the service.
    
    Throws:
    
    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.
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - deleteExperience
```
DeleteExperienceResult deleteExperience(DeleteExperienceRequest deleteExperienceRequest)
```
    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.
    
    Parameters:
    
    deleteExperienceRequest -
    
    Returns:
    
    Result of the DeleteExperience operation returned by the service.
    
    Throws:
    
    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.
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - deleteFaq
```
DeleteFaqResult deleteFaq(DeleteFaqRequest deleteFaqRequest)
```
    Removes an FAQ from an index.
    
    Parameters:
    
    deleteFaqRequest -
    
    Returns:
    
    Result of the DeleteFaq operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - deleteIndex
```
DeleteIndexResult deleteIndex(DeleteIndexRequest deleteIndexRequest)
```
    Deletes an existing 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.
    
    Parameters:
    
    deleteIndexRequest -
    
    Returns:
    
    Result of the DeleteIndex operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - deletePrincipalMapping
```
DeletePrincipalMappingResult deletePrincipalMapping(DeletePrincipalMappingRequest deletePrincipalMappingRequest)
```
    Deletes a group so that all users and sub groups 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 Amazon Web Services GovCloud (US-West) region.
    
    Parameters:
    
    deletePrincipalMappingRequest -
    
    Returns:
    
    Result of the DeletePrincipalMapping operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - deleteQuerySuggestionsBlockList
```
DeleteQuerySuggestionsBlockListResult deleteQuerySuggestionsBlockList(DeleteQuerySuggestionsBlockListRequest deleteQuerySuggestionsBlockListRequest)
```
    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 Amazon Web Services GovCloud (US-West) region.
    
    Parameters:
    
    deleteQuerySuggestionsBlockListRequest -
    
    Returns:
    
    Result of the DeleteQuerySuggestionsBlockList operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - deleteThesaurus
```
DeleteThesaurusResult deleteThesaurus(DeleteThesaurusRequest deleteThesaurusRequest)
```
    Deletes an existing Amazon Kendra thesaurus.
    
    Parameters:
    
    deleteThesaurusRequest -
    
    Returns:
    
    Result of the DeleteThesaurus operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - describeAccessControlConfiguration
```
DescribeAccessControlConfigurationResult describeAccessControlConfiguration(DescribeAccessControlConfigurationRequest describeAccessControlConfigurationRequest)
```
    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.
    
    Parameters:
    
    describeAccessControlConfigurationRequest -
    
    Returns:
    
    Result of the DescribeAccessControlConfiguration operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - describeDataSource
```
DescribeDataSourceResult describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
```
    Gets information about an Amazon Kendra data source connector.
    
    Parameters:
    
    describeDataSourceRequest -
    
    Returns:
    
    Result of the DescribeDataSource operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - describeExperience
```
DescribeExperienceResult describeExperience(DescribeExperienceRequest describeExperienceRequest)
```
    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.
    
    Parameters:
    
    describeExperienceRequest -
    
    Returns:
    
    Result of the DescribeExperience operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - describeFaq
```
DescribeFaqResult describeFaq(DescribeFaqRequest describeFaqRequest)
```
    Gets information about an FAQ list.
    
    Parameters:
    
    describeFaqRequest -
    
    Returns:
    
    Result of the DescribeFaq operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - describeIndex
```
DescribeIndexResult describeIndex(DescribeIndexRequest describeIndexRequest)
```
    Gets information about an existing Amazon Kendra index.
    
    Parameters:
    
    describeIndexRequest -
    
    Returns:
    
    Result of the DescribeIndex operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - describePrincipalMapping
```
DescribePrincipalMappingResult describePrincipalMapping(DescribePrincipalMappingRequest describePrincipalMappingRequest)
```
    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 Amazon Web Services GovCloud (US-West) region.
    
    Parameters:
    
    describePrincipalMappingRequest -
    
    Returns:
    
    Result of the DescribePrincipalMapping operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - describeQuerySuggestionsBlockList
```
DescribeQuerySuggestionsBlockListResult describeQuerySuggestionsBlockList(DescribeQuerySuggestionsBlockListRequest describeQuerySuggestionsBlockListRequest)
```
    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 Amazon Web Services GovCloud (US-West) region.
    
    Parameters:
    
    describeQuerySuggestionsBlockListRequest -
    
    Returns:
    
    Result of the DescribeQuerySuggestionsBlockList operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - describeQuerySuggestionsConfig
```
DescribeQuerySuggestionsConfigResult describeQuerySuggestionsConfig(DescribeQuerySuggestionsConfigRequest describeQuerySuggestionsConfigRequest)
```
    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 Amazon Web Services GovCloud (US-West) region.
    
    Parameters:
    
    describeQuerySuggestionsConfigRequest -
    
    Returns:
    
    Result of the DescribeQuerySuggestionsConfig operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - describeThesaurus
```
DescribeThesaurusResult describeThesaurus(DescribeThesaurusRequest describeThesaurusRequest)
```
    Gets information about an existing Amazon Kendra thesaurus.
    
    Parameters:
    
    describeThesaurusRequest -
    
    Returns:
    
    Result of the DescribeThesaurus operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - disassociateEntitiesFromExperience
```
DisassociateEntitiesFromExperienceResult disassociateEntitiesFromExperience(DisassociateEntitiesFromExperienceRequest disassociateEntitiesFromExperienceRequest)
```
    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.
    
    Parameters:
    
    disassociateEntitiesFromExperienceRequest -
    
    Returns:
    
    Result of the DisassociateEntitiesFromExperience operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - disassociatePersonasFromEntities
```
DisassociatePersonasFromEntitiesResult disassociatePersonasFromEntities(DisassociatePersonasFromEntitiesRequest disassociatePersonasFromEntitiesRequest)
```
    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.
    
    Parameters:
    
    disassociatePersonasFromEntitiesRequest -
    
    Returns:
    
    Result of the DisassociatePersonasFromEntities operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - getQuerySuggestions
```
GetQuerySuggestionsResult getQuerySuggestions(GetQuerySuggestionsRequest getQuerySuggestionsRequest)
```
    Fetches the queries that are suggested to your users.
    
    GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.
    
    Parameters:
    
    getQuerySuggestionsRequest -
    
    Returns:
    
    Result of the GetQuerySuggestions operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas[hyperlink Kendra Quotas pg] for more information, or contact Support to inquire about an increase of limits.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - getSnapshots
```
GetSnapshotsResult getSnapshots(GetSnapshotsRequest getSnapshotsRequest)
```
    Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.
    
    Parameters:
    
    getSnapshotsRequest -
    
    Returns:
    
    Result of the GetSnapshots operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The input to the request is not valid. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - listAccessControlConfigurations
```
ListAccessControlConfigurationsResult listAccessControlConfigurations(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest)
```
    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.
    
    Parameters:
    
    listAccessControlConfigurationsRequest -
    
    Returns:
    
    Result of the ListAccessControlConfigurations operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - listDataSourceSyncJobs
```
ListDataSourceSyncJobsResult listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
```
    Gets statistics about synchronizing a data source connector.
    
    Parameters:
    
    listDataSourceSyncJobsRequest -
    
    Returns:
    
    Result of the ListDataSourceSyncJobs operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - listDataSources
```
ListDataSourcesResult listDataSources(ListDataSourcesRequest listDataSourcesRequest)
```
    Lists the data source connectors that you have created.
    
    Parameters:
    
    listDataSourcesRequest -
    
    Returns:
    
    Result of the ListDataSources operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    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.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - listEntityPersonas
```
ListEntityPersonasResult listEntityPersonas(ListEntityPersonasRequest listEntityPersonasRequest)
```
    Lists specific permissions of users and groups with access to your Amazon Kendra experience.
    
    Parameters:
    
    listEntityPersonasRequest -
    
    Returns:
    
    Result of the ListEntityPersonas operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    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.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - listExperienceEntities
```
ListExperienceEntitiesResult listExperienceEntities(ListExperienceEntitiesRequest listExperienceEntitiesRequest)
```
    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.
    
    Parameters:
    
    listExperienceEntitiesRequest -
    
    Returns:
    
    Result of the ListExperienceEntities operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    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.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - listExperiences
```
ListExperiencesResult listExperiences(ListExperiencesRequest listExperiencesRequest)
```
    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.
    
    Parameters:
    
    listExperiencesRequest -
    
    Returns:
    
    Result of the ListExperiences operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    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.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - listFaqs
```
ListFaqsResult listFaqs(ListFaqsRequest listFaqsRequest)
```
    Gets a list of FAQ lists associated with an index.
    
    Parameters:
    
    listFaqsRequest -
    
    Returns:
    
    Result of the ListFaqs operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - listGroupsOlderThanOrderingId
```
ListGroupsOlderThanOrderingIdResult listGroupsOlderThanOrderingId(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest)
```
    Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
    
    ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web Services GovCloud (US-West) region.
    
    Parameters:
    
    listGroupsOlderThanOrderingIdRequest -
    
    Returns:
    
    Result of the ListGroupsOlderThanOrderingId operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    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.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - listIndices
```
ListIndicesResult listIndices(ListIndicesRequest listIndicesRequest)
```
    Lists the Amazon Kendra indexes that you created.
    
    Parameters:
    
    listIndicesRequest -
    
    Returns:
    
    Result of the ListIndices operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - listQuerySuggestionsBlockLists
```
ListQuerySuggestionsBlockListsResult listQuerySuggestionsBlockLists(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest)
```
    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.
    
    ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web Services GovCloud (US-West) region.
    
    Parameters:
    
    listQuerySuggestionsBlockListsRequest -
    
    Returns:
    
    Result of the ListQuerySuggestionsBlockLists operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceUnavailableException - The resource you want to use isn't available. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - listThesauri
```
ListThesauriResult listThesauri(ListThesauriRequest listThesauriRequest)
```
    Lists the thesauri for an index.
    
    Parameters:
    
    listThesauriRequest -
    
    Returns:
    
    Result of the ListThesauri operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - putPrincipalMapping
```
PutPrincipalMappingResult putPrincipalMapping(PutPrincipalMappingRequest putPrincipalMappingRequest)
```
    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.
    
    If more than five PUT actions for a group are currently processing, a validation exception is thrown.
    
    PutPrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.
    
    Parameters:
    
    putPrincipalMappingRequest -
    
    Returns:
    
    Result of the PutPrincipalMapping operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas[hyperlink Kendra Quotas pg] for more information, or contact Support to inquire about an increase of limits.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - query
```
QueryResult query(QueryRequest queryRequest)
```
    Searches an active index. Use this API to search your documents using query. The Query API enables to do faceted search and to filter results based on document attributes.
    
    It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.
    
    Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.
    - Relevant passages
    - Matching FAQs
    - Relevant documents
    You can specify that the query return only one type of result using the QueryResultTypeFilter parameter.
    
    Each query returns the 100 most relevant results.
    Parameters:
    
    queryRequest -
    
    Returns:
    
    Result of the Query operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas[hyperlink Kendra Quotas pg] for more information, or contact Support to inquire about an increase of limits.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - startDataSourceSyncJob
```
StartDataSourceSyncJobResult startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)
```
    Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.
    
    Parameters:
    
    startDataSourceSyncJobRequest -
    
    Returns:
    
    Result of the StartDataSourceSyncJob operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ResourceInUseException - The resource you want to use is currently in use. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - stopDataSourceSyncJob
```
StopDataSourceSyncJobResult stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)
```
    Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
    
    Parameters:
    
    stopDataSourceSyncJobRequest -
    
    Returns:
    
    Result of the StopDataSourceSyncJob operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - submitFeedback
```
SubmitFeedbackResult submitFeedback(SubmitFeedbackRequest submitFeedbackRequest)
```
    Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
    
    SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West) region.
    
    Parameters:
    
    submitFeedbackRequest -
    
    Returns:
    
    Result of the SubmitFeedback operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceUnavailableException - The resource you want to use isn't available. Please check you have provided the correct resource and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the existing value is replaced with the new value.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceUnavailableException - The resource you want to use isn't available. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes a tag from an index, FAQ, or a data source.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceUnavailableException - The resource you want to use isn't available. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - updateAccessControlConfiguration
```
UpdateAccessControlConfigurationResult updateAccessControlConfiguration(UpdateAccessControlConfigurationRequest updateAccessControlConfigurationRequest)
```
    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 API to apply the updated access control configuration, with the AccessControlConfigurationId included in the Document 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.
    
    Parameters:
    
    updateAccessControlConfigurationRequest -
    
    Returns:
    
    Result of the UpdateAccessControlConfiguration operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    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.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas[hyperlink Kendra Quotas pg] for more information, or contact Support to inquire about an increase of limits.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - updateDataSource
```
UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
```
    Updates an existing Amazon Kendra data source connector.
    
    Parameters:
    
    updateDataSourceRequest -
    
    Returns:
    
    Result of the UpdateDataSource operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - updateExperience
```
UpdateExperienceResult updateExperience(UpdateExperienceRequest updateExperienceRequest)
```
    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.
    
    Parameters:
    
    updateExperienceRequest -
    
    Returns:
    
    Result of the UpdateExperience operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - updateIndex
```
UpdateIndexResult updateIndex(UpdateIndexRequest updateIndexRequest)
```
    Updates an existing Amazon Kendra index.
    
    Parameters:
    
    updateIndexRequest -
    
    Returns:
    
    Result of the UpdateIndex operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    ServiceQuotaExceededException - You have exceeded the set limits for your Amazon Kendra service. Please see Quotas[hyperlink Kendra Quotas pg] for more information, or contact Support to inquire about an increase of limits.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - updateQuerySuggestionsBlockList
```
UpdateQuerySuggestionsBlockListResult updateQuerySuggestionsBlockList(UpdateQuerySuggestionsBlockListRequest updateQuerySuggestionsBlockListRequest)
```
    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 Amazon Web Services GovCloud (US-West) region.
    
    Parameters:
    
    updateQuerySuggestionsBlockListRequest -
    
    Returns:
    
    Result of the UpdateQuerySuggestionsBlockList operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - updateQuerySuggestionsConfig
```
UpdateQuerySuggestionsConfigResult updateQuerySuggestionsConfig(UpdateQuerySuggestionsConfigRequest updateQuerySuggestionsConfigRequest)
```
    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 (i.e. 'happening'), 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 Amazon Web Services GovCloud (US-West) region.
    
    Parameters:
    
    updateQuerySuggestionsConfigRequest -
    
    Returns:
    
    Result of the UpdateQuerySuggestionsConfig operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - updateThesaurus
```
UpdateThesaurusResult updateThesaurus(UpdateThesaurusRequest updateThesaurusRequest)
```
    Updates a thesaurus for an index.
    
    Parameters:
    
    updateThesaurusRequest -
    
    Returns:
    
    Result of the UpdateThesaurus operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
    
    ResourceNotFoundException - The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
    
    ThrottlingException - The request was denied due to request throttling. Please reduce the number of requests and try again.
    
    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.
    
    ConflictException - A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
    
    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 for help.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AWSkendra

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

associateEntitiesToExperience

associatePersonasToEntities

batchDeleteDocument

batchGetDocumentStatus

batchPutDocument

clearQuerySuggestions

createAccessControlConfiguration

createDataSource

createExperience

createFaq

createIndex

createQuerySuggestionsBlockList

createThesaurus

deleteAccessControlConfiguration

deleteDataSource

deleteExperience

deleteFaq

deleteIndex

deletePrincipalMapping

deleteQuerySuggestionsBlockList

deleteThesaurus

describeAccessControlConfiguration

describeDataSource

describeExperience

describeFaq

describeIndex

describePrincipalMapping

describeQuerySuggestionsBlockList

describeQuerySuggestionsConfig

describeThesaurus

disassociateEntitiesFromExperience

disassociatePersonasFromEntities

getQuerySuggestions

getSnapshots

listAccessControlConfigurations

listDataSourceSyncJobs

listDataSources

listEntityPersonas

listExperienceEntities

listExperiences

listFaqs

listGroupsOlderThanOrderingId

listIndices

listQuerySuggestionsBlockLists

listTagsForResource

listThesauri

putPrincipalMapping

query

startDataSourceSyncJob

stopDataSourceSyncJob

submitFeedback

tagResource

untagResource

updateAccessControlConfiguration

updateDataSource

updateExperience

updateIndex

updateQuerySuggestionsBlockList

updateQuerySuggestionsConfig

updateThesaurus

shutdown

getCachedResponseMetadata