Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

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 a query, then one or more specific documents are featured in the search results.

Request Syntax


{
   "IndexId": "string",
   "MaxResults": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

IndexId

The identifier of the index used for featuring results.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]*

Required: Yes

MaxResults

The maximum number of featured results sets to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

If the response is truncated, Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of featured results sets.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 800.

Required: No

Response Syntax


{
   "FeaturedResultsSetSummaryItems": [ 
      { 
         "CreationTimestamp": number,
         "FeaturedResultsSetId": "string",
         "FeaturedResultsSetName": "string",
         "LastUpdatedTimestamp": number,
         "Status": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FeaturedResultsSetSummaryItems

An array of summary information for one or more featured results sets.

Type: Array of FeaturedResultsSetSummary objects

NextToken

If the response is truncated, Amazon Kendra returns a pagination token in the response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 800.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

HTTP Status Code: 400

InternalServerException

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

HTTP Status Code: 500

ResourceNotFoundException

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling. Please reduce the number of requests and try again.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

HTTP Status Code: 400