Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465566486.4 KB

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.

post/#X-Amz-Target=AWSKendraFrontendService.UpdateFeaturedResultsSet

Headers

X-Amz-Target'AWSKendraFrontendService.UpdateFeaturedResultsSet' required

Request body

IndexIdstring required

The identifier of the index used for featuring results.

FeaturedResultsSetIdstring required

The identifier of the index used for featuring results.

FeaturedResultsSetNamestring

A new name for the set of featured results.

Descriptionstring

A new description for the set of featured results.

Status'ACTIVE' | 'INACTIVE'

You can set the status to <code>ACTIVE</code> or <code>INACTIVE</code>. When the value is <code>ACTIVE</code>, featured results are ready for use. You can still configure your settings before setting the status to <code>ACTIVE</code>. The queries you specify for featured results must be unique per featured results set for each index, whether the status is <code>ACTIVE</code> or <code>INACTIVE</code>.

QueryTextsQueryText[]

A list of queries for featuring results. For more information on the list of queries, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.

Response

Success