
com.amazonaws.services.kendra.AWSkendraAsync Maven / Gradle / Ivy
/*
* Copyright 2016-2021 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 Amazon Web Services
* CloudWatch. Any error messages related 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 Amazon Web Services
* CloudWatch. Any error messages related 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);
/**
*
* 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.
*
*
* @param batchGetDocumentStatusRequest
* @return A Java Future containing the result of the BatchGetDocumentStatus operation returned by the service.
* @sample AWSkendraAsync.BatchGetDocumentStatus
* @see AWS
* API Documentation
*/
java.util.concurrent.Future batchGetDocumentStatusAsync(BatchGetDocumentStatusRequest batchGetDocumentStatusRequest);
/**
*
* Returns the indexing status for one or more documents submitted with the BatchPutDocument operation.
*
*
* When you use the BatchPutDocument
operation, documents are indexed asynchronously. You can use the
* BatchGetDocumentStatus
operation to get the current status of a list of documents so that you can
* determine if they have been successfully indexed.
*
*
* You can also use the BatchGetDocumentStatus
operation to check the status of the BatchDeleteDocument
* operation. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND
as the status.
*
*
* @param batchGetDocumentStatusRequest
* @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 BatchGetDocumentStatus operation returned by the service.
* @sample AWSkendraAsyncHandler.BatchGetDocumentStatus
* @see AWS
* API Documentation
*/
java.util.concurrent.Future batchGetDocumentStatusAsync(BatchGetDocumentStatusRequest batchGetDocumentStatusRequest,
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 Amazon Web Services
* CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services 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 Amazon Web Services
* CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services 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);
/**
*
* 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.
*
*
* @param clearQuerySuggestionsRequest
* @return A Java Future containing the result of the ClearQuerySuggestions operation returned by the service.
* @sample AWSkendraAsync.ClearQuerySuggestions
* @see AWS
* API Documentation
*/
java.util.concurrent.Future clearQuerySuggestionsAsync(ClearQuerySuggestionsRequest clearQuerySuggestionsRequest);
/**
*
* Clears existing query suggestions from an index.
*
*
* This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon
* Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions.
* If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new
* suggestions.
*
*
* @param clearQuerySuggestionsRequest
* @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 ClearQuerySuggestions operation returned by the service.
* @sample AWSkendraAsyncHandler.ClearQuerySuggestions
* @see AWS
* API Documentation
*/
java.util.concurrent.Future clearQuerySuggestionsAsync(ClearQuerySuggestionsRequest clearQuerySuggestionsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @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, 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.
*
*
* @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 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.
*
*
* @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 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.
*
*
* @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);
/**
*
* 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.
*
*
* @param createQuerySuggestionsBlockListRequest
* @return A Java Future containing the result of the CreateQuerySuggestionsBlockList operation returned by the
* service.
* @sample AWSkendraAsync.CreateQuerySuggestionsBlockList
* @see AWS API Documentation
*/
java.util.concurrent.Future createQuerySuggestionsBlockListAsync(
CreateQuerySuggestionsBlockListRequest createQuerySuggestionsBlockListRequest);
/**
*
* Creates a block list to exlcude certain queries from suggestions.
*
*
* Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown
* as a suggestion.
*
*
* You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter
* each block word or phrase on a separate line.
*
*
* For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
*
*
* @param createQuerySuggestionsBlockListRequest
* @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 CreateQuerySuggestionsBlockList operation returned by the
* service.
* @sample AWSkendraAsyncHandler.CreateQuerySuggestionsBlockList
* @see AWS API Documentation
*/
java.util.concurrent.Future createQuerySuggestionsBlockListAsync(
CreateQuerySuggestionsBlockListRequest createQuerySuggestionsBlockListRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
*
*
* @param createThesaurusRequest
* @return A Java Future containing the result of the CreateThesaurus operation returned by the service.
* @sample AWSkendraAsync.CreateThesaurus
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createThesaurusAsync(CreateThesaurusRequest createThesaurusRequest);
/**
*
* Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
*
*
* @param createThesaurusRequest
* @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 CreateThesaurus operation returned by the service.
* @sample AWSkendraAsyncHandler.CreateThesaurus
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createThesaurusAsync(CreateThesaurusRequest createThesaurusRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param deleteDataSourceRequest
* @return A Java Future containing the result of the DeleteDataSource operation returned by the service.
* @sample AWSkendraAsync.DeleteDataSource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param deleteDataSourceRequest
* @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 DeleteDataSource operation returned by the service.
* @sample AWSkendraAsyncHandler.DeleteDataSource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteDataSourceAsync(DeleteDataSourceRequest deleteDataSourceRequest,
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);
/**
*
* 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
.
*
*
* @param deletePrincipalMappingRequest
* @return A Java Future containing the result of the DeletePrincipalMapping operation returned by the service.
* @sample AWSkendraAsync.DeletePrincipalMapping
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deletePrincipalMappingAsync(DeletePrincipalMappingRequest deletePrincipalMappingRequest);
/**
*
* Deletes a group so that all users and sub groups that belong to the group can no longer access documents only
* available to that group.
*
*
* For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see
* intern-only documents in their search results.
*
*
* If you want to delete or replace users or sub groups of a group, you need to use the
* PutPrincipalMapping
operation. For example, if a user in the group "Engineering" leaves the
* engineering team and another user takes their place, you provide an updated list of users or sub groups that
* belong to the "Engineering" group when calling PutPrincipalMapping
. You can update your internal
* list of users or sub groups and input this list when calling PutPrincipalMapping
.
*
*
* @param deletePrincipalMappingRequest
* @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 DeletePrincipalMapping operation returned by the service.
* @sample AWSkendraAsyncHandler.DeletePrincipalMapping
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deletePrincipalMappingAsync(DeletePrincipalMappingRequest deletePrincipalMappingRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a block list used for query suggestions for an index.
*
*
* A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list
* to add back the queries that were previously blocked.
*
*
* @param deleteQuerySuggestionsBlockListRequest
* @return A Java Future containing the result of the DeleteQuerySuggestionsBlockList operation returned by the
* service.
* @sample AWSkendraAsync.DeleteQuerySuggestionsBlockList
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteQuerySuggestionsBlockListAsync(
DeleteQuerySuggestionsBlockListRequest deleteQuerySuggestionsBlockListRequest);
/**
*
* Deletes a block list used for query suggestions for an index.
*
*
* A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list
* to add back the queries that were previously blocked.
*
*
* @param deleteQuerySuggestionsBlockListRequest
* @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 DeleteQuerySuggestionsBlockList operation returned by the
* service.
* @sample AWSkendraAsyncHandler.DeleteQuerySuggestionsBlockList
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteQuerySuggestionsBlockListAsync(
DeleteQuerySuggestionsBlockListRequest deleteQuerySuggestionsBlockListRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes an existing Amazon Kendra thesaurus.
*
*
* @param deleteThesaurusRequest
* @return A Java Future containing the result of the DeleteThesaurus operation returned by the service.
* @sample AWSkendraAsync.DeleteThesaurus
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteThesaurusAsync(DeleteThesaurusRequest deleteThesaurusRequest);
/**
*
* Deletes an existing Amazon Kendra thesaurus.
*
*
* @param deleteThesaurusRequest
* @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 DeleteThesaurus operation returned by the service.
* @sample AWSkendraAsyncHandler.DeleteThesaurus
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteThesaurusAsync(DeleteThesaurusRequest deleteThesaurusRequest,
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);
/**
*
* 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.
*
*
* @param describePrincipalMappingRequest
* @return A Java Future containing the result of the DescribePrincipalMapping operation returned by the service.
* @sample AWSkendraAsync.DescribePrincipalMapping
* @see AWS API Documentation
*/
java.util.concurrent.Future describePrincipalMappingAsync(DescribePrincipalMappingRequest describePrincipalMappingRequest);
/**
*
* Describes the processing of PUT
and DELETE
actions for mapping users to their groups.
* This includes information on the status of actions currently processing or yet to be processed, when actions were
* last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after
* other actions, and useful error messages if an action could not be processed.
*
*
* @param describePrincipalMappingRequest
* @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 DescribePrincipalMapping operation returned by the service.
* @sample AWSkendraAsyncHandler.DescribePrincipalMapping
* @see AWS API Documentation
*/
java.util.concurrent.Future describePrincipalMappingAsync(DescribePrincipalMappingRequest describePrincipalMappingRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes a block list used for query suggestions for an index.
*
*
* This is used to check the current settings that are applied to a block list.
*
*
* @param describeQuerySuggestionsBlockListRequest
* @return A Java Future containing the result of the DescribeQuerySuggestionsBlockList operation returned by the
* service.
* @sample AWSkendraAsync.DescribeQuerySuggestionsBlockList
* @see AWS API Documentation
*/
java.util.concurrent.Future describeQuerySuggestionsBlockListAsync(
DescribeQuerySuggestionsBlockListRequest describeQuerySuggestionsBlockListRequest);
/**
*
* Describes a block list used for query suggestions for an index.
*
*
* This is used to check the current settings that are applied to a block list.
*
*
* @param describeQuerySuggestionsBlockListRequest
* @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 DescribeQuerySuggestionsBlockList operation returned by the
* service.
* @sample AWSkendraAsyncHandler.DescribeQuerySuggestionsBlockList
* @see AWS API Documentation
*/
java.util.concurrent.Future describeQuerySuggestionsBlockListAsync(
DescribeQuerySuggestionsBlockListRequest describeQuerySuggestionsBlockListRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes the settings of query suggestions for an index.
*
*
* This is used to check the current settings applied to query suggestions.
*
*
* @param describeQuerySuggestionsConfigRequest
* @return A Java Future containing the result of the DescribeQuerySuggestionsConfig operation returned by the
* service.
* @sample AWSkendraAsync.DescribeQuerySuggestionsConfig
* @see AWS API Documentation
*/
java.util.concurrent.Future describeQuerySuggestionsConfigAsync(
DescribeQuerySuggestionsConfigRequest describeQuerySuggestionsConfigRequest);
/**
*
* Describes the settings of query suggestions for an index.
*
*
* This is used to check the current settings applied to query suggestions.
*
*
* @param describeQuerySuggestionsConfigRequest
* @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 DescribeQuerySuggestionsConfig operation returned by the
* service.
* @sample AWSkendraAsyncHandler.DescribeQuerySuggestionsConfig
* @see AWS API Documentation
*/
java.util.concurrent.Future describeQuerySuggestionsConfigAsync(
DescribeQuerySuggestionsConfigRequest describeQuerySuggestionsConfigRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes an existing Amazon Kendra thesaurus.
*
*
* @param describeThesaurusRequest
* @return A Java Future containing the result of the DescribeThesaurus operation returned by the service.
* @sample AWSkendraAsync.DescribeThesaurus
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeThesaurusAsync(DescribeThesaurusRequest describeThesaurusRequest);
/**
*
* Describes an existing Amazon Kendra thesaurus.
*
*
* @param describeThesaurusRequest
* @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 DescribeThesaurus operation returned by the service.
* @sample AWSkendraAsyncHandler.DescribeThesaurus
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeThesaurusAsync(DescribeThesaurusRequest describeThesaurusRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Fetches the queries that are suggested to your users.
*
*
* @param getQuerySuggestionsRequest
* @return A Java Future containing the result of the GetQuerySuggestions operation returned by the service.
* @sample AWSkendraAsync.GetQuerySuggestions
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getQuerySuggestionsAsync(GetQuerySuggestionsRequest getQuerySuggestionsRequest);
/**
*
* Fetches the queries that are suggested to your users.
*
*
* @param getQuerySuggestionsRequest
* @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 GetQuerySuggestions operation returned by the service.
* @sample AWSkendraAsyncHandler.GetQuerySuggestions
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getQuerySuggestionsAsync(GetQuerySuggestionsRequest getQuerySuggestionsRequest,
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);
/**
*
* Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
*
*
* @param listGroupsOlderThanOrderingIdRequest
* @return A Java Future containing the result of the ListGroupsOlderThanOrderingId operation returned by the
* service.
* @sample AWSkendraAsync.ListGroupsOlderThanOrderingId
* @see AWS API Documentation
*/
java.util.concurrent.Future listGroupsOlderThanOrderingIdAsync(
ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest);
/**
*
* Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
*
*
* @param listGroupsOlderThanOrderingIdRequest
* @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 ListGroupsOlderThanOrderingId operation returned by the
* service.
* @sample AWSkendraAsyncHandler.ListGroupsOlderThanOrderingId
* @see AWS API Documentation
*/
java.util.concurrent.Future listGroupsOlderThanOrderingIdAsync(
ListGroupsOlderThanOrderingIdRequest listGroupsOlderThanOrderingIdRequest,
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);
/**
*
* 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.
*
*
* @param listQuerySuggestionsBlockListsRequest
* @return A Java Future containing the result of the ListQuerySuggestionsBlockLists operation returned by the
* service.
* @sample AWSkendraAsync.ListQuerySuggestionsBlockLists
* @see AWS API Documentation
*/
java.util.concurrent.Future listQuerySuggestionsBlockListsAsync(
ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest);
/**
*
* Lists the block lists used for query suggestions for an index.
*
*
* For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
*
*
* @param listQuerySuggestionsBlockListsRequest
* @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 ListQuerySuggestionsBlockLists operation returned by the
* service.
* @sample AWSkendraAsyncHandler.ListQuerySuggestionsBlockLists
* @see AWS API Documentation
*/
java.util.concurrent.Future listQuerySuggestionsBlockListsAsync(
ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags
* associated with them.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AWSkendraAsync.ListTagsForResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags
* associated with them.
*
*
* @param listTagsForResourceRequest
* @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 ListTagsForResource operation returned by the service.
* @sample AWSkendraAsyncHandler.ListTagsForResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the Amazon Kendra thesauri associated with an index.
*
*
* @param listThesauriRequest
* @return A Java Future containing the result of the ListThesauri operation returned by the service.
* @sample AWSkendraAsync.ListThesauri
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listThesauriAsync(ListThesauriRequest listThesauriRequest);
/**
*
* Lists the Amazon Kendra thesauri associated with an index.
*
*
* @param listThesauriRequest
* @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 ListThesauri operation returned by the service.
* @sample AWSkendraAsyncHandler.ListThesauri
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listThesauriAsync(ListThesauriRequest listThesauriRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param putPrincipalMappingRequest
* @return A Java Future containing the result of the PutPrincipalMapping operation returned by the service.
* @sample AWSkendraAsync.PutPrincipalMapping
* @see AWS API
* Documentation
*/
java.util.concurrent.Future putPrincipalMappingAsync(PutPrincipalMappingRequest putPrincipalMappingRequest);
/**
*
* 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.
*
*
* @param putPrincipalMappingRequest
* @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 PutPrincipalMapping operation returned by the service.
* @sample AWSkendraAsyncHandler.PutPrincipalMapping
* @see AWS API
* Documentation
*/
java.util.concurrent.Future putPrincipalMappingAsync(PutPrincipalMappingRequest putPrincipalMappingRequest,
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.
*
*
* Each query returns the 100 most relevant results.
*
*
* @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.
*
*
* Each query returns the 100 most relevant results.
*
*
* @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 your index.
*
*
* @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 your index.
*
*
* @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);
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AWSkendraAsync.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param tagResourceRequest
* @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 TagResource operation returned by the service.
* @sample AWSkendraAsyncHandler.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes a tag from an index, FAQ, or a data source.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AWSkendraAsync.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Removes a tag from an index, FAQ, or a data source.
*
*
* @param untagResourceRequest
* @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 UntagResource operation returned by the service.
* @sample AWSkendraAsyncHandler.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
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);
/**
*
* 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.
*
*
* @param updateQuerySuggestionsBlockListRequest
* @return A Java Future containing the result of the UpdateQuerySuggestionsBlockList operation returned by the
* service.
* @sample AWSkendraAsync.UpdateQuerySuggestionsBlockList
* @see AWS API Documentation
*/
java.util.concurrent.Future updateQuerySuggestionsBlockListAsync(
UpdateQuerySuggestionsBlockListRequest updateQuerySuggestionsBlockListRequest);
/**
*
* Updates a block list used for query suggestions for an index.
*
*
* Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions
* list to apply any updates to the block list. Other changes not related to the block list apply immediately.
*
*
* If a block list is updating, then you need to wait for the first update to finish before submitting another
* update.
*
*
* Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
*
*
* @param updateQuerySuggestionsBlockListRequest
* @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 UpdateQuerySuggestionsBlockList operation returned by the
* service.
* @sample AWSkendraAsyncHandler.UpdateQuerySuggestionsBlockList
* @see AWS API Documentation
*/
java.util.concurrent.Future updateQuerySuggestionsBlockListAsync(
UpdateQuerySuggestionsBlockListRequest updateQuerySuggestionsBlockListRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates the settings of query suggestions for an index.
*
*
* Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
*
*
* If an update is currently processing (i.e. 'happening'), you need to wait for the update to finish before making
* another update.
*
*
* Updates to query suggestions settings might not take effect right away. The time for your updated settings to
* take effect depends on the updates made and the number of search queries in your index.
*
*
* You can still enable/disable query suggestions at any time.
*
*
* @param updateQuerySuggestionsConfigRequest
* @return A Java Future containing the result of the UpdateQuerySuggestionsConfig operation returned by the
* service.
* @sample AWSkendraAsync.UpdateQuerySuggestionsConfig
* @see AWS API Documentation
*/
java.util.concurrent.Future updateQuerySuggestionsConfigAsync(
UpdateQuerySuggestionsConfigRequest updateQuerySuggestionsConfigRequest);
/**
*
* Updates the settings of query suggestions for an index.
*
*
* Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
*
*
* If an update is currently processing (i.e. 'happening'), you need to wait for the update to finish before making
* another update.
*
*
* Updates to query suggestions settings might not take effect right away. The time for your updated settings to
* take effect depends on the updates made and the number of search queries in your index.
*
*
* You can still enable/disable query suggestions at any time.
*
*
* @param updateQuerySuggestionsConfigRequest
* @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 UpdateQuerySuggestionsConfig operation returned by the
* service.
* @sample AWSkendraAsyncHandler.UpdateQuerySuggestionsConfig
* @see AWS API Documentation
*/
java.util.concurrent.Future updateQuerySuggestionsConfigAsync(
UpdateQuerySuggestionsConfigRequest updateQuerySuggestionsConfigRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates a thesaurus file associated with an index.
*
*
* @param updateThesaurusRequest
* @return A Java Future containing the result of the UpdateThesaurus operation returned by the service.
* @sample AWSkendraAsync.UpdateThesaurus
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateThesaurusAsync(UpdateThesaurusRequest updateThesaurusRequest);
/**
*
* Updates a thesaurus file associated with an index.
*
*
* @param updateThesaurusRequest
* @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 UpdateThesaurus operation returned by the service.
* @sample AWSkendraAsyncHandler.UpdateThesaurus
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateThesaurusAsync(UpdateThesaurusRequest updateThesaurusRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}