Package-level declarations

Types

Link copied to clipboard

Amazon Kendra is a service for indexing large document sets.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Inherited functions

Link copied to clipboard

Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Link copied to clipboard

Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Link copied to clipboard

Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API.

Link copied to clipboard

Removes one or more sets of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.

Link copied to clipboard

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

Link copied to clipboard

Adds one or more documents to an index.

Link copied to clipboard

Clears existing query suggestions from an index.

Link copied to clipboard

Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Link copied to clipboard

Creates a data source connector that you want to use with an Amazon Kendra index.

Link copied to clipboard

Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see Building a search experience with no code.

Link copied to clipboard
inline suspend fun KendraClient.createFaq(crossinline block: CreateFaqRequest.Builder.() -> Unit): CreateFaqResponse

Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.

Link copied to clipboard

Creates a set of featured results to display at the top of the search results page. Featured results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the search results.

Link copied to clipboard
inline suspend fun KendraClient.createIndex(crossinline block: CreateIndexRequest.Builder.() -> Unit): CreateIndexResponse

Creates an Amazon Kendra index. Index creation is an asynchronous API. 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.

Link copied to clipboard

Creates a block list to exlcude certain queries from suggestions.

Link copied to clipboard

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

Link copied to clipboard

Deletes an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Link copied to clipboard

Deletes an Amazon Kendra data source connector. 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 API is set to DELETING. For more information, see Deleting Data Sources.

Link copied to clipboard

Deletes your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Link copied to clipboard
inline suspend fun KendraClient.deleteFaq(crossinline block: DeleteFaqRequest.Builder.() -> Unit): DeleteFaqResponse

Removes a FAQ from an index.

Link copied to clipboard
inline suspend fun KendraClient.deleteIndex(crossinline block: DeleteIndexRequest.Builder.() -> Unit): DeleteIndexResponse

Deletes an 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 API is set to DELETING.

Link copied to clipboard

Deletes a group so that all users that belong to the group can no longer access documents only available to that group.

Link copied to clipboard

Deletes a block list used for query suggestions for an index.

Link copied to clipboard

Deletes an Amazon Kendra thesaurus.

Link copied to clipboard

Gets information about an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Link copied to clipboard

Gets information about an Amazon Kendra data source connector.

Link copied to clipboard

Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Link copied to clipboard
inline suspend fun KendraClient.describeFaq(crossinline block: DescribeFaqRequest.Builder.() -> Unit): DescribeFaqResponse

Gets information about a FAQ.

Link copied to clipboard

Gets information about a set of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.

Link copied to clipboard

Gets information about an Amazon Kendra index.

Link copied to clipboard

Describes the processing of PUT and DELETE actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed.

Link copied to clipboard

Gets information about a block list used for query suggestions for an index.

Link copied to clipboard

Gets information on the settings of query suggestions for an index.

Link copied to clipboard

Gets information about an Amazon Kendra thesaurus.

Link copied to clipboard

Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Link copied to clipboard

Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Link copied to clipboard

Fetches the queries that are suggested to your users.

Link copied to clipboard
inline suspend fun KendraClient.getSnapshots(crossinline block: GetSnapshotsRequest.Builder.() -> Unit): GetSnapshotsResponse

Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.

Link copied to clipboard

Lists one or more access control configurations for an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Link copied to clipboard

Lists the data source connectors that you have created.

Link copied to clipboard

Gets statistics about synchronizing a data source connector.

Link copied to clipboard

Lists specific permissions of users and groups with access to your Amazon Kendra experience.

Link copied to clipboard

Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Link copied to clipboard

Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Link copied to clipboard
inline suspend fun KendraClient.listFaqs(crossinline block: ListFaqsRequest.Builder.() -> Unit): ListFaqsResponse

Gets a list of FAQs associated with an index.

Link copied to clipboard

Lists all your sets of featured results for a given index. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.

Link copied to clipboard

Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.

Link copied to clipboard
inline suspend fun KendraClient.listIndices(crossinline block: ListIndicesRequest.Builder.() -> Unit): ListIndicesResponse

Lists the Amazon Kendra indexes that you created.

Link copied to clipboard

Lists the block lists used for query suggestions for an index.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun KendraClient.listThesauri(crossinline block: ListThesauriRequest.Builder.() -> Unit): ListThesauriResponse

Lists the thesauri for an index.

Link copied to clipboard

Maps users to their groups so that you only need to provide the user ID when you issue the query.

Link copied to clipboard
inline suspend fun KendraClient.query(crossinline block: QueryRequest.Builder.() -> Unit): QueryResponse

Searches an index given an input query.

Link copied to clipboard
inline suspend fun KendraClient.retrieve(crossinline block: RetrieveRequest.Builder.() -> Unit): RetrieveResponse

Retrieves relevant passages or text excerpts given an input query.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun KendraClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds the specified tag to the specified index, FAQ, data source, or other resource. If the tag already exists, the existing value is replaced with the new value.

Link copied to clipboard

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

Link copied to clipboard

Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Link copied to clipboard

Updates an Amazon Kendra data source connector.

Link copied to clipboard

Updates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Link copied to clipboard

Updates a set of featured results. Features results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match of a query, then one or more specific documents are featured in the search results.

Link copied to clipboard
inline suspend fun KendraClient.updateIndex(crossinline block: UpdateIndexRequest.Builder.() -> Unit): UpdateIndexResponse

Updates an Amazon Kendra index.

Link copied to clipboard

Updates a block list used for query suggestions for an index.

Link copied to clipboard

Updates the settings of query suggestions for an index.

Link copied to clipboard

Updates a thesaurus for an index.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.