All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.kendra.AWSkendraAsync Maven / Gradle / Ivy

/*
 * Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.kendra;

import javax.annotation.Generated;

import com.amazonaws.services.kendra.model.*;

/**
 * Interface for accessing kendra asynchronously. Each asynchronous method will return a Java Future object representing
 * the asynchronous operation; overloads which accept an {@code 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 * {@link com.amazonaws.services.kendra.AbstractAWSkendraAsync} instead. *

*

*

* Amazon Kendra is a service for indexing large document sets. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSkendraAsync extends AWSkendra { /** *

* 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 releated to the processing of the batch are sent to you CloudWatch log. *

* * @param batchDeleteDocumentRequest * @return A Java Future containing the result of the BatchDeleteDocument operation returned by the service. * @sample AWSkendraAsync.BatchDeleteDocument * @see AWS API * Documentation */ java.util.concurrent.Future 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 releated to the processing of the batch are sent to you CloudWatch log. *

* * @param batchDeleteDocumentRequest * @param 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. * @return A Java Future containing the result of the BatchDeleteDocument operation returned by the service. * @sample AWSkendraAsyncHandler.BatchDeleteDocument * @see AWS API * Documentation */ java.util.concurrent.Future batchDeleteDocumentAsync(BatchDeleteDocumentRequest batchDeleteDocumentRequest, com.amazonaws.handlers.AsyncHandler 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. *

* * @param batchPutDocumentRequest * @return A Java Future containing the result of the BatchPutDocument operation returned by the service. * @sample AWSkendraAsync.BatchPutDocument * @see AWS API * Documentation */ java.util.concurrent.Future 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. *

* * @param batchPutDocumentRequest * @param 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. * @return A Java Future containing the result of the BatchPutDocument operation returned by the service. * @sample AWSkendraAsyncHandler.BatchPutDocument * @see AWS API * Documentation */ java.util.concurrent.Future batchPutDocumentAsync(BatchPutDocumentRequest batchPutDocumentRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Creates a data source that you use to with an Amazon Kendra index. *

*

* You specify a name, connector type and description for your data source. You can choose between an S3 connector, * a SharePoint Online connector, and a database connector. *

*

* 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. *

* * @param createDataSourceRequest * @return A Java Future containing the result of the CreateDataSource operation returned by the service. * @sample AWSkendraAsync.CreateDataSource * @see AWS API * Documentation */ java.util.concurrent.Future createDataSourceAsync(CreateDataSourceRequest createDataSourceRequest); /** *

* Creates a data source that you use to with an Amazon Kendra index. *

*

* You specify a name, connector type and description for your data source. You can choose between an S3 connector, * a SharePoint Online connector, and a database connector. *

*

* 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. *

* * @param createDataSourceRequest * @param 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. * @return A Java Future containing the result of the CreateDataSource operation returned by the service. * @sample AWSkendraAsyncHandler.CreateDataSource * @see AWS API * Documentation */ java.util.concurrent.Future createDataSourceAsync(CreateDataSourceRequest createDataSourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Creates an new set of frequently asked question (FAQ) questions and answers. *

* * @param createFaqRequest * @return A Java Future containing the result of the CreateFaq operation returned by the service. * @sample AWSkendraAsync.CreateFaq * @see AWS API * Documentation */ java.util.concurrent.Future createFaqAsync(CreateFaqRequest createFaqRequest); /** *

* Creates an new set of frequently asked question (FAQ) questions and answers. *

* * @param createFaqRequest * @param 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. * @return A Java Future containing the result of the CreateFaq operation returned by the service. * @sample AWSkendraAsyncHandler.CreateFaq * @see AWS API * Documentation */ java.util.concurrent.Future createFaqAsync(CreateFaqRequest createFaqRequest, com.amazonaws.handlers.AsyncHandler 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 . 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 operation or using one of the supported data * sources. *

* * @param createIndexRequest * @return A Java Future containing the result of the CreateIndex operation returned by the service. * @sample AWSkendraAsync.CreateIndex * @see AWS API * Documentation */ java.util.concurrent.Future 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 . 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 operation or using one of the supported data * sources. *

* * @param createIndexRequest * @param 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. * @return A Java Future containing the result of the CreateIndex operation returned by the service. * @sample AWSkendraAsyncHandler.CreateIndex * @see AWS API * Documentation */ java.util.concurrent.Future createIndexAsync(CreateIndexRequest createIndexRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Removes an FAQ from an index. *

* * @param deleteFaqRequest * @return A Java Future containing the result of the DeleteFaq operation returned by the service. * @sample AWSkendraAsync.DeleteFaq * @see AWS API * Documentation */ java.util.concurrent.Future deleteFaqAsync(DeleteFaqRequest deleteFaqRequest); /** *

* Removes an FAQ from an index. *

* * @param deleteFaqRequest * @param 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. * @return A Java Future containing the result of the DeleteFaq operation returned by the service. * @sample AWSkendraAsyncHandler.DeleteFaq * @see AWS API * Documentation */ java.util.concurrent.Future deleteFaqAsync(DeleteFaqRequest deleteFaqRequest, com.amazonaws.handlers.AsyncHandler 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. *

* * @param deleteIndexRequest * @return A Java Future containing the result of the DeleteIndex operation returned by the service. * @sample AWSkendraAsync.DeleteIndex * @see AWS API * Documentation */ java.util.concurrent.Future 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. *

* * @param deleteIndexRequest * @param 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. * @return A Java Future containing the result of the DeleteIndex operation returned by the service. * @sample AWSkendraAsyncHandler.DeleteIndex * @see AWS API * Documentation */ java.util.concurrent.Future deleteIndexAsync(DeleteIndexRequest deleteIndexRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Gets information about a Amazon Kendra data source. *

* * @param describeDataSourceRequest * @return A Java Future containing the result of the DescribeDataSource operation returned by the service. * @sample AWSkendraAsync.DescribeDataSource * @see AWS API * Documentation */ java.util.concurrent.Future describeDataSourceAsync(DescribeDataSourceRequest describeDataSourceRequest); /** *

* Gets information about a Amazon Kendra data source. *

* * @param describeDataSourceRequest * @param 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. * @return A Java Future containing the result of the DescribeDataSource operation returned by the service. * @sample AWSkendraAsyncHandler.DescribeDataSource * @see AWS API * Documentation */ java.util.concurrent.Future describeDataSourceAsync(DescribeDataSourceRequest describeDataSourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Gets information about an FAQ list. *

* * @param describeFaqRequest * @return A Java Future containing the result of the DescribeFaq operation returned by the service. * @sample AWSkendraAsync.DescribeFaq * @see AWS API * Documentation */ java.util.concurrent.Future describeFaqAsync(DescribeFaqRequest describeFaqRequest); /** *

* Gets information about an FAQ list. *

* * @param describeFaqRequest * @param 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. * @return A Java Future containing the result of the DescribeFaq operation returned by the service. * @sample AWSkendraAsyncHandler.DescribeFaq * @see AWS API * Documentation */ java.util.concurrent.Future describeFaqAsync(DescribeFaqRequest describeFaqRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Describes an existing Amazon Kendra index *

* * @param describeIndexRequest * @return A Java Future containing the result of the DescribeIndex operation returned by the service. * @sample AWSkendraAsync.DescribeIndex * @see AWS API * Documentation */ java.util.concurrent.Future describeIndexAsync(DescribeIndexRequest describeIndexRequest); /** *

* Describes an existing Amazon Kendra index *

* * @param describeIndexRequest * @param 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. * @return A Java Future containing the result of the DescribeIndex operation returned by the service. * @sample AWSkendraAsyncHandler.DescribeIndex * @see AWS API * Documentation */ java.util.concurrent.Future describeIndexAsync(DescribeIndexRequest describeIndexRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Gets statistics about synchronizing Amazon Kendra with a data source. *

* * @param listDataSourceSyncJobsRequest * @return A Java Future containing the result of the ListDataSourceSyncJobs operation returned by the service. * @sample AWSkendraAsync.ListDataSourceSyncJobs * @see AWS * API Documentation */ java.util.concurrent.Future listDataSourceSyncJobsAsync(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest); /** *

* Gets statistics about synchronizing Amazon Kendra with a data source. *

* * @param listDataSourceSyncJobsRequest * @param 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. * @return A Java Future containing the result of the ListDataSourceSyncJobs operation returned by the service. * @sample AWSkendraAsyncHandler.ListDataSourceSyncJobs * @see AWS * API Documentation */ java.util.concurrent.Future listDataSourceSyncJobsAsync(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Lists the data sources that you have created. *

* * @param listDataSourcesRequest * @return A Java Future containing the result of the ListDataSources operation returned by the service. * @sample AWSkendraAsync.ListDataSources * @see AWS API * Documentation */ java.util.concurrent.Future listDataSourcesAsync(ListDataSourcesRequest listDataSourcesRequest); /** *

* Lists the data sources that you have created. *

* * @param listDataSourcesRequest * @param 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. * @return A Java Future containing the result of the ListDataSources operation returned by the service. * @sample AWSkendraAsyncHandler.ListDataSources * @see AWS API * Documentation */ java.util.concurrent.Future listDataSourcesAsync(ListDataSourcesRequest listDataSourcesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Gets a list of FAQ lists associated with an index. *

* * @param listFaqsRequest * @return A Java Future containing the result of the ListFaqs operation returned by the service. * @sample AWSkendraAsync.ListFaqs * @see AWS API * Documentation */ java.util.concurrent.Future listFaqsAsync(ListFaqsRequest listFaqsRequest); /** *

* Gets a list of FAQ lists associated with an index. *

* * @param listFaqsRequest * @param 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. * @return A Java Future containing the result of the ListFaqs operation returned by the service. * @sample AWSkendraAsyncHandler.ListFaqs * @see AWS API * Documentation */ java.util.concurrent.Future listFaqsAsync(ListFaqsRequest listFaqsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Lists the Amazon Kendra indexes that you have created. *

* * @param listIndicesRequest * @return A Java Future containing the result of the ListIndices operation returned by the service. * @sample AWSkendraAsync.ListIndices * @see AWS API * Documentation */ java.util.concurrent.Future listIndicesAsync(ListIndicesRequest listIndicesRequest); /** *

* Lists the Amazon Kendra indexes that you have created. *

* * @param listIndicesRequest * @param 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. * @return A Java Future containing the result of the ListIndices operation returned by the service. * @sample AWSkendraAsyncHandler.ListIndices * @see AWS API * Documentation */ java.util.concurrent.Future listIndicesAsync(ListIndicesRequest listIndicesRequest, com.amazonaws.handlers.AsyncHandler 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. *

* * @param queryRequest * @return A Java Future containing the result of the Query operation returned by the service. * @sample AWSkendraAsync.Query * @see AWS API * Documentation */ java.util.concurrent.Future 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. *

* * @param queryRequest * @param 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. * @return A Java Future containing the result of the Query operation returned by the service. * @sample AWSkendraAsyncHandler.Query * @see AWS API * Documentation */ java.util.concurrent.Future queryAsync(QueryRequest queryRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra * returns a ResourceInUseException exception. *

* * @param startDataSourceSyncJobRequest * @return A Java Future containing the result of the StartDataSourceSyncJob operation returned by the service. * @sample AWSkendraAsync.StartDataSourceSyncJob * @see AWS * API Documentation */ java.util.concurrent.Future 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. *

* * @param startDataSourceSyncJobRequest * @param 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. * @return A Java Future containing the result of the StartDataSourceSyncJob operation returned by the service. * @sample AWSkendraAsyncHandler.StartDataSourceSyncJob * @see AWS * API Documentation */ java.util.concurrent.Future startDataSourceSyncJobAsync(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Stops a running synchronization job. You can't stop a scheduled synchronization job. *

* * @param stopDataSourceSyncJobRequest * @return A Java Future containing the result of the StopDataSourceSyncJob operation returned by the service. * @sample AWSkendraAsync.StopDataSourceSyncJob * @see AWS * API Documentation */ java.util.concurrent.Future stopDataSourceSyncJobAsync(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest); /** *

* Stops a running synchronization job. You can't stop a scheduled synchronization job. *

* * @param stopDataSourceSyncJobRequest * @param 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. * @return A Java Future containing the result of the StopDataSourceSyncJob operation returned by the service. * @sample AWSkendraAsyncHandler.StopDataSourceSyncJob * @see AWS * API Documentation */ java.util.concurrent.Future stopDataSourceSyncJobAsync(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Enables you to provide feedback to Amazon Kendra to improve the performance of the service. *

* * @param submitFeedbackRequest * @return A Java Future containing the result of the SubmitFeedback operation returned by the service. * @sample AWSkendraAsync.SubmitFeedback * @see AWS API * Documentation */ java.util.concurrent.Future submitFeedbackAsync(SubmitFeedbackRequest submitFeedbackRequest); /** *

* Enables you to provide feedback to Amazon Kendra to improve the performance of the service. *

* * @param submitFeedbackRequest * @param 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. * @return A Java Future containing the result of the SubmitFeedback operation returned by the service. * @sample AWSkendraAsyncHandler.SubmitFeedback * @see AWS API * Documentation */ java.util.concurrent.Future submitFeedbackAsync(SubmitFeedbackRequest submitFeedbackRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Updates an existing Amazon Kendra data source. *

* * @param updateDataSourceRequest * @return A Java Future containing the result of the UpdateDataSource operation returned by the service. * @sample AWSkendraAsync.UpdateDataSource * @see AWS API * Documentation */ java.util.concurrent.Future updateDataSourceAsync(UpdateDataSourceRequest updateDataSourceRequest); /** *

* Updates an existing Amazon Kendra data source. *

* * @param updateDataSourceRequest * @param 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. * @return A Java Future containing the result of the UpdateDataSource operation returned by the service. * @sample AWSkendraAsyncHandler.UpdateDataSource * @see AWS API * Documentation */ java.util.concurrent.Future updateDataSourceAsync(UpdateDataSourceRequest updateDataSourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Updates an existing Amazon Kendra index. *

* * @param updateIndexRequest * @return A Java Future containing the result of the UpdateIndex operation returned by the service. * @sample AWSkendraAsync.UpdateIndex * @see AWS API * Documentation */ java.util.concurrent.Future updateIndexAsync(UpdateIndexRequest updateIndexRequest); /** *

* Updates an existing Amazon Kendra index. *

* * @param updateIndexRequest * @param 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. * @return A Java Future containing the result of the UpdateIndex operation returned by the service. * @sample AWSkendraAsyncHandler.UpdateIndex * @see AWS API * Documentation */ java.util.concurrent.Future updateIndexAsync(UpdateIndexRequest updateIndexRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy