Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

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

Request Syntax


{
   "Description": "string",
   "FeaturedDocuments": [ 
      { 
         "Id": "string"
      }
   ],
   "FeaturedResultsSetId": "string",
   "FeaturedResultsSetName": "string",
   "IndexId": "string",
   "QueryTexts": [ "string" ],
   "Status": "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.

Description

A new description for the set of featured results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: ^\P{C}*$

Required: No

FeaturedDocuments

A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of featured documents, see FeaturedResultsSet.

Type: Array of FeaturedDocument objects

Required: No

FeaturedResultsSetId

The identifier of the set of featured results that you want to update.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[a-zA-Z-0-9]*

Required: Yes

FeaturedResultsSetName

A new name for the set of featured results.

Type: String

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

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

Required: No

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

QueryTexts

A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 49 items.

Required: No

Status

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

Type: String

Valid Values: ACTIVE | INACTIVE

Required: No

Response Syntax


{
   "FeaturedResultsSet": { 
      "CreationTimestamp": number,
      "Description": "string",
      "FeaturedDocuments": [ 
         { 
            "Id": "string"
         }
      ],
      "FeaturedResultsSetId": "string",
      "FeaturedResultsSetName": "string",
      "LastUpdatedTimestamp": number,
      "QueryTexts": [ "string" ],
      "Status": "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.

FeaturedResultsSet

Information on the set of featured results. This includes the identifier of the featured results set, whether the featured results set is active or inactive, when the featured results set was last updated, and more.

Type: FeaturedResultsSet object

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

FeaturedResultsConflictException

An error message with a list of conflicting queries used across different sets of featured results. This occurred with the request for a new featured results set. Check that the queries you specified for featured results are unique per featured results set for each index.

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