@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSkendraClient extends AmazonWebServiceClient implements AWSkendra
Amazon Kendra is a service for indexing large document sets.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
BatchDeleteDocumentResult |
batchDeleteDocument(BatchDeleteDocumentRequest request)
Removes one or more documents from an index.
|
BatchGetDocumentStatusResult |
batchGetDocumentStatus(BatchGetDocumentStatusRequest request)
Returns the indexing status for one or more documents submitted with the BatchPutDocument operation.
|
BatchPutDocumentResult |
batchPutDocument(BatchPutDocumentRequest request)
Adds one or more documents to an index.
|
static AWSkendraClientBuilder |
builder() |
ClearQuerySuggestionsResult |
clearQuerySuggestions(ClearQuerySuggestionsRequest request)
Clears existing query suggestions from an index.
|
CreateDataSourceResult |
createDataSource(CreateDataSourceRequest request)
Creates a data source that you want to use with an Amazon Kendra index.
|
CreateFaqResult |
createFaq(CreateFaqRequest request)
Creates an new set of frequently asked question (FAQ) questions and answers.
|
CreateIndexResult |
createIndex(CreateIndexRequest request)
Creates a new Amazon Kendra index.
|
CreateQuerySuggestionsBlockListResult |
createQuerySuggestionsBlockList(CreateQuerySuggestionsBlockListRequest request)
Creates a block list to exlcude certain queries from suggestions.
|
CreateThesaurusResult |
createThesaurus(CreateThesaurusRequest request)
Creates a thesaurus for an index.
|
DeleteDataSourceResult |
deleteDataSource(DeleteDataSourceRequest request)
Deletes an Amazon Kendra data source.
|
DeleteFaqResult |
deleteFaq(DeleteFaqRequest request)
Removes an FAQ from an index.
|
DeleteIndexResult |
deleteIndex(DeleteIndexRequest request)
Deletes an existing Amazon Kendra index.
|
DeletePrincipalMappingResult |
deletePrincipalMapping(DeletePrincipalMappingRequest request)
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only
available to that group.
|
DeleteQuerySuggestionsBlockListResult |
deleteQuerySuggestionsBlockList(DeleteQuerySuggestionsBlockListRequest request)
Deletes a block list used for query suggestions for an index.
|
DeleteThesaurusResult |
deleteThesaurus(DeleteThesaurusRequest request)
Deletes an existing Amazon Kendra thesaurus.
|
DescribeDataSourceResult |
describeDataSource(DescribeDataSourceRequest request)
Gets information about a Amazon Kendra data source.
|
DescribeFaqResult |
describeFaq(DescribeFaqRequest request)
Gets information about an FAQ list.
|
DescribeIndexResult |
describeIndex(DescribeIndexRequest request)
Describes an existing Amazon Kendra index
|
DescribePrincipalMappingResult |
describePrincipalMapping(DescribePrincipalMappingRequest request)
Describes the processing of
PUT and DELETE actions for mapping users to their groups. |
DescribeQuerySuggestionsBlockListResult |
describeQuerySuggestionsBlockList(DescribeQuerySuggestionsBlockListRequest request)
Describes a block list used for query suggestions for an index.
|
DescribeQuerySuggestionsConfigResult |
describeQuerySuggestionsConfig(DescribeQuerySuggestionsConfigRequest request)
Describes the settings of query suggestions for an index.
|
DescribeThesaurusResult |
describeThesaurus(DescribeThesaurusRequest request)
Describes an existing Amazon Kendra thesaurus.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetQuerySuggestionsResult |
getQuerySuggestions(GetQuerySuggestionsRequest request)
Fetches the queries that are suggested to your users.
|
ListDataSourcesResult |
listDataSources(ListDataSourcesRequest request)
Lists the data sources that you have created.
|
ListDataSourceSyncJobsResult |
listDataSourceSyncJobs(ListDataSourceSyncJobsRequest request)
Gets statistics about synchronizing Amazon Kendra with a data source.
|
ListFaqsResult |
listFaqs(ListFaqsRequest request)
Gets a list of FAQ lists associated with an index.
|
ListGroupsOlderThanOrderingIdResult |
listGroupsOlderThanOrderingId(ListGroupsOlderThanOrderingIdRequest request)
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
|
ListIndicesResult |
listIndices(ListIndicesRequest request)
Lists the Amazon Kendra indexes that you have created.
|
ListQuerySuggestionsBlockListsResult |
listQuerySuggestionsBlockLists(ListQuerySuggestionsBlockListsRequest request)
Lists the block lists used for query suggestions for an index.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Gets a list of tags associated with a specified resource.
|
ListThesauriResult |
listThesauri(ListThesauriRequest request)
Lists the Amazon Kendra thesauri associated with an index.
|
PutPrincipalMappingResult |
putPrincipalMapping(PutPrincipalMappingRequest request)
Maps users to their groups so that you only need to provide the user ID when you issue the query.
|
QueryResult |
query(QueryRequest request)
Searches an active index.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartDataSourceSyncJobResult |
startDataSourceSyncJob(StartDataSourceSyncJobRequest request)
Starts a synchronization job for a data source.
|
StopDataSourceSyncJobResult |
stopDataSourceSyncJob(StopDataSourceSyncJobRequest request)
Stops a running synchronization job.
|
SubmitFeedbackResult |
submitFeedback(SubmitFeedbackRequest request)
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds the specified tag to the specified index, FAQ, or data source resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a tag from an index, FAQ, or a data source.
|
UpdateDataSourceResult |
updateDataSource(UpdateDataSourceRequest request)
Updates an existing Amazon Kendra data source.
|
UpdateIndexResult |
updateIndex(UpdateIndexRequest request)
Updates an existing Amazon Kendra index.
|
UpdateQuerySuggestionsBlockListResult |
updateQuerySuggestionsBlockList(UpdateQuerySuggestionsBlockListRequest request)
Updates a block list used for query suggestions for an index.
|
UpdateQuerySuggestionsConfigResult |
updateQuerySuggestionsConfig(UpdateQuerySuggestionsConfigRequest request)
Updates the settings of query suggestions for an index.
|
UpdateThesaurusResult |
updateThesaurus(UpdateThesaurusRequest request)
Updates a thesaurus file associated with an index.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSkendraClientBuilder builder()
public BatchDeleteDocumentResult batchDeleteDocument(BatchDeleteDocumentRequest request)
Removes one or more documents from an index. The documents must have been added with the
BatchPutDocument
operation.
The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.
batchDeleteDocument
in interface AWSkendra
batchDeleteDocumentRequest
- ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public BatchGetDocumentStatusResult batchGetDocumentStatus(BatchGetDocumentStatusRequest request)
Returns the indexing status for one or more documents submitted with the BatchPutDocument operation.
When you use the BatchPutDocument
operation, documents are indexed asynchronously. You can use the
BatchGetDocumentStatus
operation 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
operation to check the status of the BatchDeleteDocument
operation. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND
as the status.
batchGetDocumentStatus
in interface AWSkendra
batchGetDocumentStatusRequest
- ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public BatchPutDocumentResult batchPutDocument(BatchPutDocumentRequest request)
Adds one or more documents to an index.
The BatchPutDocument
operation enables you to ingest inline documents or a set of documents stored
in an Amazon S3 bucket. Use this operation 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.
batchPutDocument
in interface AWSkendra
batchPutDocumentRequest
- ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
ServiceQuotaExceededException
InternalServerException
public ClearQuerySuggestionsResult clearQuerySuggestions(ClearQuerySuggestionsRequest request)
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
in interface AWSkendra
clearQuerySuggestionsRequest
- ValidationException
ResourceNotFoundException
ThrottlingException
ConflictException
AccessDeniedException
InternalServerException
public CreateDataSourceResult createDataSource(CreateDataSourceRequest request)
Creates a data source 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.
createDataSource
in interface AWSkendra
createDataSourceRequest
- ValidationException
ConflictException
ResourceNotFoundException
ResourceAlreadyExistException
ServiceQuotaExceededException
ThrottlingException
AccessDeniedException
InternalServerException
public CreateFaqResult createFaq(CreateFaqRequest request)
Creates an new set of frequently asked question (FAQ) questions and answers.
createFaq
in interface AWSkendra
createFaqRequest
- ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
ServiceQuotaExceededException
AccessDeniedException
InternalServerException
public CreateIndexResult createIndex(CreateIndexRequest request)
Creates a new Amazon Kendra index. Index creation is an asynchronous operation. 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
operation or using
one of the supported data sources.
createIndex
in interface AWSkendra
createIndexRequest
- ValidationException
ResourceAlreadyExistException
ServiceQuotaExceededException
ThrottlingException
AccessDeniedException
ConflictException
InternalServerException
public CreateQuerySuggestionsBlockListResult createQuerySuggestionsBlockList(CreateQuerySuggestionsBlockListRequest request)
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
in interface AWSkendra
createQuerySuggestionsBlockListRequest
- ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
ServiceQuotaExceededException
ConflictException
InternalServerException
public CreateThesaurusResult createThesaurus(CreateThesaurusRequest request)
Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
createThesaurus
in interface AWSkendra
createThesaurusRequest
- ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
ServiceQuotaExceededException
AccessDeniedException
InternalServerException
public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)
Deletes an Amazon Kendra data source. 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
operation is set to DELETING
. For more information, see Deleting Data Sources.
deleteDataSource
in interface AWSkendra
deleteDataSourceRequest
- AccessDeniedException
ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
InternalServerException
public DeleteFaqResult deleteFaq(DeleteFaqRequest request)
Removes an FAQ from an index.
deleteFaq
in interface AWSkendra
deleteFaqRequest
- ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public DeleteIndexResult deleteIndex(DeleteIndexRequest request)
Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While
the index is being deleted, the Status
field returned by a call to the DescribeIndex
operation is set to DELETING
.
deleteIndex
in interface AWSkendra
deleteIndexRequest
- ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public DeletePrincipalMappingResult deletePrincipalMapping(DeletePrincipalMappingRequest request)
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
in interface AWSkendra
deletePrincipalMappingRequest
- ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public DeleteQuerySuggestionsBlockListResult deleteQuerySuggestionsBlockList(DeleteQuerySuggestionsBlockListRequest request)
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
in interface AWSkendra
deleteQuerySuggestionsBlockListRequest
- ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
ConflictException
InternalServerException
public DeleteThesaurusResult deleteThesaurus(DeleteThesaurusRequest request)
Deletes an existing Amazon Kendra thesaurus.
deleteThesaurus
in interface AWSkendra
deleteThesaurusRequest
- ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public DescribeDataSourceResult describeDataSource(DescribeDataSourceRequest request)
Gets information about a Amazon Kendra data source.
describeDataSource
in interface AWSkendra
describeDataSourceRequest
- ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public DescribeFaqResult describeFaq(DescribeFaqRequest request)
Gets information about an FAQ list.
describeFaq
in interface AWSkendra
describeFaqRequest
- ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public DescribeIndexResult describeIndex(DescribeIndexRequest request)
Describes an existing Amazon Kendra index
describeIndex
in interface AWSkendra
describeIndexRequest
- ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public DescribePrincipalMappingResult describePrincipalMapping(DescribePrincipalMappingRequest request)
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
in interface AWSkendra
describePrincipalMappingRequest
- ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public DescribeQuerySuggestionsBlockListResult describeQuerySuggestionsBlockList(DescribeQuerySuggestionsBlockListRequest request)
Describes 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
in interface AWSkendra
describeQuerySuggestionsBlockListRequest
- ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public DescribeQuerySuggestionsConfigResult describeQuerySuggestionsConfig(DescribeQuerySuggestionsConfigRequest request)
Describes the settings of query suggestions for an index.
This is used to check the current settings applied to query suggestions.
describeQuerySuggestionsConfig
in interface AWSkendra
describeQuerySuggestionsConfigRequest
- ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public DescribeThesaurusResult describeThesaurus(DescribeThesaurusRequest request)
Describes an existing Amazon Kendra thesaurus.
describeThesaurus
in interface AWSkendra
describeThesaurusRequest
- ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public GetQuerySuggestionsResult getQuerySuggestions(GetQuerySuggestionsRequest request)
Fetches the queries that are suggested to your users.
getQuerySuggestions
in interface AWSkendra
getQuerySuggestionsRequest
- ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
ServiceQuotaExceededException
ConflictException
InternalServerException
public ListDataSourceSyncJobsResult listDataSourceSyncJobs(ListDataSourceSyncJobsRequest request)
Gets statistics about synchronizing Amazon Kendra with a data source.
listDataSourceSyncJobs
in interface AWSkendra
listDataSourceSyncJobsRequest
- ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
ConflictException
InternalServerException
public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
Lists the data sources that you have created.
listDataSources
in interface AWSkendra
listDataSourcesRequest
- ValidationException
ResourceNotFoundException
AccessDeniedException
ThrottlingException
InternalServerException
public ListFaqsResult listFaqs(ListFaqsRequest request)
Gets a list of FAQ lists associated with an index.
listFaqs
in interface AWSkendra
listFaqsRequest
- ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public ListGroupsOlderThanOrderingIdResult listGroupsOlderThanOrderingId(ListGroupsOlderThanOrderingIdRequest request)
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
listGroupsOlderThanOrderingId
in interface AWSkendra
listGroupsOlderThanOrderingIdRequest
- ValidationException
ResourceNotFoundException
AccessDeniedException
ThrottlingException
ConflictException
InternalServerException
public ListIndicesResult listIndices(ListIndicesRequest request)
Lists the Amazon Kendra indexes that you have created.
listIndices
in interface AWSkendra
listIndicesRequest
- ValidationException
ThrottlingException
AccessDeniedException
InternalServerException
public ListQuerySuggestionsBlockListsResult listQuerySuggestionsBlockLists(ListQuerySuggestionsBlockListsRequest request)
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
in interface AWSkendra
listQuerySuggestionsBlockListsRequest
- ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
listTagsForResource
in interface AWSkendra
listTagsForResourceRequest
- ValidationException
ResourceUnavailableException
ThrottlingException
AccessDeniedException
InternalServerException
public ListThesauriResult listThesauri(ListThesauriRequest request)
Lists the Amazon Kendra thesauri associated with an index.
listThesauri
in interface AWSkendra
listThesauriRequest
- ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public PutPrincipalMappingResult putPrincipalMapping(PutPrincipalMappingRequest request)
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.
You map users to their groups when you want to filter search results for different users based on their group’s access to documents. For more information on filtering search results for different users, see Filtering on user context.
If more than five PUT
actions for a group are currently processing, a validation exception is
thrown.
putPrincipalMapping
in interface AWSkendra
putPrincipalMappingRequest
- ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
ServiceQuotaExceededException
InternalServerException
public QueryResult query(QueryRequest request)
Searches an active index. Use this API to search your documents using query. The Query
operation
enables to do faceted search and to filter results based on document attributes.
It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.
Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.
Relevant passages
Matching FAQs
Relevant documents
You can specify that the query return only one type of result using the QueryResultTypeConfig
parameter.
Each query returns the 100 most relevant results.
query
in interface AWSkendra
queryRequest
- ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
ServiceQuotaExceededException
InternalServerException
public StartDataSourceSyncJobResult startDataSourceSyncJob(StartDataSourceSyncJobRequest request)
Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra
returns a ResourceInUseException
exception.
startDataSourceSyncJob
in interface AWSkendra
startDataSourceSyncJobRequest
- ValidationException
ResourceNotFoundException
ResourceInUseException
ThrottlingException
AccessDeniedException
ConflictException
InternalServerException
public StopDataSourceSyncJobResult stopDataSourceSyncJob(StopDataSourceSyncJobRequest request)
Stops a running synchronization job. You can't stop a scheduled synchronization job.
stopDataSourceSyncJob
in interface AWSkendra
stopDataSourceSyncJobRequest
- ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public SubmitFeedbackResult submitFeedback(SubmitFeedbackRequest request)
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
submitFeedback
in interface AWSkendra
submitFeedbackRequest
- ValidationException
ResourceUnavailableException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource
in interface AWSkendra
tagResourceRequest
- ValidationException
ResourceUnavailableException
ThrottlingException
AccessDeniedException
InternalServerException
public UntagResourceResult untagResource(UntagResourceRequest request)
Removes a tag from an index, FAQ, or a data source.
untagResource
in interface AWSkendra
untagResourceRequest
- ValidationException
ResourceUnavailableException
ThrottlingException
AccessDeniedException
InternalServerException
public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)
Updates an existing Amazon Kendra data source.
updateDataSource
in interface AWSkendra
updateDataSourceRequest
- ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public UpdateIndexResult updateIndex(UpdateIndexRequest request)
Updates an existing Amazon Kendra index.
updateIndex
in interface AWSkendra
updateIndexRequest
- ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
ServiceQuotaExceededException
InternalServerException
public UpdateQuerySuggestionsBlockListResult updateQuerySuggestionsBlockList(UpdateQuerySuggestionsBlockListRequest request)
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
in interface AWSkendra
updateQuerySuggestionsBlockListRequest
- ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
ConflictException
InternalServerException
public UpdateQuerySuggestionsConfigResult updateQuerySuggestionsConfig(UpdateQuerySuggestionsConfigRequest request)
Updates the settings of query suggestions for an index.
Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
If an update is currently processing (i.e. 'happening'), you need to wait for the update to finish before making another update.
Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.
You can still enable/disable query suggestions at any time.
updateQuerySuggestionsConfig
in interface AWSkendra
updateQuerySuggestionsConfigRequest
- ValidationException
ConflictException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
InternalServerException
public UpdateThesaurusResult updateThesaurus(UpdateThesaurusRequest request)
Updates a thesaurus file associated with an index.
updateThesaurus
in interface AWSkendra
updateThesaurusRequest
- ValidationException
ResourceNotFoundException
ThrottlingException
AccessDeniedException
ConflictException
InternalServerException
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata
in interface AWSkendra
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSkendra
shutdown
in class AmazonWebServiceClient