com.amazonaws.services.kendra

Class AWSkendraClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.kendra.AWSkendraClient

All Implemented Interfaces:

AWSkendra

Direct Known Subclasses:

AWSkendraAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSkendraClient
extends AmazonWebServiceClient
implements AWSkendra

Client for accessing kendra. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Kendra is a service for indexing large document sets.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.kendra.AWSkendra

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
BatchDeleteDocumentResult	batchDeleteDocument(BatchDeleteDocumentRequest request) Removes one or more documents from an index.
BatchPutDocumentResult	batchPutDocument(BatchPutDocumentRequest request) Adds one or more documents to an index.
static AWSkendraClientBuilder	builder()
CreateDataSourceResult	createDataSource(CreateDataSourceRequest request) Creates a data source that you use to with an Amazon Kendra index.
CreateFaqResult	createFaq(CreateFaqRequest request) Creates an new set of frequently asked question (FAQ) questions and answers.
CreateIndexResult	createIndex(CreateIndexRequest request) Creates a new Amazon Kendra index.
CreateThesaurusResult	createThesaurus(CreateThesaurusRequest request) Creates a thesaurus for an index.
DeleteDataSourceResult	deleteDataSource(DeleteDataSourceRequest request) Deletes an Amazon Kendra data source.
DeleteFaqResult	deleteFaq(DeleteFaqRequest request) Removes an FAQ from an index.
DeleteIndexResult	deleteIndex(DeleteIndexRequest request) Deletes an existing Amazon Kendra index.
DeleteThesaurusResult	deleteThesaurus(DeleteThesaurusRequest request) Deletes an existing Amazon Kendra thesaurus.
DescribeDataSourceResult	describeDataSource(DescribeDataSourceRequest request) Gets information about a Amazon Kendra data source.
DescribeFaqResult	describeFaq(DescribeFaqRequest request) Gets information about an FAQ list.
DescribeIndexResult	describeIndex(DescribeIndexRequest request) Describes an existing Amazon Kendra index
DescribeThesaurusResult	describeThesaurus(DescribeThesaurusRequest request) Describes an existing Amazon Kendra thesaurus.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ListDataSourcesResult	listDataSources(ListDataSourcesRequest request) Lists the data sources that you have created.
ListDataSourceSyncJobsResult	listDataSourceSyncJobs(ListDataSourceSyncJobsRequest request) Gets statistics about synchronizing Amazon Kendra with a data source.
ListFaqsResult	listFaqs(ListFaqsRequest request) Gets a list of FAQ lists associated with an index.
ListIndicesResult	listIndices(ListIndicesRequest request) Lists the Amazon Kendra indexes that you have created.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Gets a list of tags associated with a specified resource.
ListThesauriResult	listThesauri(ListThesauriRequest request) Lists the Amazon Kendra thesauri associated with an index.
QueryResult	query(QueryRequest request) Searches an active index.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartDataSourceSyncJobResult	startDataSourceSyncJob(StartDataSourceSyncJobRequest request) Starts a synchronization job for a data source.
StopDataSourceSyncJobResult	stopDataSourceSyncJob(StopDataSourceSyncJobRequest request) Stops a running synchronization job.
SubmitFeedbackResult	submitFeedback(SubmitFeedbackRequest request) Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
TagResourceResult	tagResource(TagResourceRequest request) Adds the specified tag to the specified index, FAQ, or data source resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes a tag from an index, FAQ, or a data source.
UpdateDataSourceResult	updateDataSource(UpdateDataSourceRequest request) Updates an existing Amazon Kendra data source.
UpdateIndexResult	updateIndex(UpdateIndexRequest request) Updates an existing Amazon Kendra index.
UpdateThesaurusResult	updateThesaurus(UpdateThesaurusRequest request) Updates a thesaurus file associated with an index.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSkendraClientBuilder builder()

batchDeleteDocument

public BatchDeleteDocumentResult batchDeleteDocument(BatchDeleteDocumentRequest request)

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.

Specified by:

batchDeleteDocument in interface AWSkendra

Parameters:

batchDeleteDocumentRequest -

Returns:

Result of the BatchDeleteDocument operation returned by the service.

Throws:

ValidationException

ConflictException

ResourceNotFoundException

ThrottlingException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

batchPutDocument

public BatchPutDocumentResult batchPutDocument(BatchPutDocumentRequest request)

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.

Specified by:

batchPutDocument in interface AWSkendra

Parameters:

batchPutDocumentRequest -

Returns:

Result of the BatchPutDocument operation returned by the service.

Throws:

ValidationException

ConflictException

ResourceNotFoundException

ThrottlingException

AccessDeniedException

ServiceQuotaExceededException

InternalServerException

See Also:

AWS API Documentation

createDataSource

public CreateDataSourceResult createDataSource(CreateDataSourceRequest request)

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.

Specified by:

createDataSource in interface AWSkendra

Parameters:

createDataSourceRequest -

Returns:

Result of the CreateDataSource operation returned by the service.

Throws:

