Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

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

Request Syntax


{
   "FeaturedResultsSetId": "string",
   "IndexId": "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.

FeaturedResultsSetId

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

Type: String

Length Constraints: Fixed length of 36.

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

Required: Yes

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

Response Syntax


{
   "CreationTimestamp": number,
   "Description": "string",
   "FeaturedDocumentsMissing": [ 
      { 
         "Id": "string"
      }
   ],
   "FeaturedDocumentsWithMetadata": [ 
      { 
         "Id": "string",
         "Title": "string",
         "URI": "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.

CreationTimestamp

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

Type: Long

Description

The description for the set of featured results.

Type: String

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

Pattern: ^\P{C}*$

FeaturedDocumentsMissing

The list of document IDs that don't exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus API.

Type: Array of FeaturedDocumentMissing objects

FeaturedDocumentsWithMetadata

The list of document IDs for the documents you want to feature with their metadata information. For more information on the list of featured documents, see FeaturedResultsSet.

Type: Array of FeaturedDocumentWithMetadata objects

FeaturedResultsSetId

The identifier of the set of featured results.

Type: String

Length Constraints: Fixed length of 36.

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

FeaturedResultsSetName

The 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_-]*

LastUpdatedTimestamp

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

Type: Long

QueryTexts

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

Status

The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. 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

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