Open documentation ↗Overview
Amazon Kendra is a service for indexing large document sets.
AWSKendraFrontendService is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 65 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2019-02-03
- Endpoints
- 65
- OpenAPI
- Specification ↗
- Spec updated
- 2020-05-11
Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /#X-Amz-Target=AWSKendraFrontendService.AssociateEntitiesToExperience | 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 |
| POST | /#X-Amz-Target=AWSKendraFrontendService.AssociatePersonasToEntities | 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 |
| POST | /#X-Amz-Target=AWSKendraFrontendService.BatchDeleteDocument | <p>Removes one or more documents from an index. The documents must have been added with the <code>BatchPutDocument</code> API.</p> <p>The documents are deleted |
| POST | /#X-Amz-Target=AWSKendraFrontendService.BatchDeleteFeaturedResultsSet | 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, the |
| POST | /#X-Amz-Target=AWSKendraFrontendService.BatchGetDocumentStatus | <p>Returns the indexing status for one or more documents submitted with the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html"> Ba |
| POST | /#X-Amz-Target=AWSKendraFrontendService.BatchPutDocument | <p>Adds one or more documents to an index.</p> <p>The <code>BatchPutDocument</code> API enables you to ingest inline documents or a set of documents stored in a |
| POST | /#X-Amz-Target=AWSKendraFrontendService.ClearQuerySuggestions | <p>Clears existing query suggestions from an index.</p> <p>This deletes existing suggestions only, not the queries in the query log. After you clear suggestions |
| POST | /#X-Amz-Target=AWSKendraFrontendService.CreateAccessControlConfiguration | <p>Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filte |
| POST | /#X-Amz-Target=AWSKendraFrontendService.CreateDataSource | <p>Creates a data source connector that you want to use with an Amazon Kendra index.</p> <p>You specify a name, data source connector type and description for y |
| POST | /#X-Amz-Target=AWSKendraFrontendService.CreateExperience | Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python a |
| POST | /#X-Amz-Target=AWSKendraFrontendService.CreateFaq | <p>Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.</p> <p>Adding FAQs to an index is an asynchronous |
| POST | /#X-Amz-Target=AWSKendraFrontendService.CreateFeaturedResultsSet | <p>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. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.CreateIndex | <p>Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the <code>Status</code> field retu |
| POST | /#X-Amz-Target=AWSKendraFrontendService.CreateQuerySuggestionsBlockList | <p>Creates a block list to exlcude certain queries from suggestions.</p> <p>Any query that contains words or phrases specified in the block list is blocked or f |
| POST | /#X-Amz-Target=AWSKendraFrontendService.CreateThesaurus | <p>Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.</p> <p>For an example of adding a thesaurus file to an index, see |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DeleteAccessControlConfiguration | Deletes an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. Thi |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DeleteDataSource | 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, |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DeleteExperience | Deletes your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see <a href="https://docs. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DeleteFaq | Removes an FAQ from an index. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DeleteIndex | 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 <code>Status</c |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DeletePrincipalMapping | <p>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.</p> <p>For example, af |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DeleteQuerySuggestionsBlockList | <p>Deletes a block list used for query suggestions for an index.</p> <p>A deleted block list might not take effect right away. Amazon Kendra needs to refresh th |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DeleteThesaurus | Deletes an existing Amazon Kendra thesaurus. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DescribeAccessControlConfiguration | 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 |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DescribeDataSource | Gets information about an Amazon Kendra data source connector. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DescribeExperience | Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see <a href |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DescribeFaq | Gets information about an FAQ list. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DescribeFeaturedResultsSet | 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, |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DescribeIndex | Gets information about an existing Amazon Kendra index. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DescribePrincipalMapping | <p>Describes the processing of <code>PUT</code> and <code>DELETE</code> actions for mapping users to their groups. This includes information on the status of ac |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DescribeQuerySuggestionsBlockList | <p>Gets information about a block list used for query suggestions for an index.</p> <p>This is used to check the current settings that are applied to a block li |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DescribeQuerySuggestionsConfig | <p>Gets information on the settings of query suggestions for an index.</p> <p>This is used to check the current settings applied to query suggestions.</p> <p> < |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DescribeThesaurus | Gets information about an existing Amazon Kendra thesaurus. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DisassociateEntitiesFromExperience | Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience su |
| POST | /#X-Amz-Target=AWSKendraFrontendService.DisassociatePersonasFromEntities | 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 |
| POST | /#X-Amz-Target=AWSKendraFrontendService.GetQuerySuggestions | <p>Fetches the queries that are suggested to your users.</p> <p> <code>GetQuerySuggestions</code> is currently not supported in the Amazon Web Services GovCloud |
| POST | /#X-Amz-Target=AWSKendraFrontendService.GetSnapshots | Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.ListAccessControlConfigurations | 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 contex |
| POST | /#X-Amz-Target=AWSKendraFrontendService.ListDataSourceSyncJobs | Gets statistics about synchronizing a data source connector. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.ListDataSources | Lists the data source connectors that you have created. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.ListEntityPersonas | Lists specific permissions of users and groups with access to your Amazon Kendra experience. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.ListExperienceEntities | 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 expe |
| POST | /#X-Amz-Target=AWSKendraFrontendService.ListExperiences | 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 |
| POST | /#X-Amz-Target=AWSKendraFrontendService.ListFaqs | Gets a list of FAQ lists associated with an index. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.ListFeaturedResultsSets | 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 |
| POST | /#X-Amz-Target=AWSKendraFrontendService.ListGroupsOlderThanOrderingId | <p>Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.</p> <p> <code>ListGroupsOlderThanOrderingId</code> is cur |
| POST | /#X-Amz-Target=AWSKendraFrontendService.ListIndices | Lists the Amazon Kendra indexes that you created. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.ListQuerySuggestionsBlockLists | <p>Lists the block lists used for query suggestions for an index.</p> <p>For information on the current quota limits for block lists, see <a href="https://docs. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.ListTagsForResource | Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.ListThesauri | Lists the thesauri for an index. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.PutPrincipalMapping | <p>Maps users to their groups so that you only need to provide the user ID when you issue the query.</p> <p>You can also map sub groups to groups. For example, |
| POST | /#X-Amz-Target=AWSKendraFrontendService.Query | <p>Searches an active index. Use this API to search your documents using query. The <code>Query</code> API enables to do faceted search and to filter results ba |
| POST | /#X-Amz-Target=AWSKendraFrontendService.StartDataSourceSyncJob | Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a <code>ResourceInUseException< |
| POST | /#X-Amz-Target=AWSKendraFrontendService.StopDataSourceSyncJob | Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.SubmitFeedback | <p>Enables you to provide feedback to Amazon Kendra to improve the performance of your index.</p> <p> <code>SubmitFeedback</code> is currently not supported in |
| POST | /#X-Amz-Target=AWSKendraFrontendService.TagResource | 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. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.UntagResource | Removes a tag from an index, FAQ, or a data source. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.UpdateAccessControlConfiguration | <p>Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful fo |
| POST | /#X-Amz-Target=AWSKendraFrontendService.UpdateDataSource | Updates an existing Amazon Kendra data source connector. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.UpdateExperience | Updates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see <a href="https://docs. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.UpdateFeaturedResultsSet | 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 f |
| POST | /#X-Amz-Target=AWSKendraFrontendService.UpdateIndex | Updates an existing Amazon Kendra index. |
| POST | /#X-Amz-Target=AWSKendraFrontendService.UpdateQuerySuggestionsBlockList | <p>Updates a block list used for query suggestions for an index.</p> <p>Updates to a block list might not take effect right away. Amazon Kendra needs to refresh |
| POST | /#X-Amz-Target=AWSKendraFrontendService.UpdateQuerySuggestionsConfig | <p>Updates the settings of query suggestions for an index.</p> <p>Amazon Kendra supports partial updates, so you only need to provide the fields you want to upd |
| POST | /#X-Amz-Target=AWSKendraFrontendService.UpdateThesaurus | Updates a thesaurus for an index. |
Questions
Does the AWSKendraFrontendService API need an API key?
Yes. The AWSKendraFrontendService API uses API key authentication; the documentation explains how to get credentials.
Does the AWSKendraFrontendService API support HTTPS?
Yes, the AWSKendraFrontendService API is served over HTTPS.
How many endpoints does the AWSKendraFrontendService API have?
Its OpenAPI description lists 65 endpoints in version 2019-02-03. All of them are shown on this page.
What are alternatives to the AWSKendraFrontendService API?
Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.
Similar cloud platforms APIs
Compare alternatives →Remote Settings PROD
Cloud PlatformsFirefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.
Linode API
Cloud Platforms## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se
DigitalOcean API
Cloud Platforms# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having
Vercel API
Cloud PlatformsVercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Platform API
Cloud PlatformsThe [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Azure Data Lake Storage
Cloud PlatformsAzure Data Lake Storage provides storage for Hadoop and other big data workloads.
Listed from APIs.guru (CC0).