ValidationException

ConflictException

ResourceNotFoundException

ResourceAlreadyExistException

ServiceQuotaExceededException

ThrottlingException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

createFaq

public CreateFaqResult createFaq(CreateFaqRequest request)

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

Specified by:

createFaq in interface AWSkendra

Parameters:

createFaqRequest -

Returns:

Result of the CreateFaq operation returned by the service.

Throws:

ValidationException

ConflictException

ResourceNotFoundException

ThrottlingException

ServiceQuotaExceededException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

createIndex

public CreateIndexResult createIndex(CreateIndexRequest request)

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.

Specified by:

createIndex in interface AWSkendra

Parameters:

createIndexRequest -

Returns:

Result of the CreateIndex operation returned by the service.

Throws:

ValidationException

ResourceAlreadyExistException

ServiceQuotaExceededException

ThrottlingException

AccessDeniedException

ConflictException

InternalServerException

See Also:

AWS API Documentation

createThesaurus

public CreateThesaurusResult createThesaurus(CreateThesaurusRequest request)

Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.

Specified by:

createThesaurus in interface AWSkendra

Parameters:

createThesaurusRequest -

Returns:

Result of the CreateThesaurus operation returned by the service.

Throws:

ValidationException

ConflictException

ResourceNotFoundException

ThrottlingException

ServiceQuotaExceededException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

deleteDataSource

public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)

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.

Specified by:

deleteDataSource in interface AWSkendra

Parameters:

deleteDataSourceRequest -

Returns:

Result of the DeleteDataSource operation returned by the service.

Throws:

AccessDeniedException

ValidationException

ConflictException

ResourceNotFoundException

ThrottlingException

InternalServerException

See Also:

AWS API Documentation

deleteFaq

public DeleteFaqResult deleteFaq(DeleteFaqRequest request)

Removes an FAQ from an index.

Specified by:

deleteFaq in interface AWSkendra

Parameters:

deleteFaqRequest -

Returns:

Result of the DeleteFaq operation returned by the service.

Throws:

ValidationException

ConflictException

ResourceNotFoundException

ThrottlingException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

deleteIndex

public DeleteIndexResult deleteIndex(DeleteIndexRequest request)

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.

Specified by:

deleteIndex in interface AWSkendra

Parameters:

deleteIndexRequest -

Returns:

Result of the DeleteIndex operation returned by the service.

Throws:

ValidationException

ConflictException

ResourceNotFoundException

ThrottlingException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

deleteThesaurus

public DeleteThesaurusResult deleteThesaurus(DeleteThesaurusRequest request)

Deletes an existing Amazon Kendra thesaurus.

Specified by:

deleteThesaurus in interface AWSkendra

Parameters:

deleteThesaurusRequest -

Returns:

Result of the DeleteThesaurus operation returned by the service.

Throws:

ValidationException

ConflictException

ResourceNotFoundException

ThrottlingException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

describeDataSource

public DescribeDataSourceResult describeDataSource(DescribeDataSourceRequest request)

Gets information about a Amazon Kendra data source.

Specified by:

describeDataSource in interface AWSkendra

Parameters:

describeDataSourceRequest -

Returns:

Result of the DescribeDataSource operation returned by the service.

Throws:

ValidationException

ResourceNotFoundException

ThrottlingException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

describeFaq

public DescribeFaqResult describeFaq(DescribeFaqRequest request)

Gets information about an FAQ list.

Specified by:

describeFaq in interface AWSkendra

Parameters:

describeFaqRequest -

Returns:

Result of the DescribeFaq operation returned by the service.

Throws:

ValidationException

ResourceNotFoundException

ThrottlingException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

describeIndex

public DescribeIndexResult describeIndex(DescribeIndexRequest request)

Describes an existing Amazon Kendra index

Specified by:

describeIndex in interface AWSkendra

Parameters:

describeIndexRequest -

Returns:

Result of the DescribeIndex operation returned by the service.

Throws:

ValidationException

ResourceNotFoundException

ThrottlingException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

describeThesaurus

public DescribeThesaurusResult describeThesaurus(DescribeThesaurusRequest request)

Describes an existing Amazon Kendra thesaurus.

Specified by:

describeThesaurus in interface AWSkendra

Parameters:

describeThesaurusRequest -

Returns:

Result of the DescribeThesaurus operation returned by the service.

Throws:

ValidationException

ResourceNotFoundException

ThrottlingException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

listDataSourceSyncJobs

public ListDataSourceSyncJobsResult listDataSourceSyncJobs(ListDataSourceSyncJobsRequest request)

Gets statistics about synchronizing Amazon Kendra with a data source.

Specified by:

listDataSourceSyncJobs in interface AWSkendra

Parameters:

listDataSourceSyncJobsRequest -

Returns:

Result of the ListDataSourceSyncJobs operation returned by the service.

Throws:

ValidationException

ResourceNotFoundException

ThrottlingException

AccessDeniedException

ConflictException

InternalServerException

See Also:

AWS API Documentation

listDataSources

