@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, batchPutDocument, createDataSource, createFaq, createIndex, createThesaurus, deleteDataSource, deleteFaq, deleteIndex, deleteThesaurus, describeDataSource, describeFaq, describeIndex, describeThesaurus, getCachedResponseMetadata, listDataSources, listDataSourceSyncJobs, listFaqs, listIndices, listTagsForResource, listThesauri, query, shutdown, startDataSourceSyncJob, stopDataSourceSyncJob, submitFeedback, tagResource, untagResource, updateDataSource, updateIndex, 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 AWS 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 AWS 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<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 AWS CloudWatch. Any error messages related to processing the batch are sent to your AWS 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 AWS CloudWatch. Any error messages related to processing the batch are sent to your AWS 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<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest createDataSourceRequest)
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.
createDataSourceRequest - Future<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest createDataSourceRequest, AsyncHandler<CreateDataSourceRequest,CreateDataSourceResult> asyncHandler)
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.
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<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<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<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<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<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<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<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 the service.
submitFeedbackRequest - Future<SubmitFeedbackResult> submitFeedbackAsync(SubmitFeedbackRequest submitFeedbackRequest, AsyncHandler<SubmitFeedbackRequest,SubmitFeedbackResult> asyncHandler)
Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
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<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.