Amazon Web Services, Inc.

AWSKendraFrontendService

Amazon Kendra is a service for indexing large document sets.

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon Kendra is a service for indexing large document sets.

Endpoints 66

  • POSTAssociate entities to experience/#X-Amz-Target=AWSKendraFrontendService.AssociateEntitiesToExperienceGrants 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…
  • POSTAssociate personas to entities/#X-Amz-Target=AWSKendraFrontendService.AssociatePersonasToEntitiesDefines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create…
  • POSTBatch delete document/#X-Amz-Target=AWSKendraFrontendService.BatchDeleteDocumentRemoves one or more documents from an index. The documents must have been added with the BatchPutDocument API. The documents are deleted asynchronously. You…
  • POSTBatch delete featured results set/#X-Amz-Target=AWSKendraFrontendService.BatchDeleteFeaturedResultsSetRemoves 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,…
  • POSTBatch get document status/#X-Amz-Target=AWSKendraFrontendService.BatchGetDocumentStatusReturns the indexing status for one or more documents submitted with the BatchPutDocument API. When you use the BatchPutDocument API, documents are indexed…
  • POSTBatch put document/#X-Amz-Target=AWSKendraFrontendService.BatchPutDocumentAdds 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.…
  • POSTClear query suggestions/#X-Amz-Target=AWSKendraFrontendService.ClearQuerySuggestionsClears existing query suggestions from an index. This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon…
  • POSTCreate access control configuration/#X-Amz-Target=AWSKendraFrontendService.CreateAccessControlConfigurationCreates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context…
  • POSTCreate data source/#X-Amz-Target=AWSKendraFrontendService.CreateDataSourceCreates a data source connector that you want to use with an Amazon Kendra index. You specify a name, data source connector type and description for your data…
  • POSTCreate experience/#X-Amz-Target=AWSKendraFrontendService.CreateExperienceCreates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python…
  • POSTCreate faq/#X-Amz-Target=AWSKendraFrontendService.CreateFaqCreates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket. Adding FAQs to an index is an asynchronous…
  • POSTCreate featured results set/#X-Amz-Target=AWSKendraFrontendService.CreateFeaturedResultsSetCreates 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.…
  • POSTCreate index/#X-Amz-Target=AWSKendraFrontendService.CreateIndexCreates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a…
  • POSTCreate query suggestions block list/#X-Amz-Target=AWSKendraFrontendService.CreateQuerySuggestionsBlockListCreates 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…
  • POSTCreate thesaurus/#X-Amz-Target=AWSKendraFrontendService.CreateThesaurusCreates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format. For an example of adding a thesaurus file to an index, see Adding…
  • POSTDelete access control configuration/#X-Amz-Target=AWSKendraFrontendService.DeleteAccessControlConfigurationDeletes an access control configuration that you created for your documents in an index. This includes user and group access information for your documents.…
  • POSTDelete data source/#X-Amz-Target=AWSKendraFrontendService.DeleteDataSourceDeletes 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…
  • POSTDelete experience/#X-Amz-Target=AWSKendraFrontendService.DeleteExperienceDeletes your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search…
  • POSTDelete faq/#X-Amz-Target=AWSKendraFrontendService.DeleteFaqRemoves a FAQ from an index.
  • POSTDelete index/#X-Amz-Target=AWSKendraFrontendService.DeleteIndexDeletes 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…
  • POSTDelete principal mapping/#X-Amz-Target=AWSKendraFrontendService.DeletePrincipalMappingDeletes a group so that all users that belong to the group can no longer access documents only available to that group. For example, after deleting the group…
  • POSTDelete query suggestions block list/#X-Amz-Target=AWSKendraFrontendService.DeleteQuerySuggestionsBlockListDeletes 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…
  • POSTDelete thesaurus/#X-Amz-Target=AWSKendraFrontendService.DeleteThesaurusDeletes an Amazon Kendra thesaurus.
  • POSTDescribe access control configuration/#X-Amz-Target=AWSKendraFrontendService.DescribeAccessControlConfigurationGets information about an access control configuration that you created for your documents in an index. This includes user and group access information for…
  • POSTDescribe data source/#X-Amz-Target=AWSKendraFrontendService.DescribeDataSourceGets information about an Amazon Kendra data source connector.
  • POSTDescribe experience/#X-Amz-Target=AWSKendraFrontendService.DescribeExperienceGets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see…
  • POSTDescribe faq/#X-Amz-Target=AWSKendraFrontendService.DescribeFaqGets information about a FAQ.
  • POSTDescribe featured results set/#X-Amz-Target=AWSKendraFrontendService.DescribeFeaturedResultsSetGets 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…
  • POSTDescribe index/#X-Amz-Target=AWSKendraFrontendService.DescribeIndexGets information about an Amazon Kendra index.
  • POSTDescribe principal mapping/#X-Amz-Target=AWSKendraFrontendService.DescribePrincipalMappingDescribes the processing of PUT and DELETE actions for mapping users to their groups. This includes information on the status of actions currently processing…
  • POSTDescribe query suggestions block list/#X-Amz-Target=AWSKendraFrontendService.DescribeQuerySuggestionsBlockListGets information about 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.…
  • POSTDescribe query suggestions config/#X-Amz-Target=AWSKendraFrontendService.DescribeQuerySuggestionsConfigGets information on the settings of query suggestions for an index. This is used to check the current settings applied to query suggestions.…
  • POSTDescribe thesaurus/#X-Amz-Target=AWSKendraFrontendService.DescribeThesaurusGets information about an Amazon Kendra thesaurus.
  • POSTDisassociate entities from experience/#X-Amz-Target=AWSKendraFrontendService.DisassociateEntitiesFromExperiencePrevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience…
  • POSTDisassociate personas from entities/#X-Amz-Target=AWSKendraFrontendService.DisassociatePersonasFromEntitiesRemoves the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create…
  • POSTGet query suggestions/#X-Amz-Target=AWSKendraFrontendService.GetQuerySuggestionsFetches the queries that are suggested to your users. GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.
  • POSTGet snapshots/#X-Amz-Target=AWSKendraFrontendService.GetSnapshotsRetrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.
  • POSTList access control configurations/#X-Amz-Target=AWSKendraFrontendService.ListAccessControlConfigurationsLists one or more access control configurations for an index. This includes user and group access information for your documents. This is useful for user…
  • POSTList data source sync jobs/#X-Amz-Target=AWSKendraFrontendService.ListDataSourceSyncJobsGets statistics about synchronizing a data source connector.
  • POSTList data sources/#X-Amz-Target=AWSKendraFrontendService.ListDataSourcesLists the data source connectors that you have created.
  • POSTList entity personas/#X-Amz-Target=AWSKendraFrontendService.ListEntityPersonasLists specific permissions of users and groups with access to your Amazon Kendra experience.
  • POSTList experience entities/#X-Amz-Target=AWSKendraFrontendService.ListExperienceEntitiesLists 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…
  • POSTList experiences/#X-Amz-Target=AWSKendraFrontendService.ListExperiencesLists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a…
  • POSTList faqs/#X-Amz-Target=AWSKendraFrontendService.ListFaqsGets a list of FAQs associated with an index.
  • POSTList featured results sets/#X-Amz-Target=AWSKendraFrontendService.ListFeaturedResultsSetsLists 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…
  • POSTList groups older than ordering id/#X-Amz-Target=AWSKendraFrontendService.ListGroupsOlderThanOrderingIdProvides a list of groups that are mapped to users before a given ordering or timestamp identifier. ListGroupsOlderThanOrderingId is currently not supported…
  • POSTList indices/#X-Amz-Target=AWSKendraFrontendService.ListIndicesLists the Amazon Kendra indexes that you created.
  • POSTList query suggestions block lists/#X-Amz-Target=AWSKendraFrontendService.ListQuerySuggestionsBlockListsLists 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 .…
  • POSTList tags for resource/#X-Amz-Target=AWSKendraFrontendService.ListTagsForResourceGets a list of tags associated with a resource. Indexes, FAQs, data sources, and other resources can have tags associated with them.
  • POSTList thesauri/#X-Amz-Target=AWSKendraFrontendService.ListThesauriLists the thesauri for an index.
  • POSTPut principal mapping/#X-Amz-Target=AWSKendraFrontendService.PutPrincipalMappingMaps 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…
  • POSTQuery/#X-Amz-Target=AWSKendraFrontendService.QuerySearches an index given an input query. If you are working with large language models (LLMs) or implementing retrieval augmented generation (RAG) systems, you…
  • POSTRetrieve/#X-Amz-Target=AWSKendraFrontendService.RetrieveRetrieves relevant passages or text excerpts given an input query. This API is similar to the Query API. However, by default, the Query API only returns…
  • POSTStart data source sync job/#X-Amz-Target=AWSKendraFrontendService.StartDataSourceSyncJobStarts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException…
  • POSTStop data source sync job/#X-Amz-Target=AWSKendraFrontendService.StopDataSourceSyncJobStops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
  • POSTSubmit feedback/#X-Amz-Target=AWSKendraFrontendService.SubmitFeedbackEnables you to provide feedback to Amazon Kendra to improve the performance of your index. SubmitFeedback is currently not supported in the Amazon Web…
  • POSTTag resource/#X-Amz-Target=AWSKendraFrontendService.TagResourceAdds 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…
  • POSTUntag resource/#X-Amz-Target=AWSKendraFrontendService.UntagResourceRemoves a tag from an index, FAQ, data source, or other resource.
  • POSTUpdate access control configuration/#X-Amz-Target=AWSKendraFrontendService.UpdateAccessControlConfigurationUpdates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for…
  • POSTUpdate data source/#X-Amz-Target=AWSKendraFrontendService.UpdateDataSourceUpdates an Amazon Kendra data source connector.
  • POSTUpdate experience/#X-Amz-Target=AWSKendraFrontendService.UpdateExperienceUpdates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search…
  • POSTUpdate featured results set/#X-Amz-Target=AWSKendraFrontendService.UpdateFeaturedResultsSetUpdates a set of featured results. Features results are placed above all other results for certain queries. You map specific queries to specific documents for…
  • POSTUpdate index/#X-Amz-Target=AWSKendraFrontendService.UpdateIndexUpdates an Amazon Kendra index.
  • POSTUpdate query suggestions block list/#X-Amz-Target=AWSKendraFrontendService.UpdateQuerySuggestionsBlockListUpdates 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…
  • POSTUpdate query suggestions config/#X-Amz-Target=AWSKendraFrontendService.UpdateQuerySuggestionsConfigUpdates 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…
  • POSTUpdate thesaurus/#X-Amz-Target=AWSKendraFrontendService.UpdateThesaurusUpdates a thesaurus for an index.

API details

Base URL
https://kendra.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
66 operations on 66 pathsPOST 66
Description format
AWS Smithy model, API version 2019-02-03

How to test the AWSKendraFrontendService in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWSKendraFrontendService collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate entities to experience” (POST /#X-Amz-Target=AWSKendraFrontendService.AssociateEntitiesToExperience), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWSKendraFrontendService?

Amazon Kendra is a service for indexing large document sets. It is listed under Developer tools and has 66 endpoints.

Who publishes the AWSKendraFrontendService?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWSKendraFrontendService?

Requests go to https://kendra.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWSKendraFrontendService?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWSKendraFrontendService have?

66 operations on 66 paths (66 POST).

Is forking the AWSKendraFrontendService free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.