@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSkendraAsyncClient extends AWSkendraClient implements AWSkendraAsync
AsyncHandler can be used to receive notification when
an asynchronous operation completes.
Amazon Kendra is a service for indexing large document sets.
configFactoryclient, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIXassociateEntitiesToExperience, associatePersonasToEntities, batchDeleteDocument, batchGetDocumentStatus, batchPutDocument, builder, clearQuerySuggestions, createDataSource, createExperience, createFaq, createIndex, createQuerySuggestionsBlockList, createThesaurus, deleteDataSource, deleteExperience, deleteFaq, deleteIndex, deletePrincipalMapping, deleteQuerySuggestionsBlockList, deleteThesaurus, describeDataSource, describeExperience, describeFaq, describeIndex, describePrincipalMapping, describeQuerySuggestionsBlockList, describeQuerySuggestionsConfig, describeThesaurus, disassociateEntitiesFromExperience, disassociatePersonasFromEntities, getCachedResponseMetadata, getQuerySuggestions, getSnapshots, listDataSources, listDataSourceSyncJobs, listEntityPersonas, listExperienceEntities, listExperiences, listFaqs, listGroupsOlderThanOrderingId, listIndices, listQuerySuggestionsBlockLists, listTagsForResource, listThesauri, putPrincipalMapping, query, startDataSourceSyncJob, stopDataSourceSyncJob, submitFeedback, tagResource, untagResource, updateDataSource, updateExperience, updateIndex, updateQuerySuggestionsBlockList, updateQuerySuggestionsConfig, updateThesaurusaddRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitassociateEntitiesToExperience, associatePersonasToEntities, batchDeleteDocument, batchGetDocumentStatus, batchPutDocument, clearQuerySuggestions, createDataSource, createExperience, createFaq, createIndex, createQuerySuggestionsBlockList, createThesaurus, deleteDataSource, deleteExperience, deleteFaq, deleteIndex, deletePrincipalMapping, deleteQuerySuggestionsBlockList, deleteThesaurus, describeDataSource, describeExperience, describeFaq, describeIndex, describePrincipalMapping, describeQuerySuggestionsBlockList, describeQuerySuggestionsConfig, describeThesaurus, disassociateEntitiesFromExperience, disassociatePersonasFromEntities, getCachedResponseMetadata, getQuerySuggestions, getSnapshots, listDataSources, listDataSourceSyncJobs, listEntityPersonas, listExperienceEntities, listExperiences, listFaqs, listGroupsOlderThanOrderingId, listIndices, listQuerySuggestionsBlockLists, listTagsForResource, listThesauri, putPrincipalMapping, query, startDataSourceSyncJob, stopDataSourceSyncJob, submitFeedback, tagResource, untagResource, updateDataSource, updateExperience, updateIndex, updateQuerySuggestionsBlockList, updateQuerySuggestionsConfig, updateThesauruspublic static AWSkendraAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AssociateEntitiesToExperienceResult> associateEntitiesToExperienceAsync(AssociateEntitiesToExperienceRequest request)
AWSkendraAsyncGrants users or groups in your Amazon Web Services SSO 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.
associateEntitiesToExperienceAsync in interface AWSkendraAsyncpublic Future<AssociateEntitiesToExperienceResult> associateEntitiesToExperienceAsync(AssociateEntitiesToExperienceRequest request, AsyncHandler<AssociateEntitiesToExperienceRequest,AssociateEntitiesToExperienceResult> asyncHandler)
AWSkendraAsyncGrants users or groups in your Amazon Web Services SSO 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.
associateEntitiesToExperienceAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AssociatePersonasToEntitiesResult> associatePersonasToEntitiesAsync(AssociatePersonasToEntitiesRequest request)
AWSkendraAsyncDefines the specific permissions of users or groups in your Amazon Web Services SSO 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.
associatePersonasToEntitiesAsync in interface AWSkendraAsyncpublic Future<AssociatePersonasToEntitiesResult> associatePersonasToEntitiesAsync(AssociatePersonasToEntitiesRequest request, AsyncHandler<AssociatePersonasToEntitiesRequest,AssociatePersonasToEntitiesResult> asyncHandler)
AWSkendraAsyncDefines the specific permissions of users or groups in your Amazon Web Services SSO 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.
associatePersonasToEntitiesAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<BatchDeleteDocumentResult> batchDeleteDocumentAsync(BatchDeleteDocumentRequest request)
AWSkendraAsync
Removes one or more documents from an index. The documents must have been added with the
BatchPutDocument API.
The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.
batchDeleteDocumentAsync in interface AWSkendraAsyncpublic Future<BatchDeleteDocumentResult> batchDeleteDocumentAsync(BatchDeleteDocumentRequest request, AsyncHandler<BatchDeleteDocumentRequest,BatchDeleteDocumentResult> asyncHandler)
AWSkendraAsync
Removes one or more documents from an index. The documents must have been added with the
BatchPutDocument API.
The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.
batchDeleteDocumentAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<BatchGetDocumentStatusResult> batchGetDocumentStatusAsync(BatchGetDocumentStatusRequest request)
AWSkendraAsyncReturns 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.
batchGetDocumentStatusAsync in interface AWSkendraAsyncpublic Future<BatchGetDocumentStatusResult> batchGetDocumentStatusAsync(BatchGetDocumentStatusRequest request, AsyncHandler<BatchGetDocumentStatusRequest,BatchGetDocumentStatusResult> asyncHandler)
AWSkendraAsyncReturns 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.
batchGetDocumentStatusAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<BatchPutDocumentResult> batchPutDocumentAsync(BatchPutDocumentRequest request)
AWSkendraAsyncAdds 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.
batchPutDocumentAsync in interface AWSkendraAsyncpublic Future<BatchPutDocumentResult> batchPutDocumentAsync(BatchPutDocumentRequest request, AsyncHandler<BatchPutDocumentRequest,BatchPutDocumentResult> asyncHandler)
AWSkendraAsyncAdds 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.
batchPutDocumentAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ClearQuerySuggestionsResult> clearQuerySuggestionsAsync(ClearQuerySuggestionsRequest request)
AWSkendraAsyncClears 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.
clearQuerySuggestionsAsync in interface AWSkendraAsyncpublic Future<ClearQuerySuggestionsResult> clearQuerySuggestionsAsync(ClearQuerySuggestionsRequest request, AsyncHandler<ClearQuerySuggestionsRequest,ClearQuerySuggestionsResult> asyncHandler)
AWSkendraAsyncClears 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.
clearQuerySuggestionsAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest request)
AWSkendraAsyncCreates 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.
Amazon S3 and custom data sources are the only supported data sources in the Amazon Web Services GovCloud (US-West) region.
createDataSourceAsync in interface AWSkendraAsyncpublic Future<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest request, AsyncHandler<CreateDataSourceRequest,CreateDataSourceResult> asyncHandler)
AWSkendraAsyncCreates 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.
Amazon S3 and custom data sources are the only supported data sources in the Amazon Web Services GovCloud (US-West) region.
createDataSourceAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateExperienceResult> createExperienceAsync(CreateExperienceRequest request)
AWSkendraAsyncCreates 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.
createExperienceAsync in interface AWSkendraAsyncpublic Future<CreateExperienceResult> createExperienceAsync(CreateExperienceRequest request, AsyncHandler<CreateExperienceRequest,CreateExperienceResult> asyncHandler)
AWSkendraAsyncCreates 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.
createExperienceAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateFaqResult> createFaqAsync(CreateFaqRequest request)
AWSkendraAsyncCreates an new set of frequently asked question (FAQ) questions and answers.
Adding FAQs to an index is an asynchronous operation.
createFaqAsync in interface AWSkendraAsyncpublic Future<CreateFaqResult> createFaqAsync(CreateFaqRequest request, AsyncHandler<CreateFaqRequest,CreateFaqResult> asyncHandler)
AWSkendraAsyncCreates an new set of frequently asked question (FAQ) questions and answers.
Adding FAQs to an index is an asynchronous operation.
createFaqAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateIndexResult> createIndexAsync(CreateIndexRequest request)
AWSkendraAsync
Creates a new 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.
createIndexAsync in interface AWSkendraAsyncpublic Future<CreateIndexResult> createIndexAsync(CreateIndexRequest request, AsyncHandler<CreateIndexRequest,CreateIndexResult> asyncHandler)
AWSkendraAsync
Creates a new 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.
createIndexAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateQuerySuggestionsBlockListResult> createQuerySuggestionsBlockListAsync(CreateQuerySuggestionsBlockListRequest request)
AWSkendraAsyncCreates 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.
createQuerySuggestionsBlockListAsync in interface AWSkendraAsyncpublic Future<CreateQuerySuggestionsBlockListResult> createQuerySuggestionsBlockListAsync(CreateQuerySuggestionsBlockListRequest request, AsyncHandler<CreateQuerySuggestionsBlockListRequest,CreateQuerySuggestionsBlockListResult> asyncHandler)
AWSkendraAsyncCreates 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.
createQuerySuggestionsBlockListAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateThesaurusResult> createThesaurusAsync(CreateThesaurusRequest request)
AWSkendraAsyncCreates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
createThesaurusAsync in interface AWSkendraAsyncpublic Future<CreateThesaurusResult> createThesaurusAsync(CreateThesaurusRequest request, AsyncHandler<CreateThesaurusRequest,CreateThesaurusResult> asyncHandler)
AWSkendraAsyncCreates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
createThesaurusAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDataSourceResult> deleteDataSourceAsync(DeleteDataSourceRequest request)
AWSkendraAsync
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 API is set to DELETING. For more information, see Deleting Data Sources.
deleteDataSourceAsync in interface AWSkendraAsyncpublic Future<DeleteDataSourceResult> deleteDataSourceAsync(DeleteDataSourceRequest request, AsyncHandler<DeleteDataSourceRequest,DeleteDataSourceResult> asyncHandler)
AWSkendraAsync
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 API is set to DELETING. For more information, see Deleting Data Sources.
deleteDataSourceAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteExperienceResult> deleteExperienceAsync(DeleteExperienceRequest request)
AWSkendraAsyncDeletes 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.
deleteExperienceAsync in interface AWSkendraAsyncpublic Future<DeleteExperienceResult> deleteExperienceAsync(DeleteExperienceRequest request, AsyncHandler<DeleteExperienceRequest,DeleteExperienceResult> asyncHandler)
AWSkendraAsyncDeletes 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.
deleteExperienceAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteFaqResult> deleteFaqAsync(DeleteFaqRequest request)
AWSkendraAsyncRemoves an FAQ from an index.
deleteFaqAsync in interface AWSkendraAsyncpublic Future<DeleteFaqResult> deleteFaqAsync(DeleteFaqRequest request, AsyncHandler<DeleteFaqRequest,DeleteFaqResult> asyncHandler)
AWSkendraAsyncRemoves an FAQ from an index.
deleteFaqAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteIndexResult> deleteIndexAsync(DeleteIndexRequest request)
AWSkendraAsync
Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While
the index is being deleted, the Status field returned by a call to the DescribeIndex
API is set to DELETING.
deleteIndexAsync in interface AWSkendraAsyncpublic Future<DeleteIndexResult> deleteIndexAsync(DeleteIndexRequest request, AsyncHandler<DeleteIndexRequest,DeleteIndexResult> asyncHandler)
AWSkendraAsync
Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While
the index is being deleted, the Status field returned by a call to the DescribeIndex
API is set to DELETING.
deleteIndexAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeletePrincipalMappingResult> deletePrincipalMappingAsync(DeletePrincipalMappingRequest request)
AWSkendraAsyncDeletes 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.
deletePrincipalMappingAsync in interface AWSkendraAsyncpublic Future<DeletePrincipalMappingResult> deletePrincipalMappingAsync(DeletePrincipalMappingRequest request, AsyncHandler<DeletePrincipalMappingRequest,DeletePrincipalMappingResult> asyncHandler)
AWSkendraAsyncDeletes 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.
deletePrincipalMappingAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteQuerySuggestionsBlockListResult> deleteQuerySuggestionsBlockListAsync(DeleteQuerySuggestionsBlockListRequest request)
AWSkendraAsyncDeletes 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.
deleteQuerySuggestionsBlockListAsync in interface AWSkendraAsyncpublic Future<DeleteQuerySuggestionsBlockListResult> deleteQuerySuggestionsBlockListAsync(DeleteQuerySuggestionsBlockListRequest request, AsyncHandler<DeleteQuerySuggestionsBlockListRequest,DeleteQuerySuggestionsBlockListResult> asyncHandler)
AWSkendraAsyncDeletes 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.
deleteQuerySuggestionsBlockListAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteThesaurusResult> deleteThesaurusAsync(DeleteThesaurusRequest request)
AWSkendraAsyncDeletes an existing Amazon Kendra thesaurus.
deleteThesaurusAsync in interface AWSkendraAsyncpublic Future<DeleteThesaurusResult> deleteThesaurusAsync(DeleteThesaurusRequest request, AsyncHandler<DeleteThesaurusRequest,DeleteThesaurusResult> asyncHandler)
AWSkendraAsyncDeletes an existing Amazon Kendra thesaurus.
deleteThesaurusAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDataSourceResult> describeDataSourceAsync(DescribeDataSourceRequest request)
AWSkendraAsyncGets information about an Amazon Kendra data source.
describeDataSourceAsync in interface AWSkendraAsyncpublic Future<DescribeDataSourceResult> describeDataSourceAsync(DescribeDataSourceRequest request, AsyncHandler<DescribeDataSourceRequest,DescribeDataSourceResult> asyncHandler)
AWSkendraAsyncGets information about an Amazon Kendra data source.
describeDataSourceAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeExperienceResult> describeExperienceAsync(DescribeExperienceRequest request)
AWSkendraAsyncGets 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.
describeExperienceAsync in interface AWSkendraAsyncpublic Future<DescribeExperienceResult> describeExperienceAsync(DescribeExperienceRequest request, AsyncHandler<DescribeExperienceRequest,DescribeExperienceResult> asyncHandler)
AWSkendraAsyncGets 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.
describeExperienceAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeFaqResult> describeFaqAsync(DescribeFaqRequest request)
AWSkendraAsyncGets information about an FAQ list.
describeFaqAsync in interface AWSkendraAsyncpublic Future<DescribeFaqResult> describeFaqAsync(DescribeFaqRequest request, AsyncHandler<DescribeFaqRequest,DescribeFaqResult> asyncHandler)
AWSkendraAsyncGets information about an FAQ list.
describeFaqAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeIndexResult> describeIndexAsync(DescribeIndexRequest request)
AWSkendraAsyncDescribes an existing Amazon Kendra index.
describeIndexAsync in interface AWSkendraAsyncpublic Future<DescribeIndexResult> describeIndexAsync(DescribeIndexRequest request, AsyncHandler<DescribeIndexRequest,DescribeIndexResult> asyncHandler)
AWSkendraAsyncDescribes an existing Amazon Kendra index.
describeIndexAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribePrincipalMappingResult> describePrincipalMappingAsync(DescribePrincipalMappingRequest request)
AWSkendraAsync
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.
describePrincipalMappingAsync in interface AWSkendraAsyncpublic Future<DescribePrincipalMappingResult> describePrincipalMappingAsync(DescribePrincipalMappingRequest request, AsyncHandler<DescribePrincipalMappingRequest,DescribePrincipalMappingResult> asyncHandler)
AWSkendraAsync
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.
describePrincipalMappingAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeQuerySuggestionsBlockListResult> describeQuerySuggestionsBlockListAsync(DescribeQuerySuggestionsBlockListRequest request)
AWSkendraAsyncDescribes 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.
describeQuerySuggestionsBlockListAsync in interface AWSkendraAsyncpublic Future<DescribeQuerySuggestionsBlockListResult> describeQuerySuggestionsBlockListAsync(DescribeQuerySuggestionsBlockListRequest request, AsyncHandler<DescribeQuerySuggestionsBlockListRequest,DescribeQuerySuggestionsBlockListResult> asyncHandler)
AWSkendraAsyncDescribes 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.
describeQuerySuggestionsBlockListAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeQuerySuggestionsConfigResult> describeQuerySuggestionsConfigAsync(DescribeQuerySuggestionsConfigRequest request)
AWSkendraAsyncDescribes 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.
describeQuerySuggestionsConfigAsync in interface AWSkendraAsyncpublic Future<DescribeQuerySuggestionsConfigResult> describeQuerySuggestionsConfigAsync(DescribeQuerySuggestionsConfigRequest request, AsyncHandler<DescribeQuerySuggestionsConfigRequest,DescribeQuerySuggestionsConfigResult> asyncHandler)
AWSkendraAsyncDescribes 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.
describeQuerySuggestionsConfigAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeThesaurusResult> describeThesaurusAsync(DescribeThesaurusRequest request)
AWSkendraAsyncDescribes an existing Amazon Kendra thesaurus.
describeThesaurusAsync in interface AWSkendraAsyncpublic Future<DescribeThesaurusResult> describeThesaurusAsync(DescribeThesaurusRequest request, AsyncHandler<DescribeThesaurusRequest,DescribeThesaurusResult> asyncHandler)
AWSkendraAsyncDescribes an existing Amazon Kendra thesaurus.
describeThesaurusAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociateEntitiesFromExperienceResult> disassociateEntitiesFromExperienceAsync(DisassociateEntitiesFromExperienceRequest request)
AWSkendraAsyncPrevents users or groups in your Amazon Web Services SSO 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.
disassociateEntitiesFromExperienceAsync in interface AWSkendraAsyncpublic Future<DisassociateEntitiesFromExperienceResult> disassociateEntitiesFromExperienceAsync(DisassociateEntitiesFromExperienceRequest request, AsyncHandler<DisassociateEntitiesFromExperienceRequest,DisassociateEntitiesFromExperienceResult> asyncHandler)
AWSkendraAsyncPrevents users or groups in your Amazon Web Services SSO 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.
disassociateEntitiesFromExperienceAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisassociatePersonasFromEntitiesResult> disassociatePersonasFromEntitiesAsync(DisassociatePersonasFromEntitiesRequest request)
AWSkendraAsyncRemoves the specific permissions of users or groups in your Amazon Web Services SSO 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.
disassociatePersonasFromEntitiesAsync in interface AWSkendraAsyncpublic Future<DisassociatePersonasFromEntitiesResult> disassociatePersonasFromEntitiesAsync(DisassociatePersonasFromEntitiesRequest request, AsyncHandler<DisassociatePersonasFromEntitiesRequest,DisassociatePersonasFromEntitiesResult> asyncHandler)
AWSkendraAsyncRemoves the specific permissions of users or groups in your Amazon Web Services SSO 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.
disassociatePersonasFromEntitiesAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetQuerySuggestionsResult> getQuerySuggestionsAsync(GetQuerySuggestionsRequest request)
AWSkendraAsyncFetches the queries that are suggested to your users.
GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.
getQuerySuggestionsAsync in interface AWSkendraAsyncpublic Future<GetQuerySuggestionsResult> getQuerySuggestionsAsync(GetQuerySuggestionsRequest request, AsyncHandler<GetQuerySuggestionsRequest,GetQuerySuggestionsResult> asyncHandler)
AWSkendraAsyncFetches the queries that are suggested to your users.
GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.
getQuerySuggestionsAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetSnapshotsResult> getSnapshotsAsync(GetSnapshotsRequest request)
AWSkendraAsyncRetrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.
getSnapshotsAsync in interface AWSkendraAsyncpublic Future<GetSnapshotsResult> getSnapshotsAsync(GetSnapshotsRequest request, AsyncHandler<GetSnapshotsRequest,GetSnapshotsResult> asyncHandler)
AWSkendraAsyncRetrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.
getSnapshotsAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDataSourceSyncJobsResult> listDataSourceSyncJobsAsync(ListDataSourceSyncJobsRequest request)
AWSkendraAsyncGets statistics about synchronizing Amazon Kendra with a data source.
listDataSourceSyncJobsAsync in interface AWSkendraAsyncpublic Future<ListDataSourceSyncJobsResult> listDataSourceSyncJobsAsync(ListDataSourceSyncJobsRequest request, AsyncHandler<ListDataSourceSyncJobsRequest,ListDataSourceSyncJobsResult> asyncHandler)
AWSkendraAsyncGets statistics about synchronizing Amazon Kendra with a data source.
listDataSourceSyncJobsAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest request)
AWSkendraAsyncLists the data sources that you have created.
listDataSourcesAsync in interface AWSkendraAsyncpublic Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest request, AsyncHandler<ListDataSourcesRequest,ListDataSourcesResult> asyncHandler)
AWSkendraAsyncLists the data sources that you have created.
listDataSourcesAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListEntityPersonasResult> listEntityPersonasAsync(ListEntityPersonasRequest request)
AWSkendraAsyncLists specific permissions of users and groups with access to your Amazon Kendra experience.
listEntityPersonasAsync in interface AWSkendraAsyncpublic Future<ListEntityPersonasResult> listEntityPersonasAsync(ListEntityPersonasRequest request, AsyncHandler<ListEntityPersonasRequest,ListEntityPersonasResult> asyncHandler)
AWSkendraAsyncLists specific permissions of users and groups with access to your Amazon Kendra experience.
listEntityPersonasAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListExperienceEntitiesResult> listExperienceEntitiesAsync(ListExperienceEntitiesRequest request)
AWSkendraAsyncLists users or groups in your Amazon Web Services SSO 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.
listExperienceEntitiesAsync in interface AWSkendraAsyncpublic Future<ListExperienceEntitiesResult> listExperienceEntitiesAsync(ListExperienceEntitiesRequest request, AsyncHandler<ListExperienceEntitiesRequest,ListExperienceEntitiesResult> asyncHandler)
AWSkendraAsyncLists users or groups in your Amazon Web Services SSO 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.
listExperienceEntitiesAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListExperiencesResult> listExperiencesAsync(ListExperiencesRequest request)
AWSkendraAsyncLists 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.
listExperiencesAsync in interface AWSkendraAsyncpublic Future<ListExperiencesResult> listExperiencesAsync(ListExperiencesRequest request, AsyncHandler<ListExperiencesRequest,ListExperiencesResult> asyncHandler)
AWSkendraAsyncLists 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.
listExperiencesAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListFaqsResult> listFaqsAsync(ListFaqsRequest request)
AWSkendraAsyncGets a list of FAQ lists associated with an index.
listFaqsAsync in interface AWSkendraAsyncpublic Future<ListFaqsResult> listFaqsAsync(ListFaqsRequest request, AsyncHandler<ListFaqsRequest,ListFaqsResult> asyncHandler)
AWSkendraAsyncGets a list of FAQ lists associated with an index.
listFaqsAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListGroupsOlderThanOrderingIdResult> listGroupsOlderThanOrderingIdAsync(ListGroupsOlderThanOrderingIdRequest request)
AWSkendraAsyncProvides 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.
listGroupsOlderThanOrderingIdAsync in interface AWSkendraAsyncpublic Future<ListGroupsOlderThanOrderingIdResult> listGroupsOlderThanOrderingIdAsync(ListGroupsOlderThanOrderingIdRequest request, AsyncHandler<ListGroupsOlderThanOrderingIdRequest,ListGroupsOlderThanOrderingIdResult> asyncHandler)
AWSkendraAsyncProvides 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.
listGroupsOlderThanOrderingIdAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListIndicesResult> listIndicesAsync(ListIndicesRequest request)
AWSkendraAsyncLists the Amazon Kendra indexes that you created.
listIndicesAsync in interface AWSkendraAsyncpublic Future<ListIndicesResult> listIndicesAsync(ListIndicesRequest request, AsyncHandler<ListIndicesRequest,ListIndicesResult> asyncHandler)
AWSkendraAsyncLists the Amazon Kendra indexes that you created.
listIndicesAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListQuerySuggestionsBlockListsResult> listQuerySuggestionsBlockListsAsync(ListQuerySuggestionsBlockListsRequest request)
AWSkendraAsyncLists 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.
listQuerySuggestionsBlockListsAsync in interface AWSkendraAsyncpublic Future<ListQuerySuggestionsBlockListsResult> listQuerySuggestionsBlockListsAsync(ListQuerySuggestionsBlockListsRequest request, AsyncHandler<ListQuerySuggestionsBlockListsRequest,ListQuerySuggestionsBlockListsResult> asyncHandler)
AWSkendraAsyncLists 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.
listQuerySuggestionsBlockListsAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSkendraAsyncGets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
listTagsForResourceAsync in interface AWSkendraAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSkendraAsyncGets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
listTagsForResourceAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListThesauriResult> listThesauriAsync(ListThesauriRequest request)
AWSkendraAsyncLists the Amazon Kendra thesauri associated with an index.
listThesauriAsync in interface AWSkendraAsyncpublic Future<ListThesauriResult> listThesauriAsync(ListThesauriRequest request, AsyncHandler<ListThesauriRequest,ListThesauriResult> asyncHandler)
AWSkendraAsyncLists the Amazon Kendra thesauri associated with an index.
listThesauriAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutPrincipalMappingResult> putPrincipalMappingAsync(PutPrincipalMappingRequest request)
AWSkendraAsyncMaps 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 is currently not supported in the Amazon Web Services GovCloud (US-West) region.
putPrincipalMappingAsync in interface AWSkendraAsyncpublic Future<PutPrincipalMappingResult> putPrincipalMappingAsync(PutPrincipalMappingRequest request, AsyncHandler<PutPrincipalMappingRequest,PutPrincipalMappingResult> asyncHandler)
AWSkendraAsyncMaps 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 is currently not supported in the Amazon Web Services GovCloud (US-West) region.
putPrincipalMappingAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<QueryResult> queryAsync(QueryRequest request)
AWSkendraAsync
Searches an active index. Use this API to search your documents using query. The Query API enables
to do faceted search and to filter results based on document attributes.
It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.
Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.
Relevant passages
Matching FAQs
Relevant documents
You can specify that the query return only one type of result using the QueryResultTypeConfig
parameter.
Each query returns the 100 most relevant results.
queryAsync in interface AWSkendraAsyncpublic Future<QueryResult> queryAsync(QueryRequest request, AsyncHandler<QueryRequest,QueryResult> asyncHandler)
AWSkendraAsync
Searches an active index. Use this API to search your documents using query. The Query API enables
to do faceted search and to filter results based on document attributes.
It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.
Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.
Relevant passages
Matching FAQs
Relevant documents
You can specify that the query return only one type of result using the QueryResultTypeConfig
parameter.
Each query returns the 100 most relevant results.
queryAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartDataSourceSyncJobResult> startDataSourceSyncJobAsync(StartDataSourceSyncJobRequest request)
AWSkendraAsync
Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra
returns a ResourceInUseException exception.
startDataSourceSyncJobAsync in interface AWSkendraAsyncpublic Future<StartDataSourceSyncJobResult> startDataSourceSyncJobAsync(StartDataSourceSyncJobRequest request, AsyncHandler<StartDataSourceSyncJobRequest,StartDataSourceSyncJobResult> asyncHandler)
AWSkendraAsync
Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra
returns a ResourceInUseException exception.
startDataSourceSyncJobAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StopDataSourceSyncJobResult> stopDataSourceSyncJobAsync(StopDataSourceSyncJobRequest request)
AWSkendraAsyncStops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
stopDataSourceSyncJobAsync in interface AWSkendraAsyncpublic Future<StopDataSourceSyncJobResult> stopDataSourceSyncJobAsync(StopDataSourceSyncJobRequest request, AsyncHandler<StopDataSourceSyncJobRequest,StopDataSourceSyncJobResult> asyncHandler)
AWSkendraAsyncStops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
stopDataSourceSyncJobAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SubmitFeedbackResult> submitFeedbackAsync(SubmitFeedbackRequest request)
AWSkendraAsyncEnables 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.
submitFeedbackAsync in interface AWSkendraAsyncpublic Future<SubmitFeedbackResult> submitFeedbackAsync(SubmitFeedbackRequest request, AsyncHandler<SubmitFeedbackRequest,SubmitFeedbackResult> asyncHandler)
AWSkendraAsyncEnables 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.
submitFeedbackAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSkendraAsyncAdds 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.
tagResourceAsync in interface AWSkendraAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSkendraAsyncAdds 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.
tagResourceAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSkendraAsyncRemoves a tag from an index, FAQ, or a data source.
untagResourceAsync in interface AWSkendraAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSkendraAsyncRemoves a tag from an index, FAQ, or a data source.
untagResourceAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest request)
AWSkendraAsyncUpdates an existing Amazon Kendra data source.
updateDataSourceAsync in interface AWSkendraAsyncpublic Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest request, AsyncHandler<UpdateDataSourceRequest,UpdateDataSourceResult> asyncHandler)
AWSkendraAsyncUpdates an existing Amazon Kendra data source.
updateDataSourceAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateExperienceResult> updateExperienceAsync(UpdateExperienceRequest request)
AWSkendraAsyncUpdates 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.
updateExperienceAsync in interface AWSkendraAsyncpublic Future<UpdateExperienceResult> updateExperienceAsync(UpdateExperienceRequest request, AsyncHandler<UpdateExperienceRequest,UpdateExperienceResult> asyncHandler)
AWSkendraAsyncUpdates 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.
updateExperienceAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateIndexResult> updateIndexAsync(UpdateIndexRequest request)
AWSkendraAsyncUpdates an existing Amazon Kendra index.
updateIndexAsync in interface AWSkendraAsyncpublic Future<UpdateIndexResult> updateIndexAsync(UpdateIndexRequest request, AsyncHandler<UpdateIndexRequest,UpdateIndexResult> asyncHandler)
AWSkendraAsyncUpdates an existing Amazon Kendra index.
updateIndexAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateQuerySuggestionsBlockListResult> updateQuerySuggestionsBlockListAsync(UpdateQuerySuggestionsBlockListRequest request)
AWSkendraAsyncUpdates 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.
updateQuerySuggestionsBlockListAsync in interface AWSkendraAsyncpublic Future<UpdateQuerySuggestionsBlockListResult> updateQuerySuggestionsBlockListAsync(UpdateQuerySuggestionsBlockListRequest request, AsyncHandler<UpdateQuerySuggestionsBlockListRequest,UpdateQuerySuggestionsBlockListResult> asyncHandler)
AWSkendraAsyncUpdates 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.
updateQuerySuggestionsBlockListAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateQuerySuggestionsConfigResult> updateQuerySuggestionsConfigAsync(UpdateQuerySuggestionsConfigRequest request)
AWSkendraAsyncUpdates the settings of query suggestions for an index.
Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
If an update is currently processing (i.e. 'happening'), you need to wait for the update to finish before making another update.
Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.
You can still enable/disable query suggestions at any time.
UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
updateQuerySuggestionsConfigAsync in interface AWSkendraAsyncpublic Future<UpdateQuerySuggestionsConfigResult> updateQuerySuggestionsConfigAsync(UpdateQuerySuggestionsConfigRequest request, AsyncHandler<UpdateQuerySuggestionsConfigRequest,UpdateQuerySuggestionsConfigResult> asyncHandler)
AWSkendraAsyncUpdates the settings of query suggestions for an index.
Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
If an update is currently processing (i.e. 'happening'), you need to wait for the update to finish before making another update.
Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.
You can still enable/disable query suggestions at any time.
UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
updateQuerySuggestionsConfigAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateThesaurusResult> updateThesaurusAsync(UpdateThesaurusRequest request)
AWSkendraAsyncUpdates a thesaurus file associated with an index.
updateThesaurusAsync in interface AWSkendraAsyncpublic Future<UpdateThesaurusResult> updateThesaurusAsync(UpdateThesaurusRequest request, AsyncHandler<UpdateThesaurusRequest,UpdateThesaurusResult> asyncHandler)
AWSkendraAsyncUpdates a thesaurus file associated with an index.
updateThesaurusAsync in interface AWSkendraAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSkendrashutdown in class AWSkendraClientCopyright © 2022. All rights reserved.