View Source AWS.Kendra (aws-elixir v0.11.0)
Amazon Kendra is a service for indexing large document sets.
Link to this section Summary
Functions
Grants users or groups in your Amazon Web Services SSO identity source access to your Amazon Kendra experience.
Defines the specific permissions of users or groups in your Amazon Web Services SSO identity source with access to your Amazon Kendra experience.
Removes one or more documents from an index.
Returns the indexing status for one or more documents submitted with the BatchPutDocument API.
Adds one or more documents to an index.
Clears existing query suggestions from an index.
Creates a data source that you want to use with an Amazon Kendra index.
Creates an Amazon Kendra experience such as a search application.
Creates an new set of frequently asked question (FAQ) questions and answers.
Creates a new Amazon Kendra index.
Creates a block list to exlcude certain queries from suggestions.
Creates a thesaurus for an index.
Deletes an Amazon Kendra data source.
Deletes your Amazon Kendra experience such as a search application.
Removes an FAQ from an index.
Deletes an existing Amazon Kendra index.
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.
Deletes a block list used for query suggestions for an index.
Deletes an existing Amazon Kendra thesaurus.
Gets information about an Amazon Kendra data source.
Gets information about your Amazon Kendra experience such as a search application.
Gets information about an FAQ list.
Describes an existing Amazon Kendra index.
Describes the processing of PUT
and DELETE
actions for mapping users to
their groups.
Describes a block list used for query suggestions for an index.
Describes the settings of query suggestions for an index.
Describes an existing Amazon Kendra thesaurus.
Prevents users or groups in your Amazon Web Services SSO identity source from accessing your Amazon Kendra experience.
Removes the specific permissions of users or groups in your Amazon Web Services SSO identity source with access to your Amazon Kendra experience.
Fetches the queries that are suggested to your users.
Retrieves search metrics data.
Gets statistics about synchronizing Amazon Kendra with a data source.
Lists the data sources that you have created.
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
Lists users or groups in your Amazon Web Services SSO identity source that are granted access to your Amazon Kendra experience.
Lists one or more Amazon Kendra experiences.
Gets a list of FAQ lists associated with an index.
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
Lists the Amazon Kendra indexes that you created.
Lists the block lists used for query suggestions for an index.
Gets a list of tags associated with a specified resource.
Lists the Amazon Kendra thesauri associated with an index.
Maps users to their groups so that you only need to provide the user ID when you issue the query.
Searches an active index.
Starts a synchronization job for a data source.
Stops a synchronization job that is currently running.
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
Adds the specified tag to the specified index, FAQ, or data source resource.
Removes a tag from an index, FAQ, or a data source.
Updates an existing Amazon Kendra data source.
Updates your Amazon Kendra experience such as a search application.
Updates an existing Amazon Kendra index.
Updates a block list used for query suggestions for an index.
Updates the settings of query suggestions for an index.
Updates a thesaurus file associated with an index.
Link to this section Functions
Grants users or groups in your Amazon Web Services SSO 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.
Defines the specific permissions of users or groups in your Amazon Web Services SSO 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.
Removes one or more documents from an index.
The documents must have been added with the BatchPutDocument
API.
The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services 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 API.
When you use the BatchPutDocument
API, documents are indexed asynchronously.
You can use the BatchGetDocumentStatus
API 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
API to check the status of the
BatchDeleteDocument
API. 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
API enables you to ingest inline documents or a set of
documents stored in an Amazon S3 bucket. Use this API 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 Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services 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.
ClearQuerySuggestions
is currently not supported in the Amazon Web Services
GovCloud (US-West) region.
Creates a data source that you want to use with an Amazon Kendra index.
You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.
CreateDataSource
is a synchronous operation. The operation returns 200 if the
data source was successfully created. Otherwise, an exception is raised.
Amazon S3 and custom data sources are the only supported data sources in the Amazon Web Services GovCloud (US-West) region.
Creates 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.
Creates an new set of frequently asked question (FAQ) questions and answers.
Adding FAQs to an index is an asynchronous operation.
Creates a new 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.
Once the index is active you can index your documents using the
BatchPutDocument
API 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.
CreateQuerySuggestionsBlockList
is currently not supported in the Amazon Web
Services GovCloud (US-West) region.
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
API is set to DELETING
. For more information, see
Deleting Data Sources.
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.
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
API is set to DELETING
.
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.
For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results.
If you want to delete or replace users or sub groups of a group, you need to use
the PutPrincipalMapping
operation. For example, if a user in the group
"Engineering" leaves the engineering team and another user takes their place,
you provide an updated list of users or sub groups that belong to the
"Engineering" group when calling PutPrincipalMapping
. You can update your
internal list of users or sub groups and input this list when calling
PutPrincipalMapping
.
DeletePrincipalMapping
is currently not supported in the Amazon Web Services
GovCloud (US-West) region.
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.
DeleteQuerySuggestionsBlockList
is currently not supported in the Amazon Web
Services GovCloud (US-West) region.
Deletes an existing Amazon Kendra thesaurus.
Gets information about an Amazon Kendra data source.
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.
Gets information about an FAQ list.
Describes an existing Amazon Kendra index.
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.
DescribePrincipalMapping
is currently not supported in the Amazon Web Services
GovCloud (US-West) region.
describe_query_suggestions_block_list(client, input, options \\ [])
View SourceDescribes 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.
DescribeQuerySuggestionsBlockList
is currently not supported in the Amazon Web
Services GovCloud (US-West) region.
Describes the settings of query suggestions for an index.
This is used to check the current settings applied to query suggestions.
DescribeQuerySuggestionsConfig
is currently not supported in the Amazon Web
Services GovCloud (US-West) region.
Describes an existing Amazon Kendra thesaurus.
disassociate_entities_from_experience(client, input, options \\ [])
View SourcePrevents users or groups in your Amazon Web Services SSO 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.
Removes the specific permissions of users or groups in your Amazon Web Services SSO 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.
Fetches the queries that are suggested to your users.
GetQuerySuggestions
is currently not supported in the Amazon Web Services
GovCloud (US-West) region.
Retrieves search metrics data.
The data provides a snapshot of how your users interact with your search application and how effective the application is.
Gets statistics about synchronizing Amazon Kendra with a data source.
Lists the data sources that you have created.
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
Lists users or groups in your Amazon Web Services SSO 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.
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.
Gets a list of FAQ lists associated with an index.
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
ListGroupsOlderThanOrderingId
is currently not supported in the Amazon Web
Services GovCloud (US-West) region.
Lists the Amazon Kendra indexes that you 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.
ListQuerySuggestionsBlockLists
is currently not supported in the Amazon Web
Services GovCloud (US-West) region.
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.
Maps users to their groups so that you only need to provide the user ID when you issue the query.
You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results.
You map users to their groups when you want to filter search results for different users based on their group’s access to documents. For more information on filtering search results for different users, see Filtering on user context.
If more than five PUT
actions for a group are currently processing, a
validation exception is thrown.
PutPrincipalMapping
is currently not supported in the Amazon Web Services
GovCloud (US-West) region.
Searches an active index.
Use this API to search your documents using query. The Query
API 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 synchronization job that is currently running.
You can't stop a scheduled synchronization job.
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
SubmitFeedback
is currently not supported in the Amazon Web Services GovCloud
(US-West) region.
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 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.
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.
UpdateQuerySuggestionsBlockList
is currently not supported in the Amazon Web
Services GovCloud (US-West) region.
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.
UpdateQuerySuggestionsConfig
is currently not supported in the Amazon Web
Services GovCloud (US-West) region.
Updates a thesaurus file associated with an index.