@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSkendraAsync extends AWSkendra
AsyncHandler can be used to receive notification when
an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSkendraAsync instead.
Amazon Kendra is a service for indexing large document sets.
ENDPOINT_PREFIXbatchDeleteDocument, batchGetDocumentStatus, batchPutDocument, clearQuerySuggestions, createDataSource, createFaq, createIndex, createQuerySuggestionsBlockList, createThesaurus, deleteDataSource, deleteFaq, deleteIndex, deletePrincipalMapping, deleteQuerySuggestionsBlockList, deleteThesaurus, describeDataSource, describeFaq, describeIndex, describePrincipalMapping, describeQuerySuggestionsBlockList, describeQuerySuggestionsConfig, describeThesaurus, getCachedResponseMetadata, getQuerySuggestions, listDataSources, listDataSourceSyncJobs, listFaqs, listGroupsOlderThanOrderingId, listIndices, listQuerySuggestionsBlockLists, listTagsForResource, listThesauri, putPrincipalMapping, query, shutdown, startDataSourceSyncJob, stopDataSourceSyncJob, submitFeedback, tagResource, untagResource, updateDataSource, updateIndex, updateQuerySuggestionsBlockList, updateQuerySuggestionsConfig, updateThesaurusFuture<BatchDeleteDocumentResult> batchDeleteDocumentAsync(BatchDeleteDocumentRequest batchDeleteDocumentRequest)
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.
batchDeleteDocumentRequest - Future<BatchDeleteDocumentResult> batchDeleteDocumentAsync(BatchDeleteDocumentRequest batchDeleteDocumentRequest, AsyncHandler<BatchDeleteDocumentRequest,BatchDeleteDocumentResult> asyncHandler)
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.
batchDeleteDocumentRequest - asyncHandler - 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.Future<BatchGetDocumentStatusResult> batchGetDocumentStatusAsync(BatchGetDocumentStatusRequest batchGetDocumentStatusRequest)
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.
batchGetDocumentStatusRequest - Future<BatchGetDocumentStatusResult> batchGetDocumentStatusAsync(BatchGetDocumentStatusRequest batchGetDocumentStatusRequest, AsyncHandler<BatchGetDocumentStatusRequest,BatchGetDocumentStatusResult> asyncHandler)
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.
batchGetDocumentStatusRequest - asyncHandler - 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.Future<BatchPutDocumentResult> batchPutDocumentAsync(BatchPutDocumentRequest batchPutDocumentRequest)
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.
batchPutDocumentRequest - Future<BatchPutDocumentResult> batchPutDocumentAsync(BatchPutDocumentRequest batchPutDocumentRequest, AsyncHandler<BatchPutDocumentRequest,BatchPutDocumentResult> asyncHandler)
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.
batchPutDocumentRequest - asyncHandler - 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.Future<ClearQuerySuggestionsResult> clearQuerySuggestionsAsync(ClearQuerySuggestionsRequest clearQuerySuggestionsRequest)
Clears existing query suggestions from an index.
This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.
clearQuerySuggestionsRequest - Future<ClearQuerySuggestionsResult> clearQuerySuggestionsAsync(ClearQuerySuggestionsRequest clearQuerySuggestionsRequest, AsyncHandler<ClearQuerySuggestionsRequest,ClearQuerySuggestionsResult> asyncHandler)
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.
clearQuerySuggestionsRequest - asyncHandler - 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.Future<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest createDataSourceRequest)
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.
createDataSourceRequest - Future<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest createDataSourceRequest, AsyncHandler<CreateDataSourceRequest,CreateDataSourceResult> asyncHandler)
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.
createDataSourceRequest - asyncHandler - 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.Future<CreateFaqResult> createFaqAsync(CreateFaqRequest createFaqRequest)
Creates an new set of frequently asked question (FAQ) questions and answers.
createFaqRequest - Future<CreateFaqResult> createFaqAsync(CreateFaqRequest createFaqRequest, AsyncHandler<CreateFaqRequest,CreateFaqResult> asyncHandler)
Creates an new set of frequently asked question (FAQ) questions and answers.
createFaqRequest - asyncHandler - 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.Future<CreateIndexResult> createIndexAsync(CreateIndexRequest createIndexRequest)
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.
createIndexRequest - Future<CreateIndexResult> createIndexAsync(CreateIndexRequest createIndexRequest, AsyncHandler<CreateIndexRequest,CreateIndexResult> asyncHandler)
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.
createIndexRequest - asyncHandler - 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.Future<CreateQuerySuggestionsBlockListResult> createQuerySuggestionsBlockListAsync(CreateQuerySuggestionsBlockListRequest createQuerySuggestionsBlockListRequest)
Creates a block list to exlcude certain queries from suggestions.
Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.
You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
createQuerySuggestionsBlockListRequest - Future<CreateQuerySuggestionsBlockListResult> createQuerySuggestionsBlockListAsync(CreateQuerySuggestionsBlockListRequest createQuerySuggestionsBlockListRequest, AsyncHandler<CreateQuerySuggestionsBlockListRequest,CreateQuerySuggestionsBlockListResult> asyncHandler)
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.
createQuerySuggestionsBlockListRequest - asyncHandler - 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.Future<CreateThesaurusResult> createThesaurusAsync(CreateThesaurusRequest createThesaurusRequest)
Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
createThesaurusRequest - Future<CreateThesaurusResult> createThesaurusAsync(CreateThesaurusRequest createThesaurusRequest, AsyncHandler<CreateThesaurusRequest,CreateThesaurusResult> asyncHandler)
Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
createThesaurusRequest - asyncHandler - 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.Future<DeleteDataSourceResult> deleteDataSourceAsync(DeleteDataSourceRequest deleteDataSourceRequest)
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.
deleteDataSourceRequest - Future<DeleteDataSourceResult> deleteDataSourceAsync(DeleteDataSourceRequest deleteDataSourceRequest, AsyncHandler<DeleteDataSourceRequest,DeleteDataSourceResult> asyncHandler)
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.
deleteDataSourceRequest - asyncHandler - 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.Future<DeleteFaqResult> deleteFaqAsync(DeleteFaqRequest deleteFaqRequest)
Removes an FAQ from an index.
deleteFaqRequest - Future<DeleteFaqResult> deleteFaqAsync(DeleteFaqRequest deleteFaqRequest, AsyncHandler<DeleteFaqRequest,DeleteFaqResult> asyncHandler)
Removes an FAQ from an index.
deleteFaqRequest - asyncHandler - 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.Future<DeleteIndexResult> deleteIndexAsync(DeleteIndexRequest deleteIndexRequest)
Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While
the index is being deleted, the Status field returned by a call to the DescribeIndex
operation is set to DELETING.
deleteIndexRequest - Future<DeleteIndexResult> deleteIndexAsync(DeleteIndexRequest deleteIndexRequest, AsyncHandler<DeleteIndexRequest,DeleteIndexResult> asyncHandler)
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.
deleteIndexRequest - asyncHandler - 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.Future<DeletePrincipalMappingResult> deletePrincipalMappingAsync(DeletePrincipalMappingRequest deletePrincipalMappingRequest)
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.
For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results.
If you want to delete or replace users or sub groups of a group, you need to use the
PutPrincipalMapping operation. For example, if a user in the group "Engineering" leaves the
engineering team and another user takes their place, you provide an updated list of users or sub groups that
belong to the "Engineering" group when calling PutPrincipalMapping. You can update your internal
list of users or sub groups and input this list when calling PutPrincipalMapping.
deletePrincipalMappingRequest - Future<DeletePrincipalMappingResult> deletePrincipalMappingAsync(DeletePrincipalMappingRequest deletePrincipalMappingRequest, AsyncHandler<DeletePrincipalMappingRequest,DeletePrincipalMappingResult> asyncHandler)
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.
deletePrincipalMappingRequest - asyncHandler - 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.Future<DeleteQuerySuggestionsBlockListResult> deleteQuerySuggestionsBlockListAsync(DeleteQuerySuggestionsBlockListRequest deleteQuerySuggestionsBlockListRequest)
Deletes a block list used for query suggestions for an index.
A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.
deleteQuerySuggestionsBlockListRequest - Future<DeleteQuerySuggestionsBlockListResult> deleteQuerySuggestionsBlockListAsync(DeleteQuerySuggestionsBlockListRequest deleteQuerySuggestionsBlockListRequest, AsyncHandler<DeleteQuerySuggestionsBlockListRequest,DeleteQuerySuggestionsBlockListResult> asyncHandler)
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.
deleteQuerySuggestionsBlockListRequest - asyncHandler - 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.Future<DeleteThesaurusResult> deleteThesaurusAsync(DeleteThesaurusRequest deleteThesaurusRequest)
Deletes an existing Amazon Kendra thesaurus.
deleteThesaurusRequest - Future<DeleteThesaurusResult> deleteThesaurusAsync(DeleteThesaurusRequest deleteThesaurusRequest, AsyncHandler<DeleteThesaurusRequest,DeleteThesaurusResult> asyncHandler)
Deletes an existing Amazon Kendra thesaurus.
deleteThesaurusRequest - asyncHandler - 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.Future<DescribeDataSourceResult> describeDataSourceAsync(DescribeDataSourceRequest describeDataSourceRequest)
Gets information about a Amazon Kendra data source.
describeDataSourceRequest - Future<DescribeDataSourceResult> describeDataSourceAsync(DescribeDataSourceRequest describeDataSourceRequest, AsyncHandler<DescribeDataSourceRequest,DescribeDataSourceResult> asyncHandler)
Gets information about a Amazon Kendra data source.
describeDataSourceRequest - asyncHandler - 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.Future<DescribeFaqResult> describeFaqAsync(DescribeFaqRequest describeFaqRequest)
Gets information about an FAQ list.
describeFaqRequest - Future<DescribeFaqResult> describeFaqAsync(DescribeFaqRequest describeFaqRequest, AsyncHandler<DescribeFaqRequest,DescribeFaqResult> asyncHandler)
Gets information about an FAQ list.
describeFaqRequest - asyncHandler - 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.Future<DescribeIndexResult> describeIndexAsync(DescribeIndexRequest describeIndexRequest)
Describes an existing Amazon Kendra index
describeIndexRequest - Future<DescribeIndexResult> describeIndexAsync(DescribeIndexRequest describeIndexRequest, AsyncHandler<DescribeIndexRequest,DescribeIndexResult> asyncHandler)
Describes an existing Amazon Kendra index
describeIndexRequest - asyncHandler - 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.Future<DescribePrincipalMappingResult> describePrincipalMappingAsync(DescribePrincipalMappingRequest describePrincipalMappingRequest)
Describes the processing of PUT and DELETE actions for mapping users to their groups.
This includes information on the status of actions currently processing or yet to be processed, when actions were
last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after
other actions, and useful error messages if an action could not be processed.
describePrincipalMappingRequest - Future<DescribePrincipalMappingResult> describePrincipalMappingAsync(DescribePrincipalMappingRequest describePrincipalMappingRequest, AsyncHandler<DescribePrincipalMappingRequest,DescribePrincipalMappingResult> asyncHandler)
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.
describePrincipalMappingRequest - asyncHandler - 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.Future<DescribeQuerySuggestionsBlockListResult> describeQuerySuggestionsBlockListAsync(DescribeQuerySuggestionsBlockListRequest describeQuerySuggestionsBlockListRequest)
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.
describeQuerySuggestionsBlockListRequest - Future<DescribeQuerySuggestionsBlockListResult> describeQuerySuggestionsBlockListAsync(DescribeQuerySuggestionsBlockListRequest describeQuerySuggestionsBlockListRequest, AsyncHandler<DescribeQuerySuggestionsBlockListRequest,DescribeQuerySuggestionsBlockListResult> asyncHandler)
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.
describeQuerySuggestionsBlockListRequest - asyncHandler - 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.Future<DescribeQuerySuggestionsConfigResult> describeQuerySuggestionsConfigAsync(DescribeQuerySuggestionsConfigRequest describeQuerySuggestionsConfigRequest)
Describes the settings of query suggestions for an index.
This is used to check the current settings applied to query suggestions.
describeQuerySuggestionsConfigRequest - Future<DescribeQuerySuggestionsConfigResult> describeQuerySuggestionsConfigAsync(DescribeQuerySuggestionsConfigRequest describeQuerySuggestionsConfigRequest, AsyncHandler<DescribeQuerySuggestionsConfigRequest,DescribeQuerySuggestionsConfigResult> asyncHandler)
Describes the settings of query suggestions for an index.
This is used to check the current settings applied to query suggestions.
describeQuerySuggestionsConfigRequest - asyncHandler - 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.Future<DescribeThesaurusResult> describeThesaurusAsync(DescribeThesaurusRequest describeThesaurusRequest)
Describes an existing Amazon Kendra thesaurus.
describeThesaurusRequest - Future<DescribeThesaurusResult> describeThesaurusAsync(DescribeThesaurusRequest describeThesaurusRequest, AsyncHandler<DescribeThesaurusRequest,DescribeThesaurusResult> asyncHandler)
Describes an existing Amazon Kendra thesaurus.
describeThesaurusRequest - asyncHandler - 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.Future<GetQuerySuggestionsResult> getQuerySuggestionsAsync(GetQuerySuggestionsRequest getQuerySuggestionsRequest)
Fetches the queries that are suggested to your users.
getQuerySuggestionsRequest - Future<GetQuerySuggestionsResult> getQuerySuggestionsAsync(GetQuerySuggestionsRequest getQuerySuggestionsRequest, AsyncHandler<GetQuerySuggestionsRequest,GetQuerySuggestionsResult> asyncHandler)
Fetches the queries that are suggested to your users.
getQuerySuggestionsRequest - asyncHandler - 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.Future<ListDataSourceSyncJobsResult> listDataSourceSyncJobsAsync(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Gets statistics about synchronizing Amazon Kendra with a data source.
listDataSourceSyncJobsRequest - Future<ListDataSourceSyncJobsResult> listDataSourceSyncJobsAsync(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest, AsyncHandler<ListDataSourceSyncJobsRequest,ListDataSourceSyncJobsResult> asyncHandler)
Gets statistics about synchronizing Amazon Kendra with a data source.
listDataSourceSyncJobsRequest - asyncHandler - 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.Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest listDataSourcesRequest)
Lists the data sources that you have created.
listDataSourcesRequest - Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest listDataSourcesRequest, AsyncHandler<ListDataSourcesRequest,ListDataSourcesResult> asyncHandler)
Lists the data sources that you have created.
listDataSourcesRequest - asyncHandler - 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.Future<ListFaqsResult> listFaqsAsync(ListFaqsRequest listFaqsRequest)
Gets a list of FAQ lists associated with an index.
listFaqsRequest - Future<ListFaqsResult> listFaqsAsync(ListFaqsRequest listFaqsRequest, AsyncHandler<ListFaqsRequest,ListFaqsResult> asyncHandler)
Gets a list of FAQ lists associated with an index.
listFaqsRequest - asyncHandler - 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.Future<ListGroupsOlderThanOrderingIdResult> listGroupsOlderThanOrderingIdAsync(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest)
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
listGroupsOlderThanOrderingIdRequest - Future<ListGroupsOlderThanOrderingIdResult> listGroupsOlderThanOrderingIdAsync(ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest, AsyncHandler<ListGroupsOlderThanOrderingIdRequest,ListGroupsOlderThanOrderingIdResult> asyncHandler)
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
listGroupsOlderThanOrderingIdRequest - asyncHandler - 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.Future<ListIndicesResult> listIndicesAsync(ListIndicesRequest listIndicesRequest)
Lists the Amazon Kendra indexes that you have created.
listIndicesRequest - Future<ListIndicesResult> listIndicesAsync(ListIndicesRequest listIndicesRequest, AsyncHandler<ListIndicesRequest,ListIndicesResult> asyncHandler)
Lists the Amazon Kendra indexes that you have created.
listIndicesRequest - asyncHandler - 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.Future<ListQuerySuggestionsBlockListsResult> listQuerySuggestionsBlockListsAsync(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest)
Lists the block lists used for query suggestions for an index.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
listQuerySuggestionsBlockListsRequest - Future<ListQuerySuggestionsBlockListsResult> listQuerySuggestionsBlockListsAsync(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest, AsyncHandler<ListQuerySuggestionsBlockListsRequest,ListQuerySuggestionsBlockListsResult> asyncHandler)
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.
listQuerySuggestionsBlockListsRequest - asyncHandler - 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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
listTagsForResourceRequest - asyncHandler - 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.Future<ListThesauriResult> listThesauriAsync(ListThesauriRequest listThesauriRequest)
Lists the Amazon Kendra thesauri associated with an index.
listThesauriRequest - Future<ListThesauriResult> listThesauriAsync(ListThesauriRequest listThesauriRequest, AsyncHandler<ListThesauriRequest,ListThesauriResult> asyncHandler)
Lists the Amazon Kendra thesauri associated with an index.
listThesauriRequest - asyncHandler - 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.Future<PutPrincipalMappingResult> putPrincipalMappingAsync(PutPrincipalMappingRequest putPrincipalMappingRequest)
Maps users to their groups so that you only need to provide the user ID when you issue the query.
You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results.
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.
putPrincipalMappingRequest - Future<PutPrincipalMappingResult> putPrincipalMappingAsync(PutPrincipalMappingRequest putPrincipalMappingRequest, AsyncHandler<PutPrincipalMappingRequest,PutPrincipalMappingResult> asyncHandler)
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.
putPrincipalMappingRequest - asyncHandler - 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.Future<QueryResult> queryAsync(QueryRequest queryRequest)
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.
queryRequest - Future<QueryResult> queryAsync(QueryRequest queryRequest, AsyncHandler<QueryRequest,QueryResult> asyncHandler)
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.
queryRequest - asyncHandler - 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.Future<StartDataSourceSyncJobResult> startDataSourceSyncJobAsync(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)
Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra
returns a ResourceInUseException exception.
startDataSourceSyncJobRequest - Future<StartDataSourceSyncJobResult> startDataSourceSyncJobAsync(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest, AsyncHandler<StartDataSourceSyncJobRequest,StartDataSourceSyncJobResult> asyncHandler)
Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra
returns a ResourceInUseException exception.
startDataSourceSyncJobRequest - asyncHandler - 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.Future<StopDataSourceSyncJobResult> stopDataSourceSyncJobAsync(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)
Stops a running synchronization job. You can't stop a scheduled synchronization job.
stopDataSourceSyncJobRequest - Future<StopDataSourceSyncJobResult> stopDataSourceSyncJobAsync(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest, AsyncHandler<StopDataSourceSyncJobRequest,StopDataSourceSyncJobResult> asyncHandler)
Stops a running synchronization job. You can't stop a scheduled synchronization job.
stopDataSourceSyncJobRequest - asyncHandler - 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.Future<SubmitFeedbackResult> submitFeedbackAsync(SubmitFeedbackRequest submitFeedbackRequest)
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
submitFeedbackRequest - Future<SubmitFeedbackResult> submitFeedbackAsync(SubmitFeedbackRequest submitFeedbackRequest, AsyncHandler<SubmitFeedbackRequest,SubmitFeedbackResult> asyncHandler)
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
submitFeedbackRequest - asyncHandler - 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.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the existing value is replaced with the new value.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
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.
tagResourceRequest - asyncHandler - 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.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes a tag from an index, FAQ, or a data source.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes a tag from an index, FAQ, or a data source.
untagResourceRequest - asyncHandler - 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.Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest updateDataSourceRequest)
Updates an existing Amazon Kendra data source.
updateDataSourceRequest - Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest updateDataSourceRequest, AsyncHandler<UpdateDataSourceRequest,UpdateDataSourceResult> asyncHandler)
Updates an existing Amazon Kendra data source.
updateDataSourceRequest - asyncHandler - 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.Future<UpdateIndexResult> updateIndexAsync(UpdateIndexRequest updateIndexRequest)
Updates an existing Amazon Kendra index.
updateIndexRequest - Future<UpdateIndexResult> updateIndexAsync(UpdateIndexRequest updateIndexRequest, AsyncHandler<UpdateIndexRequest,UpdateIndexResult> asyncHandler)
Updates an existing Amazon Kendra index.
updateIndexRequest - asyncHandler - 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.Future<UpdateQuerySuggestionsBlockListResult> updateQuerySuggestionsBlockListAsync(UpdateQuerySuggestionsBlockListRequest updateQuerySuggestionsBlockListRequest)
Updates a block list used for query suggestions for an index.
Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately.
If a block list is updating, then you need to wait for the first update to finish before submitting another update.
Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
updateQuerySuggestionsBlockListRequest - Future<UpdateQuerySuggestionsBlockListResult> updateQuerySuggestionsBlockListAsync(UpdateQuerySuggestionsBlockListRequest updateQuerySuggestionsBlockListRequest, AsyncHandler<UpdateQuerySuggestionsBlockListRequest,UpdateQuerySuggestionsBlockListResult> asyncHandler)
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.
updateQuerySuggestionsBlockListRequest - asyncHandler - 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.Future<UpdateQuerySuggestionsConfigResult> updateQuerySuggestionsConfigAsync(UpdateQuerySuggestionsConfigRequest updateQuerySuggestionsConfigRequest)
Updates the settings of query suggestions for an index.
Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
If an update is currently processing (i.e. 'happening'), you need to wait for the update to finish before making another update.
Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.
You can still enable/disable query suggestions at any time.
updateQuerySuggestionsConfigRequest - Future<UpdateQuerySuggestionsConfigResult> updateQuerySuggestionsConfigAsync(UpdateQuerySuggestionsConfigRequest updateQuerySuggestionsConfigRequest, AsyncHandler<UpdateQuerySuggestionsConfigRequest,UpdateQuerySuggestionsConfigResult> asyncHandler)
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.
updateQuerySuggestionsConfigRequest - asyncHandler - 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.Future<UpdateThesaurusResult> updateThesaurusAsync(UpdateThesaurusRequest updateThesaurusRequest)
Updates a thesaurus file associated with an index.
updateThesaurusRequest - Future<UpdateThesaurusResult> updateThesaurusAsync(UpdateThesaurusRequest updateThesaurusRequest, AsyncHandler<UpdateThesaurusRequest,UpdateThesaurusResult> asyncHandler)
Updates a thesaurus file associated with an index.
updateThesaurusRequest - asyncHandler - 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.