logo
pub trait Kendra {
Show 39 methods fn batch_delete_document<'life0, 'async_trait>(
        &'life0 self,
        input: BatchDeleteDocumentRequest
    ) -> Pin<Box<dyn Future<Output = Result<BatchDeleteDocumentResponse, RusotoError<BatchDeleteDocumentError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn batch_get_document_status<'life0, 'async_trait>(
        &'life0 self,
        input: BatchGetDocumentStatusRequest
    ) -> Pin<Box<dyn Future<Output = Result<BatchGetDocumentStatusResponse, RusotoError<BatchGetDocumentStatusError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn batch_put_document<'life0, 'async_trait>(
        &'life0 self,
        input: BatchPutDocumentRequest
    ) -> Pin<Box<dyn Future<Output = Result<BatchPutDocumentResponse, RusotoError<BatchPutDocumentError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn clear_query_suggestions<'life0, 'async_trait>(
        &'life0 self,
        input: ClearQuerySuggestionsRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<ClearQuerySuggestionsError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn create_data_source<'life0, 'async_trait>(
        &'life0 self,
        input: CreateDataSourceRequest
    ) -> Pin<Box<dyn Future<Output = Result<CreateDataSourceResponse, RusotoError<CreateDataSourceError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn create_faq<'life0, 'async_trait>(
        &'life0 self,
        input: CreateFaqRequest
    ) -> Pin<Box<dyn Future<Output = Result<CreateFaqResponse, RusotoError<CreateFaqError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn create_index<'life0, 'async_trait>(
        &'life0 self,
        input: CreateIndexRequest
    ) -> Pin<Box<dyn Future<Output = Result<CreateIndexResponse, RusotoError<CreateIndexError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn create_query_suggestions_block_list<'life0, 'async_trait>(
        &'life0 self,
        input: CreateQuerySuggestionsBlockListRequest
    ) -> Pin<Box<dyn Future<Output = Result<CreateQuerySuggestionsBlockListResponse, RusotoError<CreateQuerySuggestionsBlockListError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn create_thesaurus<'life0, 'async_trait>(
        &'life0 self,
        input: CreateThesaurusRequest
    ) -> Pin<Box<dyn Future<Output = Result<CreateThesaurusResponse, RusotoError<CreateThesaurusError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn delete_data_source<'life0, 'async_trait>(
        &'life0 self,
        input: DeleteDataSourceRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteDataSourceError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn delete_faq<'life0, 'async_trait>(
        &'life0 self,
        input: DeleteFaqRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteFaqError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn delete_index<'life0, 'async_trait>(
        &'life0 self,
        input: DeleteIndexRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteIndexError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn delete_query_suggestions_block_list<'life0, 'async_trait>(
        &'life0 self,
        input: DeleteQuerySuggestionsBlockListRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteQuerySuggestionsBlockListError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn delete_thesaurus<'life0, 'async_trait>(
        &'life0 self,
        input: DeleteThesaurusRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeleteThesaurusError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn describe_data_source<'life0, 'async_trait>(
        &'life0 self,
        input: DescribeDataSourceRequest
    ) -> Pin<Box<dyn Future<Output = Result<DescribeDataSourceResponse, RusotoError<DescribeDataSourceError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn describe_faq<'life0, 'async_trait>(
        &'life0 self,
        input: DescribeFaqRequest
    ) -> Pin<Box<dyn Future<Output = Result<DescribeFaqResponse, RusotoError<DescribeFaqError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn describe_index<'life0, 'async_trait>(
        &'life0 self,
        input: DescribeIndexRequest
    ) -> Pin<Box<dyn Future<Output = Result<DescribeIndexResponse, RusotoError<DescribeIndexError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn describe_query_suggestions_block_list<'life0, 'async_trait>(
        &'life0 self,
        input: DescribeQuerySuggestionsBlockListRequest
    ) -> Pin<Box<dyn Future<Output = Result<DescribeQuerySuggestionsBlockListResponse, RusotoError<DescribeQuerySuggestionsBlockListError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn describe_query_suggestions_config<'life0, 'async_trait>(
        &'life0 self,
        input: DescribeQuerySuggestionsConfigRequest
    ) -> Pin<Box<dyn Future<Output = Result<DescribeQuerySuggestionsConfigResponse, RusotoError<DescribeQuerySuggestionsConfigError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn describe_thesaurus<'life0, 'async_trait>(
        &'life0 self,
        input: DescribeThesaurusRequest
    ) -> Pin<Box<dyn Future<Output = Result<DescribeThesaurusResponse, RusotoError<DescribeThesaurusError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn get_query_suggestions<'life0, 'async_trait>(
        &'life0 self,
        input: GetQuerySuggestionsRequest
    ) -> Pin<Box<dyn Future<Output = Result<GetQuerySuggestionsResponse, RusotoError<GetQuerySuggestionsError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn list_data_source_sync_jobs<'life0, 'async_trait>(
        &'life0 self,
        input: ListDataSourceSyncJobsRequest
    ) -> Pin<Box<dyn Future<Output = Result<ListDataSourceSyncJobsResponse, RusotoError<ListDataSourceSyncJobsError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn list_data_sources<'life0, 'async_trait>(
        &'life0 self,
        input: ListDataSourcesRequest
    ) -> Pin<Box<dyn Future<Output = Result<ListDataSourcesResponse, RusotoError<ListDataSourcesError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn list_faqs<'life0, 'async_trait>(
        &'life0 self,
        input: ListFaqsRequest
    ) -> Pin<Box<dyn Future<Output = Result<ListFaqsResponse, RusotoError<ListFaqsError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn list_indices<'life0, 'async_trait>(
        &'life0 self,
        input: ListIndicesRequest
    ) -> Pin<Box<dyn Future<Output = Result<ListIndicesResponse, RusotoError<ListIndicesError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn list_query_suggestions_block_lists<'life0, 'async_trait>(
        &'life0 self,
        input: ListQuerySuggestionsBlockListsRequest
    ) -> Pin<Box<dyn Future<Output = Result<ListQuerySuggestionsBlockListsResponse, RusotoError<ListQuerySuggestionsBlockListsError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn list_tags_for_resource<'life0, 'async_trait>(
        &'life0 self,
        input: ListTagsForResourceRequest
    ) -> Pin<Box<dyn Future<Output = Result<ListTagsForResourceResponse, RusotoError<ListTagsForResourceError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn list_thesauri<'life0, 'async_trait>(
        &'life0 self,
        input: ListThesauriRequest
    ) -> Pin<Box<dyn Future<Output = Result<ListThesauriResponse, RusotoError<ListThesauriError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn query<'life0, 'async_trait>(
        &'life0 self,
        input: QueryRequest
    ) -> Pin<Box<dyn Future<Output = Result<QueryResult, RusotoError<QueryError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn start_data_source_sync_job<'life0, 'async_trait>(
        &'life0 self,
        input: StartDataSourceSyncJobRequest
    ) -> Pin<Box<dyn Future<Output = Result<StartDataSourceSyncJobResponse, RusotoError<StartDataSourceSyncJobError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn stop_data_source_sync_job<'life0, 'async_trait>(
        &'life0 self,
        input: StopDataSourceSyncJobRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<StopDataSourceSyncJobError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn submit_feedback<'life0, 'async_trait>(
        &'life0 self,
        input: SubmitFeedbackRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<SubmitFeedbackError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn tag_resource<'life0, 'async_trait>(
        &'life0 self,
        input: TagResourceRequest
    ) -> Pin<Box<dyn Future<Output = Result<TagResourceResponse, RusotoError<TagResourceError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn untag_resource<'life0, 'async_trait>(
        &'life0 self,
        input: UntagResourceRequest
    ) -> Pin<Box<dyn Future<Output = Result<UntagResourceResponse, RusotoError<UntagResourceError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn update_data_source<'life0, 'async_trait>(
        &'life0 self,
        input: UpdateDataSourceRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UpdateDataSourceError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn update_index<'life0, 'async_trait>(
        &'life0 self,
        input: UpdateIndexRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UpdateIndexError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn update_query_suggestions_block_list<'life0, 'async_trait>(
        &'life0 self,
        input: UpdateQuerySuggestionsBlockListRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UpdateQuerySuggestionsBlockListError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn update_query_suggestions_config<'life0, 'async_trait>(
        &'life0 self,
        input: UpdateQuerySuggestionsConfigRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UpdateQuerySuggestionsConfigError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
; fn update_thesaurus<'life0, 'async_trait>(
        &'life0 self,
        input: UpdateThesaurusRequest
    ) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<UpdateThesaurusError>>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait
;
}
Expand description

Trait representing the capabilities of the kendra API. kendra clients implement this trait.

Required Methods

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.

Returns the indexing status for one or more documents submitted with the BatchPutDocument operation.

When you use the BatchPutDocument operation, documents are indexed asynchronously. You can use the BatchGetDocumentStatus operation to get the current status of a list of documents so that you can determine if they have been successfully indexed.

You can also use the BatchGetDocumentStatus operation to check the status of the BatchDeleteDocument operation. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.

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.

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.

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.

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

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.

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.

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

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.

Removes an FAQ from an index.

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.

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.

Deletes an existing Amazon Kendra thesaurus.

Gets information about a Amazon Kendra data source.

Gets information about an FAQ list.

Describes an existing Amazon Kendra index

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.

Describes the settings of query suggestions for an index.

This is used to check the current settings applied to query suggestions.

Describes an existing Amazon Kendra thesaurus.

Fetches the queries that are suggested to your users.

Gets statistics about synchronizing Amazon Kendra with a data source.

Lists the data sources that you have created.

Gets a list of FAQ lists associated with an index.

Lists the Amazon Kendra indexes that you have created.

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.

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

Lists the Amazon Kendra thesauri associated with an index.

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.

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

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

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

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.

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

Updates an existing Amazon Kendra data source.

Updates an existing Amazon Kendra index.

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.

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.

Updates a thesaurus file associated with an index.

Implementors