com.amazonaws.services.kendra.AWSkendra Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kendra Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kendra;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.kendra.model.*;
/**
* Interface for accessing kendra.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.kendra.AbstractAWSkendra} instead.
*
*
*
* Amazon Kendra is a service for indexing large document sets.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSkendra {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "kendra";
/**
*
* 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.
*
*
* @param associateEntitiesToExperienceRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ResourceAlreadyExistException
* The resource you want to use already exists. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.AssociateEntitiesToExperience
* @see AWS API Documentation
*/
AssociateEntitiesToExperienceResult associateEntitiesToExperience(AssociateEntitiesToExperienceRequest associateEntitiesToExperienceRequest);
/**
*
* 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.
*
*
* @param associatePersonasToEntitiesRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ResourceAlreadyExistException
* The resource you want to use already exists. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.AssociatePersonasToEntities
* @see AWS API Documentation
*/
AssociatePersonasToEntitiesResult associatePersonasToEntities(AssociatePersonasToEntitiesRequest associatePersonasToEntitiesRequest);
/**
*
* 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 your Amazon Web Services
* CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of deleting
* your documents.
*
*
* Deleting documents from an index using BatchDeleteDocument could take up to an hour or more,
* depending on the number of documents you want to delete.
*
*
* @param batchDeleteDocumentRequest
* @return 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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.BatchDeleteDocument
* @see AWS API
* Documentation
*/
BatchDeleteDocumentResult batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest);
/**
*
* Removes one or more sets of featured results. Features results are placed above all other results for certain
* queries. If there's an exact match of a query, then one or more specific documents are featured in the search
* results.
*
*
* @param batchDeleteFeaturedResultsSetRequest
* @return Result of the BatchDeleteFeaturedResultsSet operation returned by the service.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws 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.
* @sample AWSkendra.BatchDeleteFeaturedResultsSet
* @see AWS API Documentation
*/
BatchDeleteFeaturedResultsSetResult batchDeleteFeaturedResultsSet(BatchDeleteFeaturedResultsSetRequest batchDeleteFeaturedResultsSetRequest);
/**
*
* 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.
*
*
* @param batchGetDocumentStatusRequest
* @return 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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.BatchGetDocumentStatus
* @see AWS
* API Documentation
*/
BatchGetDocumentStatusResult batchGetDocumentStatus(BatchGetDocumentStatusRequest batchGetDocumentStatusRequest);
/**
*
* 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. You can also use the BatchGetDocumentStatus API to monitor the progress of indexing your
* documents.
*
*
* For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an
* index.
*
*
* @param batchPutDocumentRequest
* @return 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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws 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.
* @sample AWSkendra.BatchPutDocument
* @see AWS API
* Documentation
*/
BatchPutDocumentResult batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest);
/**
*
* 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.
*
*
* @param clearQuerySuggestionsRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @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.
* @throws 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.
* @sample AWSkendra.ClearQuerySuggestions
* @see AWS
* API Documentation
*/
ClearQuerySuggestionsResult clearQuerySuggestions(ClearQuerySuggestionsRequest clearQuerySuggestionsRequest);
/**
*
* 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.
*
*
* @param createAccessControlConfigurationRequest
* @return 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 for more information, or
* contact Support to inquire about an increase of limits.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws 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.
* @sample AWSkendra.CreateAccessControlConfiguration
* @see AWS API Documentation
*/
CreateAccessControlConfigurationResult createAccessControlConfiguration(CreateAccessControlConfigurationRequest createAccessControlConfigurationRequest);
/**
*
* Creates a data source connector that you want to use with an Amazon Kendra index.
*
*
* You specify a name, data source connector type and description for your data source. You also specify
* configuration information for the data source connector.
*
*
* CreateDataSource is a synchronous operation. The operation returns 200 if the data source was
* successfully created. Otherwise, an exception is raised.
*
*
* For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an
* example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
*
*
* @param createDataSourceRequest
* @return 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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ResourceAlreadyExistException
* The resource you want to use already exists. Please check you have provided the correct resource and try
* again.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.CreateDataSource
* @see AWS API
* Documentation
*/
CreateDataSourceResult createDataSource(CreateDataSourceRequest createDataSourceRequest);
/**
*
* 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.
*
*
* @param createExperienceRequest
* @return 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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.CreateExperience
* @see AWS API
* Documentation
*/
CreateExperienceResult createExperience(CreateExperienceRequest createExperienceRequest);
/**
*
* Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.
*
*
* Adding FAQs to an index is an asynchronous operation.
*
*
* For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.
*
*
* @param createFaqRequest
* @return 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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @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.
* @throws 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.
* @sample AWSkendra.CreateFaq
* @see AWS API
* Documentation
*/
CreateFaqResult createFaq(CreateFaqRequest createFaqRequest);
/**
*
* Creates a set of featured results to display at the top of the search results page. Featured results are placed
* above all other results for certain queries. You map specific queries to specific documents for featuring in the
* results. If a query contains an exact match, then one or more specific documents are featured in the search
* results.
*
*
* You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting
* Support.
*
*
* @param createFeaturedResultsSetRequest
* @return Result of the CreateFeaturedResultsSet operation returned by the service.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws FeaturedResultsConflictException
* An error message with a list of conflicting queries used across different sets of featured results. This
* occurred with the request for a new featured results set. Check that the queries you specified for
* featured results are unique per featured results set for each index.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws 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.
* @sample AWSkendra.CreateFeaturedResultsSet
* @see AWS API Documentation
*/
CreateFeaturedResultsSetResult createFeaturedResultsSet(CreateFeaturedResultsSetRequest createFeaturedResultsSetRequest);
/**
*
* 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.
*
*
* @param createIndexRequest
* @return 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.
* @throws ResourceAlreadyExistException
* The resource you want to use already exists. Please check you have provided the correct resource and try
* again.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws 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.
* @sample AWSkendra.CreateIndex
* @see AWS API
* Documentation
*/
CreateIndexResult createIndex(CreateIndexRequest createIndexRequest);
/**
*
* 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.
*
*
* @param createQuerySuggestionsBlockListRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws 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.
* @sample AWSkendra.CreateQuerySuggestionsBlockList
* @see AWS API Documentation
*/
CreateQuerySuggestionsBlockListResult createQuerySuggestionsBlockList(CreateQuerySuggestionsBlockListRequest createQuerySuggestionsBlockListRequest);
/**
*
* 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.
*
*
* @param createThesaurusRequest
* @return 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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @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.
* @throws 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.
* @sample AWSkendra.CreateThesaurus
* @see AWS API
* Documentation
*/
CreateThesaurusResult createThesaurus(CreateThesaurusRequest createThesaurusRequest);
/**
*
* 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.
*
*
* @param deleteAccessControlConfigurationRequest
* @return 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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws 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.
* @sample AWSkendra.DeleteAccessControlConfiguration
* @see AWS API Documentation
*/
DeleteAccessControlConfigurationResult deleteAccessControlConfiguration(DeleteAccessControlConfigurationRequest deleteAccessControlConfigurationRequest);
/**
*
* 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.
*
*
* Deleting an entire data source or re-syncing your index after deleting specific documents from a data source
* could take up to an hour or more, depending on the number of documents you want to delete.
*
*
* @param deleteDataSourceRequest
* @return 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.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws 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.
* @sample AWSkendra.DeleteDataSource
* @see AWS API
* Documentation
*/
DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest);
/**
*
* 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.
*
*
* @param deleteExperienceRequest
* @return 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.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws 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.
* @sample AWSkendra.DeleteExperience
* @see AWS API
* Documentation
*/
DeleteExperienceResult deleteExperience(DeleteExperienceRequest deleteExperienceRequest);
/**
*
* Removes an FAQ from an index.
*
*
* @param deleteFaqRequest
* @return 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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.DeleteFaq
* @see AWS API
* Documentation
*/
DeleteFaqResult deleteFaq(DeleteFaqRequest deleteFaqRequest);
/**
*
* Deletes an Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index
* is being deleted, the Status field returned by a call to the DescribeIndex API is set
* to DELETING.
*
*
* @param deleteIndexRequest
* @return 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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.DeleteIndex
* @see AWS API
* Documentation
*/
DeleteIndexResult deleteIndex(DeleteIndexRequest deleteIndexRequest);
/**
*
* 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.
*
*
* @param deletePrincipalMappingRequest
* @return 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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.DeletePrincipalMapping
* @see AWS
* API Documentation
*/
DeletePrincipalMappingResult deletePrincipalMapping(DeletePrincipalMappingRequest deletePrincipalMappingRequest);
/**
*
* 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.
*
*
* @param deleteQuerySuggestionsBlockListRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws 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.
* @sample AWSkendra.DeleteQuerySuggestionsBlockList
* @see AWS API Documentation
*/
DeleteQuerySuggestionsBlockListResult deleteQuerySuggestionsBlockList(DeleteQuerySuggestionsBlockListRequest deleteQuerySuggestionsBlockListRequest);
/**
*
* Deletes an Amazon Kendra thesaurus.
*
*
* @param deleteThesaurusRequest
* @return 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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.DeleteThesaurus
* @see AWS API
* Documentation
*/
DeleteThesaurusResult deleteThesaurus(DeleteThesaurusRequest deleteThesaurusRequest);
/**
*
* 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.
*
*
* @param describeAccessControlConfigurationRequest
* @return 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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws 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.
* @sample AWSkendra.DescribeAccessControlConfiguration
* @see AWS API Documentation
*/
DescribeAccessControlConfigurationResult describeAccessControlConfiguration(
DescribeAccessControlConfigurationRequest describeAccessControlConfigurationRequest);
/**
*
* Gets information about an Amazon Kendra data source connector.
*
*
* @param describeDataSourceRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.DescribeDataSource
* @see AWS API
* Documentation
*/
DescribeDataSourceResult describeDataSource(DescribeDataSourceRequest describeDataSourceRequest);
/**
*
* 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.
*
*
* @param describeExperienceRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.DescribeExperience
* @see AWS API
* Documentation
*/
DescribeExperienceResult describeExperience(DescribeExperienceRequest describeExperienceRequest);
/**
*
* Gets information about an FAQ list.
*
*
* @param describeFaqRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.DescribeFaq
* @see AWS API
* Documentation
*/
DescribeFaqResult describeFaq(DescribeFaqRequest describeFaqRequest);
/**
*
* Gets information about a set of featured results. Features results are placed above all other results for certain
* queries. If there's an exact match of a query, then one or more specific documents are featured in the search
* results.
*
*
* @param describeFeaturedResultsSetRequest
* @return Result of the DescribeFeaturedResultsSet operation returned by the service.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws 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.
* @sample AWSkendra.DescribeFeaturedResultsSet
* @see AWS API Documentation
*/
DescribeFeaturedResultsSetResult describeFeaturedResultsSet(DescribeFeaturedResultsSetRequest describeFeaturedResultsSetRequest);
/**
*
* Gets information about an Amazon Kendra index.
*
*
* @param describeIndexRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.DescribeIndex
* @see AWS API
* Documentation
*/
DescribeIndexResult describeIndex(DescribeIndexRequest describeIndexRequest);
/**
*
* 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.
*
*
* @param describePrincipalMappingRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.DescribePrincipalMapping
* @see AWS API Documentation
*/
DescribePrincipalMappingResult describePrincipalMapping(DescribePrincipalMappingRequest describePrincipalMappingRequest);
/**
*
* 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.
*
*
* @param describeQuerySuggestionsBlockListRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.DescribeQuerySuggestionsBlockList
* @see AWS API Documentation
*/
DescribeQuerySuggestionsBlockListResult describeQuerySuggestionsBlockList(DescribeQuerySuggestionsBlockListRequest describeQuerySuggestionsBlockListRequest);
/**
*
* 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.
*
*
* @param describeQuerySuggestionsConfigRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.DescribeQuerySuggestionsConfig
* @see AWS API Documentation
*/
DescribeQuerySuggestionsConfigResult describeQuerySuggestionsConfig(DescribeQuerySuggestionsConfigRequest describeQuerySuggestionsConfigRequest);
/**
*
* Gets information about an Amazon Kendra thesaurus.
*
*
* @param describeThesaurusRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.DescribeThesaurus
* @see AWS API
* Documentation
*/
DescribeThesaurusResult describeThesaurus(DescribeThesaurusRequest describeThesaurusRequest);
/**
*
* 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.
*
*
* @param disassociateEntitiesFromExperienceRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.DisassociateEntitiesFromExperience
* @see AWS API Documentation
*/
DisassociateEntitiesFromExperienceResult disassociateEntitiesFromExperience(
DisassociateEntitiesFromExperienceRequest disassociateEntitiesFromExperienceRequest);
/**
*
* 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.
*
*
* @param disassociatePersonasFromEntitiesRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.DisassociatePersonasFromEntities
* @see AWS API Documentation
*/
DisassociatePersonasFromEntitiesResult disassociatePersonasFromEntities(DisassociatePersonasFromEntitiesRequest disassociatePersonasFromEntitiesRequest);
/**
*
* Fetches the queries that are suggested to your users.
*
*
* GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.
*
*
* @param getQuerySuggestionsRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws 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.
* @sample AWSkendra.GetQuerySuggestions
* @see AWS API
* Documentation
*/
GetQuerySuggestionsResult getQuerySuggestions(GetQuerySuggestionsRequest getQuerySuggestionsRequest);
/**
*
* Retrieves search metrics data. The data provides a snapshot of how your users interact with your search
* application and how effective the application is.
*
*
* @param getSnapshotsRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws 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.
* @sample AWSkendra.GetSnapshots
* @see AWS API
* Documentation
*/
GetSnapshotsResult getSnapshots(GetSnapshotsRequest getSnapshotsRequest);
/**
*
* 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.
*
*
* @param listAccessControlConfigurationsRequest
* @return 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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws 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.
* @sample AWSkendra.ListAccessControlConfigurations
* @see AWS API Documentation
*/
ListAccessControlConfigurationsResult listAccessControlConfigurations(ListAccessControlConfigurationsRequest listAccessControlConfigurationsRequest);
/**
*
* Gets statistics about synchronizing a data source connector.
*
*
* @param listDataSourceSyncJobsRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws 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.
* @sample AWSkendra.ListDataSourceSyncJobs
* @see AWS
* API Documentation
*/
ListDataSourceSyncJobsResult listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest);
/**
*
* Lists the data source connectors that you have created.
*
*
* @param listDataSourcesRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws 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.
* @sample AWSkendra.ListDataSources
* @see AWS API
* Documentation
*/
ListDataSourcesResult listDataSources(ListDataSourcesRequest listDataSourcesRequest);
/**
*
* Lists specific permissions of users and groups with access to your Amazon Kendra experience.
*
*
* @param listEntityPersonasRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws 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.
* @sample AWSkendra.ListEntityPersonas
* @see AWS API
* Documentation
*/
ListEntityPersonasResult listEntityPersonas(ListEntityPersonasRequest listEntityPersonasRequest);
/**
*
* 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.
*
*
* @param listExperienceEntitiesRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws 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.
* @sample AWSkendra.ListExperienceEntities
* @see AWS
* API Documentation
*/
ListExperienceEntitiesResult listExperienceEntities(ListExperienceEntitiesRequest listExperienceEntitiesRequest);
/**
*
* 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.
*
*
* @param listExperiencesRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws 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.
* @sample AWSkendra.ListExperiences
* @see AWS API
* Documentation
*/
ListExperiencesResult listExperiences(ListExperiencesRequest listExperiencesRequest);
/**
*
* Gets a list of FAQ lists associated with an index.
*
*
* @param listFaqsRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.ListFaqs
* @see AWS API
* Documentation
*/
ListFaqsResult listFaqs(ListFaqsRequest listFaqsRequest);
/**
*
* Lists all your sets of featured results for a given index. Features results are placed above all other results
* for certain queries. If there's an exact match of a query, then one or more specific documents are featured in
* the search results.
*
*
* @param listFeaturedResultsSetsRequest
* @return Result of the ListFeaturedResultsSets operation returned by the service.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws 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.
* @sample AWSkendra.ListFeaturedResultsSets
* @see AWS
* API Documentation
*/
ListFeaturedResultsSetsResult listFeaturedResultsSets(ListFeaturedResultsSetsRequest listFeaturedResultsSetsRequest);
/**
*
* 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.
*
*
* @param listGroupsOlderThanOrderingIdRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws 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.
* @sample AWSkendra.ListGroupsOlderThanOrderingId
* @see AWS API Documentation
*/
ListGroupsOlderThanOrderingIdResult listGroupsOlderThanOrderingId(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest);
/**
*
* Lists the Amazon Kendra indexes that you created.
*
*
* @param listIndicesRequest
* @return 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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.ListIndices
* @see AWS API
* Documentation
*/
ListIndicesResult listIndices(ListIndicesRequest listIndicesRequest);
/**
*
* 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.
*
*
* @param listQuerySuggestionsBlockListsRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.ListQuerySuggestionsBlockLists
* @see AWS API Documentation
*/
ListQuerySuggestionsBlockListsResult listQuerySuggestionsBlockLists(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest);
/**
*
* Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags
* associated with them.
*
*
* @param listTagsForResourceRequest
* @return 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.
* @throws ResourceUnavailableException
* The resource you want to use isn't available. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.ListTagsForResource
* @see AWS API
* Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists the thesauri for an index.
*
*
* @param listThesauriRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.ListThesauri
* @see AWS API
* Documentation
*/
ListThesauriResult listThesauri(ListThesauriRequest listThesauriRequest);
/**
*
* 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.
*
*
* @param putPrincipalMappingRequest
* @return 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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws 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.
* @sample AWSkendra.PutPrincipalMapping
* @see AWS API
* Documentation
*/
PutPrincipalMappingResult putPrincipalMapping(PutPrincipalMappingRequest putPrincipalMappingRequest);
/**
*
* Searches an index given an input query.
*
*
*
* If you are working with large language models (LLMs) or implementing retrieval augmented generation (RAG)
* systems, you can use Amazon Kendra's Retrieve API, which can
* return longer semantically relevant passages. We recommend using the Retrieve API instead of filing
* a service limit increase to increase the Query API document excerpt length.
*
*
*
* You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter
* based on document fields/attributes and faceted search, and filter based on the user or their group access to
* documents. You can also include certain fields in the response that might provide useful additional information.
*
*
* A query response contains three types of results.
*
*
* -
*
* Relevant suggested answers. The answers can be either a text excerpt or table excerpt. The answer can be
* highlighted in the excerpt.
*
*
* -
*
* Matching FAQs or questions-answer from your FAQ file.
*
*
* -
*
* Relevant documents. This result type includes an excerpt of the document with the document title. The searched
* terms can be highlighted in the excerpt.
*
*
*
*
* You can specify that the query return only one type of result using the QueryResultTypeFilter
* parameter. Each query returns the 100 most relevant results. If you filter result type to only question-answers,
* a maximum of four results are returned. If you filter result type to only answers, a maximum of three results are
* returned.
*
*
* @param queryRequest
* @return 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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws 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.
* @sample AWSkendra.Query
* @see AWS API
* Documentation
*/
QueryResult query(QueryRequest queryRequest);
/**
*
* Retrieves relevant passages or text excerpts given an input query.
*
*
* This API is similar to the Query API. However, by default,
* the Query API only returns excerpt passages of up to 100 token words. With the Retrieve
* API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This
* doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be
* semantically extracted from multiple documents and multiple parts of the same document. If in extreme cases your
* documents produce zero passages using the Retrieve API, you can alternatively use the
* Query API and its types of responses.
*
*
* You can also do the following:
*
*
* -
*
* Override boosting at the index level
*
*
* -
*
* Filter based on document fields or attributes
*
*
* -
*
* Filter based on the user or their group access to documents
*
*
* -
*
* View the confidence score bucket for a retrieved passage result. The confidence bucket provides a relative
* ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.
*
*
*
* Confidence score buckets are currently available only for English.
*
*
*
*
* You can also include certain fields in the response that might provide useful additional information.
*
*
* The Retrieve API shares the number of query capacity
* units that you set for your index. For more information on what's included in a single capacity unit and the
* default base capacity for an index, see Adjusting capacity.
*
*
* @param retrieveRequest
* @return Result of the Retrieve 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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws 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.
* @sample AWSkendra.Retrieve
* @see AWS API
* Documentation
*/
RetrieveResult retrieve(RetrieveRequest retrieveRequest);
/**
*
* Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon
* Kendra returns a ResourceInUseException exception.
*
*
* Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source
* respository could take up to an hour or more, depending on the number of documents to sync.
*
*
* @param startDataSourceSyncJobRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ResourceInUseException
* The resource you want to use is currently in use. Please check you have provided the correct resource and
* try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws 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.
* @sample AWSkendra.StartDataSourceSyncJob
* @see AWS
* API Documentation
*/
StartDataSourceSyncJobResult startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest);
/**
*
* Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
*
*
* @param stopDataSourceSyncJobRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.StopDataSourceSyncJob
* @see AWS
* API Documentation
*/
StopDataSourceSyncJobResult stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest);
/**
*
* 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.
*
*
* @param submitFeedbackRequest
* @return 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.
* @throws ResourceUnavailableException
* The resource you want to use isn't available. Please check you have provided the correct resource and try
* again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.SubmitFeedback
* @see AWS API
* Documentation
*/
SubmitFeedbackResult submitFeedback(SubmitFeedbackRequest submitFeedbackRequest);
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return 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.
* @throws ResourceUnavailableException
* The resource you want to use isn't available. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes a tag from an index, FAQ, or a data source.
*
*
* @param untagResourceRequest
* @return 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.
* @throws ResourceUnavailableException
* The resource you want to use isn't available. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* 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.
*
*
* @param updateAccessControlConfigurationRequest
* @return 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.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws 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.
* @sample AWSkendra.UpdateAccessControlConfiguration
* @see AWS API Documentation
*/
UpdateAccessControlConfigurationResult updateAccessControlConfiguration(UpdateAccessControlConfigurationRequest updateAccessControlConfigurationRequest);
/**
*
* Updates an Amazon Kendra data source connector.
*
*
* @param updateDataSourceRequest
* @return 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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.UpdateDataSource
* @see AWS API
* Documentation
*/
UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest updateDataSourceRequest);
/**
*
* 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.
*
*
* @param updateExperienceRequest
* @return 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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.UpdateExperience
* @see AWS API
* Documentation
*/
UpdateExperienceResult updateExperience(UpdateExperienceRequest updateExperienceRequest);
/**
*
* Updates a set of featured results. Features results are placed above all other results for certain queries. You
* map specific queries to specific documents for featuring in the results. If a query contains an exact match of a
* query, then one or more specific documents are featured in the search results.
*
*
* @param updateFeaturedResultsSetRequest
* @return Result of the UpdateFeaturedResultsSet operation returned by the service.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @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.
* @throws FeaturedResultsConflictException
* An error message with a list of conflicting queries used across different sets of featured results. This
* occurred with the request for a new featured results set. Check that the queries you specified for
* featured results are unique per featured results set for each index.
* @throws ValidationException
* The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct
* input and try again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @throws 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.
* @sample AWSkendra.UpdateFeaturedResultsSet
* @see AWS API Documentation
*/
UpdateFeaturedResultsSetResult updateFeaturedResultsSet(UpdateFeaturedResultsSetRequest updateFeaturedResultsSetRequest);
/**
*
* Updates an Amazon Kendra index.
*
*
* @param updateIndexRequest
* @return 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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ServiceQuotaExceededException
* You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or
* contact Support to inquire about an increase of limits.
* @throws 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.
* @sample AWSkendra.UpdateIndex
* @see AWS API
* Documentation
*/
UpdateIndexResult updateIndex(UpdateIndexRequest updateIndexRequest);
/**
*
* 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.
*
*
* @param updateQuerySuggestionsBlockListRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws 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.
* @sample AWSkendra.UpdateQuerySuggestionsBlockList
* @see AWS API Documentation
*/
UpdateQuerySuggestionsBlockListResult updateQuerySuggestionsBlockList(UpdateQuerySuggestionsBlockListRequest updateQuerySuggestionsBlockListRequest);
/**
*
* Updates the settings of query suggestions for an index.
*
*
* Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
*
*
* If an update is currently processing, you need to wait for the update to finish before making another update.
*
*
* Updates to query suggestions settings might not take effect right away. The time for your updated settings to
* take effect depends on the updates made and the number of search queries in your index.
*
*
* You can still enable/disable query suggestions at any time.
*
*
* UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud
* (US-West) region.
*
*
* @param updateQuerySuggestionsConfigRequest
* @return 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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws 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.
* @sample AWSkendra.UpdateQuerySuggestionsConfig
* @see AWS API Documentation
*/
UpdateQuerySuggestionsConfigResult updateQuerySuggestionsConfig(UpdateQuerySuggestionsConfigRequest updateQuerySuggestionsConfigRequest);
/**
*
* Updates a thesaurus for an index.
*
*
* @param updateThesaurusRequest
* @return 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.
* @throws ResourceNotFoundException
* The resource you want to use doesn’t exist. Please check you have provided the correct resource and try
* again.
* @throws ThrottlingException
* The request was denied due to request throttling. Please reduce the number of requests and try again.
* @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.
* @throws ConflictException
* A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
* @throws 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.
* @sample AWSkendra.UpdateThesaurus
* @see AWS API
* Documentation
*/
UpdateThesaurusResult updateThesaurus(UpdateThesaurusRequest updateThesaurusRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}