@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSkendraAsync extends AbstractAWSkendra implements AWSkendraAsync
AWSkendraAsync
. Convenient method forms pass through to the corresponding overload
that takes a request object and an AsyncHandler
, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
batchDeleteDocument, 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, updateThesaurus
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
batchDeleteDocument, 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, updateThesaurus
public Future<BatchDeleteDocumentResult> batchDeleteDocumentAsync(BatchDeleteDocumentRequest request)
AWSkendraAsync
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.
batchDeleteDocumentAsync
in interface AWSkendraAsync
public 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
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.
batchDeleteDocumentAsync
in interface AWSkendraAsync
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.public Future<BatchGetDocumentStatusResult> batchGetDocumentStatusAsync(BatchGetDocumentStatusRequest request)
AWSkendraAsync
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.
batchGetDocumentStatusAsync
in interface AWSkendraAsync
public Future<BatchGetDocumentStatusResult> batchGetDocumentStatusAsync(BatchGetDocumentStatusRequest request, AsyncHandler<BatchGetDocumentStatusRequest,BatchGetDocumentStatusResult> asyncHandler)
AWSkendraAsync
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.
batchGetDocumentStatusAsync
in interface AWSkendraAsync
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.public Future<BatchPutDocumentResult> batchPutDocumentAsync(BatchPutDocumentRequest request)
AWSkendraAsync
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.
batchPutDocumentAsync
in interface AWSkendraAsync
public Future<BatchPutDocumentResult> batchPutDocumentAsync(BatchPutDocumentRequest request, AsyncHandler<BatchPutDocumentRequest,BatchPutDocumentResult> asyncHandler)
AWSkendraAsync
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.
batchPutDocumentAsync
in interface AWSkendraAsync
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.public Future<ClearQuerySuggestionsResult> clearQuerySuggestionsAsync(ClearQuerySuggestionsRequest request)
AWSkendraAsync
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.
clearQuerySuggestionsAsync
in interface AWSkendraAsync
public Future<ClearQuerySuggestionsResult> clearQuerySuggestionsAsync(ClearQuerySuggestionsRequest request, AsyncHandler<ClearQuerySuggestionsRequest,ClearQuerySuggestionsResult> asyncHandler)
AWSkendraAsync
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.
clearQuerySuggestionsAsync
in interface AWSkendraAsync
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.public Future<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest request)
AWSkendraAsync
Creates a data source that you use to with an Amazon Kendra index.
You specify a name, data source connector type and description for your data source. You also specify configuration information such as document metadata (author, source URI, and so on) and user context information.
CreateDataSource
is a synchronous operation. The operation returns 200 if the data source was
successfully created. Otherwise, an exception is raised.
createDataSourceAsync
in interface AWSkendraAsync
public Future<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest request, AsyncHandler<CreateDataSourceRequest,CreateDataSourceResult> asyncHandler)
AWSkendraAsync
Creates a data source that you use to with an Amazon Kendra index.
You specify a name, data source connector type and description for your data source. You also specify configuration information such as document metadata (author, source URI, and so on) and user context information.
CreateDataSource
is a synchronous operation. The operation returns 200 if the data source was
successfully created. Otherwise, an exception is raised.
createDataSourceAsync
in interface AWSkendraAsync
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.public Future<CreateFaqResult> createFaqAsync(CreateFaqRequest request)
AWSkendraAsync
Creates an new set of frequently asked question (FAQ) questions and answers.
createFaqAsync
in interface AWSkendraAsync
public Future<CreateFaqResult> createFaqAsync(CreateFaqRequest request, AsyncHandler<CreateFaqRequest,CreateFaqResult> asyncHandler)
AWSkendraAsync
Creates an new set of frequently asked question (FAQ) questions and answers.
createFaqAsync
in interface AWSkendraAsync
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.public Future<CreateIndexResult> createIndexAsync(CreateIndexRequest request)
AWSkendraAsync
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.
createIndexAsync
in interface AWSkendraAsync
public Future<CreateIndexResult> createIndexAsync(CreateIndexRequest request, AsyncHandler<CreateIndexRequest,CreateIndexResult> asyncHandler)
AWSkendraAsync
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.
createIndexAsync
in interface AWSkendraAsync
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.public Future<CreateQuerySuggestionsBlockListResult> createQuerySuggestionsBlockListAsync(CreateQuerySuggestionsBlockListRequest request)
AWSkendraAsync
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.
createQuerySuggestionsBlockListAsync
in interface AWSkendraAsync
public Future<CreateQuerySuggestionsBlockListResult> createQuerySuggestionsBlockListAsync(CreateQuerySuggestionsBlockListRequest request, AsyncHandler<CreateQuerySuggestionsBlockListRequest,CreateQuerySuggestionsBlockListResult> asyncHandler)
AWSkendraAsync
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.
createQuerySuggestionsBlockListAsync
in interface AWSkendraAsync
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.public Future<CreateThesaurusResult> createThesaurusAsync(CreateThesaurusRequest request)
AWSkendraAsync
Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
createThesaurusAsync
in interface AWSkendraAsync
public Future<CreateThesaurusResult> createThesaurusAsync(CreateThesaurusRequest request, AsyncHandler<CreateThesaurusRequest,CreateThesaurusResult> asyncHandler)
AWSkendraAsync
Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
createThesaurusAsync
in interface AWSkendraAsync
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.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
operation is set to DELETING
. For more information, see Deleting Data Sources.
deleteDataSourceAsync
in interface AWSkendraAsync
public 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
operation is set to DELETING
. For more information, see Deleting Data Sources.
deleteDataSourceAsync
in interface AWSkendraAsync
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.public Future<DeleteFaqResult> deleteFaqAsync(DeleteFaqRequest request)
AWSkendraAsync
Removes an FAQ from an index.
deleteFaqAsync
in interface AWSkendraAsync
public Future<DeleteFaqResult> deleteFaqAsync(DeleteFaqRequest request, AsyncHandler<DeleteFaqRequest,DeleteFaqResult> asyncHandler)
AWSkendraAsync
Removes an FAQ from an index.
deleteFaqAsync
in interface AWSkendraAsync
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.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
operation is set to DELETING
.
deleteIndexAsync
in interface AWSkendraAsync
public 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
operation is set to DELETING
.
deleteIndexAsync
in interface AWSkendraAsync
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.public Future<DeletePrincipalMappingResult> deletePrincipalMappingAsync(DeletePrincipalMappingRequest request)
AWSkendraAsync
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
.
deletePrincipalMappingAsync
in interface AWSkendraAsync
public Future<DeletePrincipalMappingResult> deletePrincipalMappingAsync(DeletePrincipalMappingRequest request, AsyncHandler<DeletePrincipalMappingRequest,DeletePrincipalMappingResult> asyncHandler)
AWSkendraAsync
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
.
deletePrincipalMappingAsync
in interface AWSkendraAsync
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.public Future<DeleteQuerySuggestionsBlockListResult> deleteQuerySuggestionsBlockListAsync(DeleteQuerySuggestionsBlockListRequest request)
AWSkendraAsync
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.
deleteQuerySuggestionsBlockListAsync
in interface AWSkendraAsync
public Future<DeleteQuerySuggestionsBlockListResult> deleteQuerySuggestionsBlockListAsync(DeleteQuerySuggestionsBlockListRequest request, AsyncHandler<DeleteQuerySuggestionsBlockListRequest,DeleteQuerySuggestionsBlockListResult> asyncHandler)
AWSkendraAsync
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.
deleteQuerySuggestionsBlockListAsync
in interface AWSkendraAsync
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.public Future<DeleteThesaurusResult> deleteThesaurusAsync(DeleteThesaurusRequest request)
AWSkendraAsync
Deletes an existing Amazon Kendra thesaurus.
deleteThesaurusAsync
in interface AWSkendraAsync
public Future<DeleteThesaurusResult> deleteThesaurusAsync(DeleteThesaurusRequest request, AsyncHandler<DeleteThesaurusRequest,DeleteThesaurusResult> asyncHandler)
AWSkendraAsync
Deletes an existing Amazon Kendra thesaurus.
deleteThesaurusAsync
in interface AWSkendraAsync
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.public Future<DescribeDataSourceResult> describeDataSourceAsync(DescribeDataSourceRequest request)
AWSkendraAsync
Gets information about a Amazon Kendra data source.
describeDataSourceAsync
in interface AWSkendraAsync
public Future<DescribeDataSourceResult> describeDataSourceAsync(DescribeDataSourceRequest request, AsyncHandler<DescribeDataSourceRequest,DescribeDataSourceResult> asyncHandler)
AWSkendraAsync
Gets information about a Amazon Kendra data source.
describeDataSourceAsync
in interface AWSkendraAsync
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.public Future<DescribeFaqResult> describeFaqAsync(DescribeFaqRequest request)
AWSkendraAsync
Gets information about an FAQ list.
describeFaqAsync
in interface AWSkendraAsync
public Future<DescribeFaqResult> describeFaqAsync(DescribeFaqRequest request, AsyncHandler<DescribeFaqRequest,DescribeFaqResult> asyncHandler)
AWSkendraAsync
Gets information about an FAQ list.
describeFaqAsync
in interface AWSkendraAsync
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.public Future<DescribeIndexResult> describeIndexAsync(DescribeIndexRequest request)
AWSkendraAsync
Describes an existing Amazon Kendra index
describeIndexAsync
in interface AWSkendraAsync
public Future<DescribeIndexResult> describeIndexAsync(DescribeIndexRequest request, AsyncHandler<DescribeIndexRequest,DescribeIndexResult> asyncHandler)
AWSkendraAsync
Describes an existing Amazon Kendra index
describeIndexAsync
in interface AWSkendraAsync
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.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.
describePrincipalMappingAsync
in interface AWSkendraAsync
public 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.
describePrincipalMappingAsync
in interface AWSkendraAsync
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.public Future<DescribeQuerySuggestionsBlockListResult> describeQuerySuggestionsBlockListAsync(DescribeQuerySuggestionsBlockListRequest request)
AWSkendraAsync
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.
describeQuerySuggestionsBlockListAsync
in interface AWSkendraAsync
public Future<DescribeQuerySuggestionsBlockListResult> describeQuerySuggestionsBlockListAsync(DescribeQuerySuggestionsBlockListRequest request, AsyncHandler<DescribeQuerySuggestionsBlockListRequest,DescribeQuerySuggestionsBlockListResult> asyncHandler)
AWSkendraAsync
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.
describeQuerySuggestionsBlockListAsync
in interface AWSkendraAsync
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.public Future<DescribeQuerySuggestionsConfigResult> describeQuerySuggestionsConfigAsync(DescribeQuerySuggestionsConfigRequest request)
AWSkendraAsync
Describes the settings of query suggestions for an index.
This is used to check the current settings applied to query suggestions.
describeQuerySuggestionsConfigAsync
in interface AWSkendraAsync
public Future<DescribeQuerySuggestionsConfigResult> describeQuerySuggestionsConfigAsync(DescribeQuerySuggestionsConfigRequest request, AsyncHandler<DescribeQuerySuggestionsConfigRequest,DescribeQuerySuggestionsConfigResult> asyncHandler)
AWSkendraAsync
Describes the settings of query suggestions for an index.
This is used to check the current settings applied to query suggestions.
describeQuerySuggestionsConfigAsync
in interface AWSkendraAsync
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.public Future<DescribeThesaurusResult> describeThesaurusAsync(DescribeThesaurusRequest request)
AWSkendraAsync
Describes an existing Amazon Kendra thesaurus.
describeThesaurusAsync
in interface AWSkendraAsync
public Future<DescribeThesaurusResult> describeThesaurusAsync(DescribeThesaurusRequest request, AsyncHandler<DescribeThesaurusRequest,DescribeThesaurusResult> asyncHandler)
AWSkendraAsync
Describes an existing Amazon Kendra thesaurus.
describeThesaurusAsync
in interface AWSkendraAsync
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.public Future<GetQuerySuggestionsResult> getQuerySuggestionsAsync(GetQuerySuggestionsRequest request)
AWSkendraAsync
Fetches the queries that are suggested to your users.
getQuerySuggestionsAsync
in interface AWSkendraAsync
public Future<GetQuerySuggestionsResult> getQuerySuggestionsAsync(GetQuerySuggestionsRequest request, AsyncHandler<GetQuerySuggestionsRequest,GetQuerySuggestionsResult> asyncHandler)
AWSkendraAsync
Fetches the queries that are suggested to your users.
getQuerySuggestionsAsync
in interface AWSkendraAsync
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.public Future<ListDataSourceSyncJobsResult> listDataSourceSyncJobsAsync(ListDataSourceSyncJobsRequest request)
AWSkendraAsync
Gets statistics about synchronizing Amazon Kendra with a data source.
listDataSourceSyncJobsAsync
in interface AWSkendraAsync
public Future<ListDataSourceSyncJobsResult> listDataSourceSyncJobsAsync(ListDataSourceSyncJobsRequest request, AsyncHandler<ListDataSourceSyncJobsRequest,ListDataSourceSyncJobsResult> asyncHandler)
AWSkendraAsync
Gets statistics about synchronizing Amazon Kendra with a data source.
listDataSourceSyncJobsAsync
in interface AWSkendraAsync
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.public Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest request)
AWSkendraAsync
Lists the data sources that you have created.
listDataSourcesAsync
in interface AWSkendraAsync
public Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest request, AsyncHandler<ListDataSourcesRequest,ListDataSourcesResult> asyncHandler)
AWSkendraAsync
Lists the data sources that you have created.
listDataSourcesAsync
in interface AWSkendraAsync
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.public Future<ListFaqsResult> listFaqsAsync(ListFaqsRequest request)
AWSkendraAsync
Gets a list of FAQ lists associated with an index.
listFaqsAsync
in interface AWSkendraAsync
public Future<ListFaqsResult> listFaqsAsync(ListFaqsRequest request, AsyncHandler<ListFaqsRequest,ListFaqsResult> asyncHandler)
AWSkendraAsync
Gets a list of FAQ lists associated with an index.
listFaqsAsync
in interface AWSkendraAsync
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.public Future<ListGroupsOlderThanOrderingIdResult> listGroupsOlderThanOrderingIdAsync(ListGroupsOlderThanOrderingIdRequest request)
AWSkendraAsync
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
listGroupsOlderThanOrderingIdAsync
in interface AWSkendraAsync
public Future<ListGroupsOlderThanOrderingIdResult> listGroupsOlderThanOrderingIdAsync(ListGroupsOlderThanOrderingIdRequest request, AsyncHandler<ListGroupsOlderThanOrderingIdRequest,ListGroupsOlderThanOrderingIdResult> asyncHandler)
AWSkendraAsync
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
listGroupsOlderThanOrderingIdAsync
in interface AWSkendraAsync
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.public Future<ListIndicesResult> listIndicesAsync(ListIndicesRequest request)
AWSkendraAsync
Lists the Amazon Kendra indexes that you have created.
listIndicesAsync
in interface AWSkendraAsync
public Future<ListIndicesResult> listIndicesAsync(ListIndicesRequest request, AsyncHandler<ListIndicesRequest,ListIndicesResult> asyncHandler)
AWSkendraAsync
Lists the Amazon Kendra indexes that you have created.
listIndicesAsync
in interface AWSkendraAsync
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.public Future<ListQuerySuggestionsBlockListsResult> listQuerySuggestionsBlockListsAsync(ListQuerySuggestionsBlockListsRequest request)
AWSkendraAsync
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.
listQuerySuggestionsBlockListsAsync
in interface AWSkendraAsync
public Future<ListQuerySuggestionsBlockListsResult> listQuerySuggestionsBlockListsAsync(ListQuerySuggestionsBlockListsRequest request, AsyncHandler<ListQuerySuggestionsBlockListsRequest,ListQuerySuggestionsBlockListsResult> asyncHandler)
AWSkendraAsync
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.
listQuerySuggestionsBlockListsAsync
in interface AWSkendraAsync
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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSkendraAsync
Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
listTagsForResourceAsync
in interface AWSkendraAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSkendraAsync
Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
listTagsForResourceAsync
in interface AWSkendraAsync
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.public Future<ListThesauriResult> listThesauriAsync(ListThesauriRequest request)
AWSkendraAsync
Lists the Amazon Kendra thesauri associated with an index.
listThesauriAsync
in interface AWSkendraAsync
public Future<ListThesauriResult> listThesauriAsync(ListThesauriRequest request, AsyncHandler<ListThesauriRequest,ListThesauriResult> asyncHandler)
AWSkendraAsync
Lists the Amazon Kendra thesauri associated with an index.
listThesauriAsync
in interface AWSkendraAsync
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.public Future<PutPrincipalMappingResult> putPrincipalMappingAsync(PutPrincipalMappingRequest request)
AWSkendraAsync
Maps users to their groups. 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.
putPrincipalMappingAsync
in interface AWSkendraAsync
public Future<PutPrincipalMappingResult> putPrincipalMappingAsync(PutPrincipalMappingRequest request, AsyncHandler<PutPrincipalMappingRequest,PutPrincipalMappingResult> asyncHandler)
AWSkendraAsync
Maps users to their groups. 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.
putPrincipalMappingAsync
in interface AWSkendraAsync
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.public Future<QueryResult> queryAsync(QueryRequest request)
AWSkendraAsync
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.
queryAsync
in interface AWSkendraAsync
public 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
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.
queryAsync
in interface AWSkendraAsync
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.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 AWSkendraAsync
public 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 AWSkendraAsync
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.public Future<StopDataSourceSyncJobResult> stopDataSourceSyncJobAsync(StopDataSourceSyncJobRequest request)
AWSkendraAsync
Stops a running synchronization job. You can't stop a scheduled synchronization job.
stopDataSourceSyncJobAsync
in interface AWSkendraAsync
public Future<StopDataSourceSyncJobResult> stopDataSourceSyncJobAsync(StopDataSourceSyncJobRequest request, AsyncHandler<StopDataSourceSyncJobRequest,StopDataSourceSyncJobResult> asyncHandler)
AWSkendraAsync
Stops a running synchronization job. You can't stop a scheduled synchronization job.
stopDataSourceSyncJobAsync
in interface AWSkendraAsync
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.public Future<SubmitFeedbackResult> submitFeedbackAsync(SubmitFeedbackRequest request)
AWSkendraAsync
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
submitFeedbackAsync
in interface AWSkendraAsync
public Future<SubmitFeedbackResult> submitFeedbackAsync(SubmitFeedbackRequest request, AsyncHandler<SubmitFeedbackRequest,SubmitFeedbackResult> asyncHandler)
AWSkendraAsync
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
submitFeedbackAsync
in interface AWSkendraAsync
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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSkendraAsync
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.
tagResourceAsync
in interface AWSkendraAsync
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSkendraAsync
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.
tagResourceAsync
in interface AWSkendraAsync
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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSkendraAsync
Removes a tag from an index, FAQ, or a data source.
untagResourceAsync
in interface AWSkendraAsync
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSkendraAsync
Removes a tag from an index, FAQ, or a data source.
untagResourceAsync
in interface AWSkendraAsync
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.public Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest request)
AWSkendraAsync
Updates an existing Amazon Kendra data source.
updateDataSourceAsync
in interface AWSkendraAsync
public Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest request, AsyncHandler<UpdateDataSourceRequest,UpdateDataSourceResult> asyncHandler)
AWSkendraAsync
Updates an existing Amazon Kendra data source.
updateDataSourceAsync
in interface AWSkendraAsync
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.public Future<UpdateIndexResult> updateIndexAsync(UpdateIndexRequest request)
AWSkendraAsync
Updates an existing Amazon Kendra index.
updateIndexAsync
in interface AWSkendraAsync
public Future<UpdateIndexResult> updateIndexAsync(UpdateIndexRequest request, AsyncHandler<UpdateIndexRequest,UpdateIndexResult> asyncHandler)
AWSkendraAsync
Updates an existing Amazon Kendra index.
updateIndexAsync
in interface AWSkendraAsync
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.public Future<UpdateQuerySuggestionsBlockListResult> updateQuerySuggestionsBlockListAsync(UpdateQuerySuggestionsBlockListRequest request)
AWSkendraAsync
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.
updateQuerySuggestionsBlockListAsync
in interface AWSkendraAsync
public Future<UpdateQuerySuggestionsBlockListResult> updateQuerySuggestionsBlockListAsync(UpdateQuerySuggestionsBlockListRequest request, AsyncHandler<UpdateQuerySuggestionsBlockListRequest,UpdateQuerySuggestionsBlockListResult> asyncHandler)
AWSkendraAsync
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.
updateQuerySuggestionsBlockListAsync
in interface AWSkendraAsync
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.public Future<UpdateQuerySuggestionsConfigResult> updateQuerySuggestionsConfigAsync(UpdateQuerySuggestionsConfigRequest request)
AWSkendraAsync
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.
updateQuerySuggestionsConfigAsync
in interface AWSkendraAsync
public Future<UpdateQuerySuggestionsConfigResult> updateQuerySuggestionsConfigAsync(UpdateQuerySuggestionsConfigRequest request, AsyncHandler<UpdateQuerySuggestionsConfigRequest,UpdateQuerySuggestionsConfigResult> asyncHandler)
AWSkendraAsync
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.
updateQuerySuggestionsConfigAsync
in interface AWSkendraAsync
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.public Future<UpdateThesaurusResult> updateThesaurusAsync(UpdateThesaurusRequest request)
AWSkendraAsync
Updates a thesaurus file associated with an index.
updateThesaurusAsync
in interface AWSkendraAsync
public Future<UpdateThesaurusResult> updateThesaurusAsync(UpdateThesaurusRequest request, AsyncHandler<UpdateThesaurusRequest,UpdateThesaurusResult> asyncHandler)
AWSkendraAsync
Updates a thesaurus file associated with an index.
updateThesaurusAsync
in interface AWSkendraAsync
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.