@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSkendra
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSkendra instead.
Amazon Kendra is a service for indexing large document sets.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
BatchDeleteDocumentResult |
batchDeleteDocument(BatchDeleteDocumentRequest batchDeleteDocumentRequest)
Removes one or more documents from an index.
|
BatchPutDocumentResult |
batchPutDocument(BatchPutDocumentRequest batchPutDocumentRequest)
Adds one or more documents to an index.
|
ClearQuerySuggestionsResult |
clearQuerySuggestions(ClearQuerySuggestionsRequest clearQuerySuggestionsRequest)
Clears existing query suggestions from an index.
|
CreateDataSourceResult |
createDataSource(CreateDataSourceRequest createDataSourceRequest)
Creates a data source that you use to with an Amazon Kendra index.
|
CreateFaqResult |
createFaq(CreateFaqRequest createFaqRequest)
Creates an new set of frequently asked question (FAQ) questions and answers.
|
CreateIndexResult |
createIndex(CreateIndexRequest createIndexRequest)
Creates a new Amazon Kendra index.
|
CreateQuerySuggestionsBlockListResult |
createQuerySuggestionsBlockList(CreateQuerySuggestionsBlockListRequest createQuerySuggestionsBlockListRequest)
Creates a block list to exlcude certain queries from suggestions.
|
CreateThesaurusResult |
createThesaurus(CreateThesaurusRequest createThesaurusRequest)
Creates a thesaurus for an index.
|
DeleteDataSourceResult |
deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes an Amazon Kendra data source.
|
DeleteFaqResult |
deleteFaq(DeleteFaqRequest deleteFaqRequest)
Removes an FAQ from an index.
|
DeleteIndexResult |
deleteIndex(DeleteIndexRequest deleteIndexRequest)
Deletes an existing Amazon Kendra index.
|
DeleteQuerySuggestionsBlockListResult |
deleteQuerySuggestionsBlockList(DeleteQuerySuggestionsBlockListRequest deleteQuerySuggestionsBlockListRequest)
Deletes a block list used for query suggestions for an index.
|
DeleteThesaurusResult |
deleteThesaurus(DeleteThesaurusRequest deleteThesaurusRequest)
Deletes an existing Amazon Kendra thesaurus.
|
DescribeDataSourceResult |
describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
Gets information about a Amazon Kendra data source.
|
DescribeFaqResult |
describeFaq(DescribeFaqRequest describeFaqRequest)
Gets information about an FAQ list.
|
DescribeIndexResult |
describeIndex(DescribeIndexRequest describeIndexRequest)
Describes an existing Amazon Kendra index
|
DescribeQuerySuggestionsBlockListResult |
describeQuerySuggestionsBlockList(DescribeQuerySuggestionsBlockListRequest describeQuerySuggestionsBlockListRequest)
Describes a block list used for query suggestions for an index.
|
DescribeQuerySuggestionsConfigResult |
describeQuerySuggestionsConfig(DescribeQuerySuggestionsConfigRequest describeQuerySuggestionsConfigRequest)
Describes the settings of query suggestions for an index.
|
DescribeThesaurusResult |
describeThesaurus(DescribeThesaurusRequest describeThesaurusRequest)
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.
|
GetQuerySuggestionsResult |
getQuerySuggestions(GetQuerySuggestionsRequest getQuerySuggestionsRequest)
Fetches the queries that are suggested to your users.
|
ListDataSourcesResult |
listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists the data sources that you have created.
|
ListDataSourceSyncJobsResult |
listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Gets statistics about synchronizing Amazon Kendra with a data source.
|
ListFaqsResult |
listFaqs(ListFaqsRequest listFaqsRequest)
Gets a list of FAQ lists associated with an index.
|
ListIndicesResult |
listIndices(ListIndicesRequest listIndicesRequest)
Lists the Amazon Kendra indexes that you have created.
|
ListQuerySuggestionsBlockListsResult |
listQuerySuggestionsBlockLists(ListQuerySuggestionsBlockListsRequest listQuerySuggestionsBlockListsRequest)
Lists the block lists used for query suggestions for an index.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets a list of tags associated with a specified resource.
|
ListThesauriResult |
listThesauri(ListThesauriRequest listThesauriRequest)
Lists the Amazon Kendra thesauri associated with an index.
|
QueryResult |
query(QueryRequest queryRequest)
Searches an active index.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartDataSourceSyncJobResult |
startDataSourceSyncJob(StartDataSourceSyncJobRequest startDataSourceSyncJobRequest)
Starts a synchronization job for a data source.
|
StopDataSourceSyncJobResult |
stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)
Stops a running synchronization job.
|
SubmitFeedbackResult |
submitFeedback(SubmitFeedbackRequest submitFeedbackRequest)
Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tag to the specified index, FAQ, or data source resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an index, FAQ, or a data source.
|
UpdateDataSourceResult |
updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates an existing Amazon Kendra data source.
|
UpdateIndexResult |
updateIndex(UpdateIndexRequest updateIndexRequest)
Updates an existing Amazon Kendra index.
|
UpdateQuerySuggestionsBlockListResult |
updateQuerySuggestionsBlockList(UpdateQuerySuggestionsBlockListRequest updateQuerySuggestionsBlockListRequest)
Updates a block list used for query suggestions for an index.
|
UpdateQuerySuggestionsConfigResult |
updateQuerySuggestionsConfig(UpdateQuerySuggestionsConfigRequest updateQuerySuggestionsConfigRequest)
Updates the settings of query suggestions for an index.
|
UpdateThesaurusResult |
updateThesaurus(UpdateThesaurusRequest updateThesaurusRequest)
Updates a thesaurus file associated with an index.
|
static final String ENDPOINT_PREFIX
BatchDeleteDocumentResult 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 - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionBatchPutDocumentResult 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 - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionServiceQuotaExceededExceptionInternalServerExceptionClearQuerySuggestionsResult clearQuerySuggestions(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.
clearQuerySuggestionsRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionConflictExceptionAccessDeniedExceptionInternalServerExceptionCreateDataSourceResult 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 - ValidationExceptionConflictExceptionResourceNotFoundExceptionResourceAlreadyExistExceptionServiceQuotaExceededExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionCreateFaqResult createFaq(CreateFaqRequest createFaqRequest)
Creates an new set of frequently asked question (FAQ) questions and answers.
createFaqRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionServiceQuotaExceededExceptionAccessDeniedExceptionInternalServerExceptionCreateIndexResult 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 - ValidationExceptionResourceAlreadyExistExceptionServiceQuotaExceededExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionCreateQuerySuggestionsBlockListResult createQuerySuggestionsBlockList(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.
createQuerySuggestionsBlockListRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionServiceQuotaExceededExceptionConflictExceptionInternalServerExceptionCreateThesaurusResult createThesaurus(CreateThesaurusRequest createThesaurusRequest)
Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
createThesaurusRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionServiceQuotaExceededExceptionAccessDeniedExceptionInternalServerExceptionDeleteDataSourceResult 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 - AccessDeniedExceptionValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionInternalServerExceptionDeleteFaqResult deleteFaq(DeleteFaqRequest deleteFaqRequest)
Removes an FAQ from an index.
deleteFaqRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDeleteIndexResult 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 - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDeleteQuerySuggestionsBlockListResult deleteQuerySuggestionsBlockList(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.
deleteQuerySuggestionsBlockListRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionDeleteThesaurusResult deleteThesaurus(DeleteThesaurusRequest deleteThesaurusRequest)
Deletes an existing Amazon Kendra thesaurus.
deleteThesaurusRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDescribeDataSourceResult describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
Gets information about a Amazon Kendra data source.
describeDataSourceRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDescribeFaqResult describeFaq(DescribeFaqRequest describeFaqRequest)
Gets information about an FAQ list.
describeFaqRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDescribeIndexResult describeIndex(DescribeIndexRequest describeIndexRequest)
Describes an existing Amazon Kendra index
describeIndexRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDescribeQuerySuggestionsBlockListResult describeQuerySuggestionsBlockList(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.
describeQuerySuggestionsBlockListRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDescribeQuerySuggestionsConfigResult describeQuerySuggestionsConfig(DescribeQuerySuggestionsConfigRequest describeQuerySuggestionsConfigRequest)
Describes the settings of query suggestions for an index.
This is used to check the current settings applied to query suggestions.
describeQuerySuggestionsConfigRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionDescribeThesaurusResult describeThesaurus(DescribeThesaurusRequest describeThesaurusRequest)
Describes an existing Amazon Kendra thesaurus.
describeThesaurusRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionGetQuerySuggestionsResult getQuerySuggestions(GetQuerySuggestionsRequest getQuerySuggestionsRequest)
Fetches the queries that are suggested to your users.
getQuerySuggestionsRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionServiceQuotaExceededExceptionConflictExceptionInternalServerExceptionListDataSourceSyncJobsResult listDataSourceSyncJobs(ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest)
Gets statistics about synchronizing Amazon Kendra with a data source.
listDataSourceSyncJobsRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionListDataSourcesResult listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists the data sources that you have created.
listDataSourcesRequest - ValidationExceptionResourceNotFoundExceptionAccessDeniedExceptionThrottlingExceptionInternalServerExceptionListFaqsResult listFaqs(ListFaqsRequest listFaqsRequest)
Gets a list of FAQ lists associated with an index.
listFaqsRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionListIndicesResult listIndices(ListIndicesRequest listIndicesRequest)
Lists the Amazon Kendra indexes that you have created.
listIndicesRequest - ValidationExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionListQuerySuggestionsBlockListsResult listQuerySuggestionsBlockLists(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.
listQuerySuggestionsBlockListsRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionListTagsForResourceResult 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 - ValidationExceptionResourceUnavailableExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionListThesauriResult listThesauri(ListThesauriRequest listThesauriRequest)
Lists the Amazon Kendra thesauri associated with an index.
listThesauriRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionQueryResult 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 - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionServiceQuotaExceededExceptionInternalServerExceptionStartDataSourceSyncJobResult 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 - ValidationExceptionResourceNotFoundExceptionResourceInUseExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionStopDataSourceSyncJobResult stopDataSourceSyncJob(StopDataSourceSyncJobRequest stopDataSourceSyncJobRequest)
Stops a running synchronization job. You can't stop a scheduled synchronization job.
stopDataSourceSyncJobRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionSubmitFeedbackResult submitFeedback(SubmitFeedbackRequest submitFeedbackRequest)
Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
submitFeedbackRequest - ValidationExceptionResourceUnavailableExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionTagResourceResult 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 - ValidationExceptionResourceUnavailableExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionUntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an index, FAQ, or a data source.
untagResourceRequest - ValidationExceptionResourceUnavailableExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionUpdateDataSourceResult updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates an existing Amazon Kendra data source.
updateDataSourceRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionUpdateIndexResult updateIndex(UpdateIndexRequest updateIndexRequest)
Updates an existing Amazon Kendra index.
updateIndexRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionServiceQuotaExceededExceptionInternalServerExceptionUpdateQuerySuggestionsBlockListResult updateQuerySuggestionsBlockList(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.
updateQuerySuggestionsBlockListRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionUpdateQuerySuggestionsConfigResult updateQuerySuggestionsConfig(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.
updateQuerySuggestionsConfigRequest - ValidationExceptionConflictExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionInternalServerExceptionUpdateThesaurusResult updateThesaurus(UpdateThesaurusRequest updateThesaurusRequest)
Updates a thesaurus file associated with an index.
updateThesaurusRequest - ValidationExceptionResourceNotFoundExceptionThrottlingExceptionAccessDeniedExceptionConflictExceptionInternalServerExceptionvoid shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 a request.
request - The originally executed request.Copyright © 2021. All rights reserved.