@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface KendraAsyncClient extends SdkClient
builder() method.
Amazon Kendra is a service for indexing large document sets.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<BatchDeleteDocumentResponse> |
batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest)
Removes one or more documents from an index.
|
default CompletableFuture<BatchDeleteDocumentResponse> |
batchDeleteDocument(Consumer<BatchDeleteDocumentRequest.Builder> batchDeleteDocumentRequest)
Removes one or more documents from an index.
|
default CompletableFuture<BatchPutDocumentResponse> |
batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest)
Adds one or more documents to an index.
|
default CompletableFuture<BatchPutDocumentResponse> |
batchPutDocument(Consumer<BatchPutDocumentRequest.Builder> batchPutDocumentRequest)
Adds one or more documents to an index.
|
static KendraAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
KendraAsyncClient. |
static KendraAsyncClient |
create()
Create a
KendraAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateDataSourceResponse> |
createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest)
Creates a data source that you use to with an Amazon Kendra index.
|
default CompletableFuture<CreateDataSourceResponse> |
createDataSource(CreateDataSourceRequest createDataSourceRequest)
Creates a data source that you use to with an Amazon Kendra index.
|
default CompletableFuture<CreateFaqResponse> |
createFaq(Consumer<CreateFaqRequest.Builder> createFaqRequest)
Creates an new set of frequently asked question (FAQ) questions and answers.
|
default CompletableFuture<CreateFaqResponse> |
createFaq(CreateFaqRequest createFaqRequest)
Creates an new set of frequently asked question (FAQ) questions and answers.
|
default CompletableFuture<CreateIndexResponse> |
createIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest)
Creates a new Amazon Kendra index.
|
default CompletableFuture<CreateIndexResponse> |
createIndex(CreateIndexRequest createIndexRequest)
Creates a new Amazon Kendra index.
|
default CompletableFuture<CreateThesaurusResponse> |
createThesaurus(Consumer<CreateThesaurusRequest.Builder> createThesaurusRequest)
Creates a thesaurus for an index.
|
default CompletableFuture<CreateThesaurusResponse> |
createThesaurus(CreateThesaurusRequest createThesaurusRequest)
Creates a thesaurus for an index.
|
default CompletableFuture<DeleteDataSourceResponse> |
deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest)
Deletes an Amazon Kendra data source.
|
default CompletableFuture<DeleteDataSourceResponse> |
deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes an Amazon Kendra data source.
|
default CompletableFuture<DeleteFaqResponse> |
deleteFaq(Consumer<DeleteFaqRequest.Builder> deleteFaqRequest)
Removes an FAQ from an index.
|
default CompletableFuture<DeleteFaqResponse> |
deleteFaq(DeleteFaqRequest deleteFaqRequest)
Removes an FAQ from an index.
|
default CompletableFuture<DeleteIndexResponse> |
deleteIndex(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest)
Deletes an existing Amazon Kendra index.
|
default CompletableFuture<DeleteIndexResponse> |
deleteIndex(DeleteIndexRequest deleteIndexRequest)
Deletes an existing Amazon Kendra index.
|
default CompletableFuture<DeleteThesaurusResponse> |
deleteThesaurus(Consumer<DeleteThesaurusRequest.Builder> deleteThesaurusRequest)
Deletes an existing Amazon Kendra thesaurus.
|
default CompletableFuture<DeleteThesaurusResponse> |
deleteThesaurus(DeleteThesaurusRequest deleteThesaurusRequest)
Deletes an existing Amazon Kendra thesaurus.
|
default CompletableFuture<DescribeDataSourceResponse> |
describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest)
Gets information about a Amazon Kendra data source.
|
default CompletableFuture<DescribeDataSourceResponse> |
describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
Gets information about a Amazon Kendra data source.
|
default CompletableFuture<DescribeFaqResponse> |
describeFaq(Consumer<DescribeFaqRequest.Builder> describeFaqRequest)
Gets information about an FAQ list.
|
default CompletableFuture<DescribeFaqResponse> |
describeFaq(DescribeFaqRequest describeFaqRequest)
Gets information about an FAQ list.
|
default CompletableFuture<DescribeIndexResponse> |
describeIndex(Consumer<DescribeIndexRequest.Builder> describeIndexRequest)
Describes an existing Amazon Kendra index
|
default CompletableFuture<DescribeIndexResponse> |
describeIndex(DescribeIndexRequest describeIndexRequest)
Describes an existing Amazon Kendra index
|
default CompletableFuture<DescribeThesaurusResponse> |
describeThesaurus(Consumer<DescribeThesaurusRequest.Builder> describeThesaurusRequest)
Describes an existing Amazon Kendra thesaurus.
|
default CompletableFuture<DescribeThesaurusResponse> |
describeThesaurus(DescribeThesaurusRequest describeThesaurusRequest)
Describes an existing Amazon Kendra thesaurus.
|
default CompletableFuture<ListDataSourcesResponse> |
listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists the data sources that you have created.
|
default CompletableFuture<ListDataSourcesResponse> |
listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists the data sources that you have created.
|
default ListDataSourcesPublisher |
listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists the data sources that you have created.
|
default ListDataSourcesPublisher |
listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)
Lists the data sources that you have created.
|
default CompletableFuture<ListDataSourceSyncJobsResponse> |
listDataSourceSyncJobs(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest)
Gets statistics about synchronizing Amazon Kendra with a data source.
|
default CompletableFuture<ListDataSourceSyncJobsResponse> |
listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Gets statistics about synchronizing Amazon Kendra with a data source.
|
default ListDataSourceSyncJobsPublisher |
listDataSourceSyncJobsPaginator(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest)
Gets statistics about synchronizing Amazon Kendra with a data source.
|
default ListDataSourceSyncJobsPublisher |
listDataSourceSyncJobsPaginator(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Gets statistics about synchronizing Amazon Kendra with a data source.
|
default CompletableFuture<ListFaqsResponse> |
listFaqs(Consumer<ListFaqsRequest.Builder> listFaqsRequest)
Gets a list of FAQ lists associated with an index.
|
default CompletableFuture<ListFaqsResponse> |
listFaqs(ListFaqsRequest listFaqsRequest)
Gets a list of FAQ lists associated with an index.
|
default CompletableFuture<ListIndicesResponse> |
listIndices(Consumer<ListIndicesRequest.Builder> listIndicesRequest)
Lists the Amazon Kendra indexes that you have created.
|
default CompletableFuture<ListIndicesResponse> |
listIndices(ListIndicesRequest listIndicesRequest)
Lists the Amazon Kendra indexes that you have created.
|
default ListIndicesPublisher |
listIndicesPaginator(Consumer<ListIndicesRequest.Builder> listIndicesRequest)
Lists the Amazon Kendra indexes that you have created.
|
default ListIndicesPublisher |
listIndicesPaginator(ListIndicesRequest listIndicesRequest)
Lists the Amazon Kendra indexes that you have created.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets a list of tags associated with a specified resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets a list of tags associated with a specified resource.
|
default CompletableFuture<ListThesauriResponse> |
listThesauri(Consumer<ListThesauriRequest.Builder> listThesauriRequest)
Lists the Amazon Kendra thesauri associated with an index.
|
default CompletableFuture<ListThesauriResponse> |
listThesauri(ListThesauriRequest listThesauriRequest)
Lists the Amazon Kendra thesauri associated with an index.
|
default CompletableFuture<QueryResponse> |
query(Consumer<QueryRequest.Builder> queryRequest)
Searches an active index.
|
default CompletableFuture<QueryResponse> |
query(QueryRequest queryRequest)
Searches an active index.
|
default CompletableFuture<StartDataSourceSyncJobResponse> |
startDataSourceSyncJob(Consumer<StartDataSourceSyncJobRequest.Builder> startDataSourceSyncJobRequest)
Starts a synchronization job for a data source.
|
default CompletableFuture<StartDataSourceSyncJobResponse> |
startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)
Starts a synchronization job for a data source.
|
default CompletableFuture<StopDataSourceSyncJobResponse> |
stopDataSourceSyncJob(Consumer<StopDataSourceSyncJobRequest.Builder> stopDataSourceSyncJobRequest)
Stops a running synchronization job.
|
default CompletableFuture<StopDataSourceSyncJobResponse> |
stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)
Stops a running synchronization job.
|
default CompletableFuture<SubmitFeedbackResponse> |
submitFeedback(Consumer<SubmitFeedbackRequest.Builder> submitFeedbackRequest)
Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
|
default CompletableFuture<SubmitFeedbackResponse> |
submitFeedback(SubmitFeedbackRequest submitFeedbackRequest)
Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds the specified tag to the specified index, FAQ, or data source resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tag to the specified index, FAQ, or data source resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag from an index, FAQ, or a data source.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an index, FAQ, or a data source.
|
default CompletableFuture<UpdateDataSourceResponse> |
updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)
Updates an existing Amazon Kendra data source.
|
default CompletableFuture<UpdateDataSourceResponse> |
updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates an existing Amazon Kendra data source.
|
default CompletableFuture<UpdateIndexResponse> |
updateIndex(Consumer<UpdateIndexRequest.Builder> updateIndexRequest)
Updates an existing Amazon Kendra index.
|
default CompletableFuture<UpdateIndexResponse> |
updateIndex(UpdateIndexRequest updateIndexRequest)
Updates an existing Amazon Kendra index.
|
default CompletableFuture<UpdateThesaurusResponse> |
updateThesaurus(Consumer<UpdateThesaurusRequest.Builder> updateThesaurusRequest)
Updates a thesaurus file associated with an index.
|
default CompletableFuture<UpdateThesaurusResponse> |
updateThesaurus(UpdateThesaurusRequest updateThesaurusRequest)
Updates a thesaurus file associated with an index.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static KendraAsyncClient create()
KendraAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static KendraAsyncClientBuilder builder()
KendraAsyncClient.default CompletableFuture<BatchDeleteDocumentResponse> batchDeleteDocument(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 - default CompletableFuture<BatchDeleteDocumentResponse> batchDeleteDocument(Consumer<BatchDeleteDocumentRequest.Builder> 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.
This is a convenience which creates an instance of the BatchDeleteDocumentRequest.Builder avoiding the
need to create one manually via BatchDeleteDocumentRequest.builder()
batchDeleteDocumentRequest - A Consumer that will call methods on BatchDeleteDocumentRequest.Builder to create a
request.default CompletableFuture<BatchPutDocumentResponse> batchPutDocument(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 - default CompletableFuture<BatchPutDocumentResponse> batchPutDocument(Consumer<BatchPutDocumentRequest.Builder> 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.
This is a convenience which creates an instance of the BatchPutDocumentRequest.Builder avoiding the need
to create one manually via BatchPutDocumentRequest.builder()
batchPutDocumentRequest - A Consumer that will call methods on BatchPutDocumentRequest.Builder to create a request.default CompletableFuture<CreateDataSourceResponse> createDataSource(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 - default CompletableFuture<CreateDataSourceResponse> createDataSource(Consumer<CreateDataSourceRequest.Builder> 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.
This is a convenience which creates an instance of the CreateDataSourceRequest.Builder avoiding the need
to create one manually via CreateDataSourceRequest.builder()
createDataSourceRequest - A Consumer that will call methods on CreateDataSourceRequest.Builder to create a request.default CompletableFuture<CreateFaqResponse> createFaq(CreateFaqRequest createFaqRequest)
Creates an new set of frequently asked question (FAQ) questions and answers.
createFaqRequest - default CompletableFuture<CreateFaqResponse> createFaq(Consumer<CreateFaqRequest.Builder> createFaqRequest)
Creates an new set of frequently asked question (FAQ) questions and answers.
This is a convenience which creates an instance of the CreateFaqRequest.Builder avoiding the need to
create one manually via CreateFaqRequest.builder()
createFaqRequest - A Consumer that will call methods on CreateFaqRequest.Builder to create a request.default CompletableFuture<CreateIndexResponse> createIndex(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 - default CompletableFuture<CreateIndexResponse> createIndex(Consumer<CreateIndexRequest.Builder> 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.
This is a convenience which creates an instance of the CreateIndexRequest.Builder avoiding the need to
create one manually via CreateIndexRequest.builder()
createIndexRequest - A Consumer that will call methods on CreateIndexRequest.Builder to create a request.default CompletableFuture<CreateThesaurusResponse> createThesaurus(CreateThesaurusRequest createThesaurusRequest)
Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
createThesaurusRequest - default CompletableFuture<CreateThesaurusResponse> createThesaurus(Consumer<CreateThesaurusRequest.Builder> createThesaurusRequest)
Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
This is a convenience which creates an instance of the CreateThesaurusRequest.Builder avoiding the need
to create one manually via CreateThesaurusRequest.builder()
createThesaurusRequest - A Consumer that will call methods on CreateThesaurusRequest.Builder to create a request.default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(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 - default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteDataSourceRequest.Builder avoiding the need
to create one manually via DeleteDataSourceRequest.builder()
deleteDataSourceRequest - A Consumer that will call methods on DeleteDataSourceRequest.Builder to create a request.default CompletableFuture<DeleteFaqResponse> deleteFaq(DeleteFaqRequest deleteFaqRequest)
Removes an FAQ from an index.
deleteFaqRequest - default CompletableFuture<DeleteFaqResponse> deleteFaq(Consumer<DeleteFaqRequest.Builder> deleteFaqRequest)
Removes an FAQ from an index.
This is a convenience which creates an instance of the DeleteFaqRequest.Builder avoiding the need to
create one manually via DeleteFaqRequest.builder()
deleteFaqRequest - A Consumer that will call methods on DeleteFaqRequest.Builder to create a request.default CompletableFuture<DeleteIndexResponse> deleteIndex(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 - default CompletableFuture<DeleteIndexResponse> deleteIndex(Consumer<DeleteIndexRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteIndexRequest.Builder avoiding the need to
create one manually via DeleteIndexRequest.builder()
deleteIndexRequest - A Consumer that will call methods on DeleteIndexRequest.Builder to create a request.default CompletableFuture<DeleteThesaurusResponse> deleteThesaurus(DeleteThesaurusRequest deleteThesaurusRequest)
Deletes an existing Amazon Kendra thesaurus.
deleteThesaurusRequest - default CompletableFuture<DeleteThesaurusResponse> deleteThesaurus(Consumer<DeleteThesaurusRequest.Builder> deleteThesaurusRequest)
Deletes an existing Amazon Kendra thesaurus.
This is a convenience which creates an instance of the DeleteThesaurusRequest.Builder avoiding the need
to create one manually via DeleteThesaurusRequest.builder()
deleteThesaurusRequest - A Consumer that will call methods on DeleteThesaurusRequest.Builder to create a request.default CompletableFuture<DescribeDataSourceResponse> describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
Gets information about a Amazon Kendra data source.
describeDataSourceRequest - default CompletableFuture<DescribeDataSourceResponse> describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest)
Gets information about a Amazon Kendra data source.
This is a convenience which creates an instance of the DescribeDataSourceRequest.Builder avoiding the
need to create one manually via DescribeDataSourceRequest.builder()
describeDataSourceRequest - A Consumer that will call methods on DescribeDataSourceRequest.Builder to create a
request.default CompletableFuture<DescribeFaqResponse> describeFaq(DescribeFaqRequest describeFaqRequest)
Gets information about an FAQ list.
describeFaqRequest - default CompletableFuture<DescribeFaqResponse> describeFaq(Consumer<DescribeFaqRequest.Builder> describeFaqRequest)
Gets information about an FAQ list.
This is a convenience which creates an instance of the DescribeFaqRequest.Builder avoiding the need to
create one manually via DescribeFaqRequest.builder()
describeFaqRequest - A Consumer that will call methods on DescribeFaqRequest.Builder to create a request.default CompletableFuture<DescribeIndexResponse> describeIndex(DescribeIndexRequest describeIndexRequest)
Describes an existing Amazon Kendra index
describeIndexRequest - default CompletableFuture<DescribeIndexResponse> describeIndex(Consumer<DescribeIndexRequest.Builder> describeIndexRequest)
Describes an existing Amazon Kendra index
This is a convenience which creates an instance of the DescribeIndexRequest.Builder avoiding the need to
create one manually via DescribeIndexRequest.builder()
describeIndexRequest - A Consumer that will call methods on DescribeIndexRequest.Builder to create a request.default CompletableFuture<DescribeThesaurusResponse> describeThesaurus(DescribeThesaurusRequest describeThesaurusRequest)
Describes an existing Amazon Kendra thesaurus.
describeThesaurusRequest - default CompletableFuture<DescribeThesaurusResponse> describeThesaurus(Consumer<DescribeThesaurusRequest.Builder> describeThesaurusRequest)
Describes an existing Amazon Kendra thesaurus.
This is a convenience which creates an instance of the DescribeThesaurusRequest.Builder avoiding the need
to create one manually via DescribeThesaurusRequest.builder()
describeThesaurusRequest - A Consumer that will call methods on DescribeThesaurusRequest.Builder to create a request.default CompletableFuture<ListDataSourceSyncJobsResponse> listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Gets statistics about synchronizing Amazon Kendra with a data source.
listDataSourceSyncJobsRequest - default CompletableFuture<ListDataSourceSyncJobsResponse> listDataSourceSyncJobs(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest)
Gets statistics about synchronizing Amazon Kendra with a data source.
This is a convenience which creates an instance of the ListDataSourceSyncJobsRequest.Builder avoiding the
need to create one manually via ListDataSourceSyncJobsRequest.builder()
listDataSourceSyncJobsRequest - A Consumer that will call methods on ListDataSourceSyncJobsRequest.Builder to create a
request.default ListDataSourceSyncJobsPublisher listDataSourceSyncJobsPaginator(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Gets statistics about synchronizing Amazon Kendra with a data source.
This is a variant of
listDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsPublisher publisher = client.listDataSourceSyncJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsPublisher publisher = client.listDataSourceSyncJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)
operation.
listDataSourceSyncJobsRequest - default ListDataSourceSyncJobsPublisher listDataSourceSyncJobsPaginator(Consumer<ListDataSourceSyncJobsRequest.Builder> listDataSourceSyncJobsRequest)
Gets statistics about synchronizing Amazon Kendra with a data source.
This is a variant of
listDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsPublisher publisher = client.listDataSourceSyncJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListDataSourceSyncJobsPublisher publisher = client.listDataSourceSyncJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSourceSyncJobs(software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest)
operation.
This is a convenience which creates an instance of the ListDataSourceSyncJobsRequest.Builder avoiding the
need to create one manually via ListDataSourceSyncJobsRequest.builder()
listDataSourceSyncJobsRequest - A Consumer that will call methods on ListDataSourceSyncJobsRequest.Builder to create a
request.default CompletableFuture<ListDataSourcesResponse> listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists the data sources that you have created.
listDataSourcesRequest - default CompletableFuture<ListDataSourcesResponse> listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists the data sources that you have created.
This is a convenience which creates an instance of the ListDataSourcesRequest.Builder avoiding the need
to create one manually via ListDataSourcesRequest.builder()
listDataSourcesRequest - A Consumer that will call methods on ListDataSourcesRequest.Builder to create a request.default ListDataSourcesPublisher listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)
Lists the data sources that you have created.
This is a variant of
listDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListDataSourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListDataSourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest) operation.
listDataSourcesRequest - default ListDataSourcesPublisher listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists the data sources that you have created.
This is a variant of
listDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListDataSourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListDataSourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.kendra.model.ListDataSourcesRequest) operation.
This is a convenience which creates an instance of the ListDataSourcesRequest.Builder avoiding the need
to create one manually via ListDataSourcesRequest.builder()
listDataSourcesRequest - A Consumer that will call methods on ListDataSourcesRequest.Builder to create a request.default CompletableFuture<ListFaqsResponse> listFaqs(ListFaqsRequest listFaqsRequest)
Gets a list of FAQ lists associated with an index.
listFaqsRequest - default CompletableFuture<ListFaqsResponse> listFaqs(Consumer<ListFaqsRequest.Builder> listFaqsRequest)
Gets a list of FAQ lists associated with an index.
This is a convenience which creates an instance of the ListFaqsRequest.Builder avoiding the need to
create one manually via ListFaqsRequest.builder()
listFaqsRequest - A Consumer that will call methods on ListFaqsRequest.Builder to create a request.default CompletableFuture<ListIndicesResponse> listIndices(ListIndicesRequest listIndicesRequest)
Lists the Amazon Kendra indexes that you have created.
listIndicesRequest - default CompletableFuture<ListIndicesResponse> listIndices(Consumer<ListIndicesRequest.Builder> listIndicesRequest)
Lists the Amazon Kendra indexes that you have created.
This is a convenience which creates an instance of the ListIndicesRequest.Builder avoiding the need to
create one manually via ListIndicesRequest.builder()
listIndicesRequest - A Consumer that will call methods on ListIndicesRequest.Builder to create a request.default ListIndicesPublisher listIndicesPaginator(ListIndicesRequest listIndicesRequest)
Lists the Amazon Kendra indexes that you have created.
This is a variant of listIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListIndicesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListIndicesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest) operation.
listIndicesRequest - default ListIndicesPublisher listIndicesPaginator(Consumer<ListIndicesRequest.Builder> listIndicesRequest)
Lists the Amazon Kendra indexes that you have created.
This is a variant of listIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kendra.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kendra.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kendra.model.ListIndicesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kendra.model.ListIndicesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIndices(software.amazon.awssdk.services.kendra.model.ListIndicesRequest) operation.
This is a convenience which creates an instance of the ListIndicesRequest.Builder avoiding the need to
create one manually via ListIndicesRequest.builder()
listIndicesRequest - A Consumer that will call methods on ListIndicesRequest.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<ListThesauriResponse> listThesauri(ListThesauriRequest listThesauriRequest)
Lists the Amazon Kendra thesauri associated with an index.
listThesauriRequest - default CompletableFuture<ListThesauriResponse> listThesauri(Consumer<ListThesauriRequest.Builder> listThesauriRequest)
Lists the Amazon Kendra thesauri associated with an index.
This is a convenience which creates an instance of the ListThesauriRequest.Builder avoiding the need to
create one manually via ListThesauriRequest.builder()
listThesauriRequest - A Consumer that will call methods on ListThesauriRequest.Builder to create a request.default CompletableFuture<QueryResponse> query(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 - default CompletableFuture<QueryResponse> query(Consumer<QueryRequest.Builder> 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.
This is a convenience which creates an instance of the QueryRequest.Builder avoiding the need to create
one manually via QueryRequest.builder()
queryRequest - A Consumer that will call methods on QueryRequest.Builder to create a request.default CompletableFuture<StartDataSourceSyncJobResponse> startDataSourceSyncJob(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 - default CompletableFuture<StartDataSourceSyncJobResponse> startDataSourceSyncJob(Consumer<StartDataSourceSyncJobRequest.Builder> startDataSourceSyncJobRequest)
Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra
returns a ResourceInUseException exception.
This is a convenience which creates an instance of the StartDataSourceSyncJobRequest.Builder avoiding the
need to create one manually via StartDataSourceSyncJobRequest.builder()
startDataSourceSyncJobRequest - A Consumer that will call methods on StartDataSourceSyncJobRequest.Builder to create a
request.default CompletableFuture<StopDataSourceSyncJobResponse> stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)
Stops a running synchronization job. You can't stop a scheduled synchronization job.
stopDataSourceSyncJobRequest - default CompletableFuture<StopDataSourceSyncJobResponse> stopDataSourceSyncJob(Consumer<StopDataSourceSyncJobRequest.Builder> stopDataSourceSyncJobRequest)
Stops a running synchronization job. You can't stop a scheduled synchronization job.
This is a convenience which creates an instance of the StopDataSourceSyncJobRequest.Builder avoiding the
need to create one manually via StopDataSourceSyncJobRequest.builder()
stopDataSourceSyncJobRequest - A Consumer that will call methods on StopDataSourceSyncJobRequest.Builder to create a
request.default CompletableFuture<SubmitFeedbackResponse> submitFeedback(SubmitFeedbackRequest submitFeedbackRequest)
Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
submitFeedbackRequest - default CompletableFuture<SubmitFeedbackResponse> submitFeedback(Consumer<SubmitFeedbackRequest.Builder> submitFeedbackRequest)
Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
This is a convenience which creates an instance of the SubmitFeedbackRequest.Builder avoiding the need to
create one manually via SubmitFeedbackRequest.builder()
submitFeedbackRequest - A Consumer that will call methods on SubmitFeedbackRequest.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(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 - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an index, FAQ, or a data source.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag from an index, FAQ, or a data source.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateDataSourceResponse> updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates an existing Amazon Kendra data source.
updateDataSourceRequest - default CompletableFuture<UpdateDataSourceResponse> updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)
Updates an existing Amazon Kendra data source.
This is a convenience which creates an instance of the UpdateDataSourceRequest.Builder avoiding the need
to create one manually via UpdateDataSourceRequest.builder()
updateDataSourceRequest - A Consumer that will call methods on UpdateDataSourceRequest.Builder to create a request.default CompletableFuture<UpdateIndexResponse> updateIndex(UpdateIndexRequest updateIndexRequest)
Updates an existing Amazon Kendra index.
updateIndexRequest - default CompletableFuture<UpdateIndexResponse> updateIndex(Consumer<UpdateIndexRequest.Builder> updateIndexRequest)
Updates an existing Amazon Kendra index.
This is a convenience which creates an instance of the UpdateIndexRequest.Builder avoiding the need to
create one manually via UpdateIndexRequest.builder()
updateIndexRequest - A Consumer that will call methods on UpdateIndexRequest.Builder to create a request.default CompletableFuture<UpdateThesaurusResponse> updateThesaurus(UpdateThesaurusRequest updateThesaurusRequest)
Updates a thesaurus file associated with an index.
updateThesaurusRequest - default CompletableFuture<UpdateThesaurusResponse> updateThesaurus(Consumer<UpdateThesaurusRequest.Builder> updateThesaurusRequest)
Updates a thesaurus file associated with an index.
This is a convenience which creates an instance of the UpdateThesaurusRequest.Builder avoiding the need
to create one manually via UpdateThesaurusRequest.builder()
updateThesaurusRequest - A Consumer that will call methods on UpdateThesaurusRequest.Builder to create a request.Copyright © 2021. All rights reserved.