public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)

Lists the data sources that you have created.

Specified by:

listDataSources in interface AWSkendra

Parameters:

listDataSourcesRequest -

Returns:

Result of the ListDataSources operation returned by the service.

Throws:

ValidationException

ResourceNotFoundException

AccessDeniedException

ThrottlingException

InternalServerException

See Also:

AWS API Documentation

listFaqs

public ListFaqsResult listFaqs(ListFaqsRequest request)

Gets a list of FAQ lists associated with an index.

Specified by:

listFaqs in interface AWSkendra

Parameters:

listFaqsRequest -

Returns:

Result of the ListFaqs operation returned by the service.

Throws:

ValidationException

ResourceNotFoundException

ThrottlingException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

listIndices

public ListIndicesResult listIndices(ListIndicesRequest request)

Lists the Amazon Kendra indexes that you have created.

Specified by:

listIndices in interface AWSkendra

Parameters:

listIndicesRequest -

Returns:

Result of the ListIndices operation returned by the service.

Throws:

ValidationException

ThrottlingException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.

Specified by:

listTagsForResource in interface AWSkendra

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ValidationException

ResourceUnavailableException

ThrottlingException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

listThesauri

public ListThesauriResult listThesauri(ListThesauriRequest request)

Lists the Amazon Kendra thesauri associated with an index.

Specified by:

listThesauri in interface AWSkendra

Parameters:

listThesauriRequest -

Returns:

Result of the ListThesauri operation returned by the service.

Throws:

ValidationException

ResourceNotFoundException

ThrottlingException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

query

public QueryResult query(QueryRequest request)

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.

Specified by:

query in interface AWSkendra

Parameters:

queryRequest -

Returns:

Result of the Query operation returned by the service.

Throws:

ValidationException

ConflictException

ResourceNotFoundException

ThrottlingException

AccessDeniedException

ServiceQuotaExceededException

InternalServerException

See Also:

AWS API Documentation

startDataSourceSyncJob

public StartDataSourceSyncJobResult startDataSourceSyncJob(StartDataSourceSyncJobRequest request)

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

Specified by:

startDataSourceSyncJob in interface AWSkendra

Parameters:

startDataSourceSyncJobRequest -

Returns:

Result of the StartDataSourceSyncJob operation returned by the service.

Throws:

ValidationException

ResourceNotFoundException

ResourceInUseException

ThrottlingException

AccessDeniedException

ConflictException

InternalServerException

See Also:

AWS API Documentation

stopDataSourceSyncJob

public StopDataSourceSyncJobResult stopDataSourceSyncJob(StopDataSourceSyncJobRequest request)

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

Specified by:

stopDataSourceSyncJob in interface AWSkendra

Parameters:

stopDataSourceSyncJobRequest -

Returns:

Result of the StopDataSourceSyncJob operation returned by the service.

Throws:

ValidationException

ResourceNotFoundException

ThrottlingException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

submitFeedback

public SubmitFeedbackResult submitFeedback(SubmitFeedbackRequest request)

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

Specified by:

submitFeedback in interface AWSkendra

Parameters:

submitFeedbackRequest -

Returns:

Result of the SubmitFeedback operation returned by the service.

Throws:

ValidationException

ResourceUnavailableException

ResourceNotFoundException

ThrottlingException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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.

Specified by:

tagResource in interface AWSkendra

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ValidationException

ResourceUnavailableException

ThrottlingException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes a tag from an index, FAQ, or a data source.

Specified by:

untagResource in interface AWSkendra

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ValidationException

ResourceUnavailableException

ThrottlingException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

updateDataSource

public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)

Updates an existing Amazon Kendra data source.

Specified by:

updateDataSource in interface AWSkendra

Parameters:

updateDataSourceRequest -

Returns:

Result of the UpdateDataSource operation returned by the service.

Throws:

ValidationException

ConflictException

ResourceNotFoundException

ThrottlingException

AccessDeniedException

InternalServerException

See Also:

AWS API Documentation

updateIndex

public UpdateIndexResult updateIndex(UpdateIndexRequest request)

Updates an existing Amazon Kendra index.

Specified by:

updateIndex in interface AWSkendra

Parameters:

updateIndexRequest -

Returns:

Result of the UpdateIndex operation returned by the service.

Throws:

ValidationException

ConflictException

ResourceNotFoundException

ThrottlingException

AccessDeniedException

ServiceQuotaExceededException

InternalServerException

See Also:

AWS API Documentation

updateThesaurus

public UpdateThesaurusResult updateThesaurus(UpdateThesaurusRequest request)

Updates a thesaurus file associated with an index.

Specified by:

updateThesaurus in interface AWSkendra

Parameters:

updateThesaurusRequest -

Returns:

Result of the UpdateThesaurus operation returned by the service.

Throws:

ValidationException

ResourceNotFoundException

ThrottlingException

AccessDeniedException

ConflictException

InternalServerException

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSkendra

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSkendra

Overrides:

shutdown in class AmazonWebServiceClient