Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465566486.4 KB

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.

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

Headers

X-Amz-Target'AWSKendraFrontendService.DescribeFeaturedResultsSet' required

Request body

IndexIdstring required

The identifier of the index used for featuring results.

FeaturedResultsSetIdstring required

The identifier of the set of featured results that you want to get information on.

Response

Success

FeaturedResultsSetIdstring

The identifier of the set of featured results.

FeaturedResultsSetNamestring

The name for the set of featured results.

Descriptionstring

The description for the set of featured results.

Status'ACTIVE' | 'INACTIVE'

The current status of the set of featured results. 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>. You can set the status to <code>ACTIVE</code> or <code>INACTIVE</code> using the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html">UpdateFeaturedResultsSet</a> API. 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[]

The 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>.

LastUpdatedTimestampinteger

The timestamp when the set of featured results was last updated.

CreationTimestampinteger

The Unix timestamp when the set of the featured results was created.