FeaturedResultsSetSummary
Summary information for a set of featured results. Featured 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.
Contents
- CreationTimestamp
-
The Unix timestamp when the set of featured results was created.
Type: Long
Required: No
- FeaturedResultsSetId
-
The identifier of the set of featured results.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-zA-Z-0-9]*Required: No
- 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_-]*Required: No
- LastUpdatedTimestamp
-
The Unix timestamp when the set of featured results was last updated.
Type: Long
Required: No
- 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 toACTIVE. You can set the status toACTIVEorINACTIVEusing the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status isACTIVEorINACTIVE.Type: String
Valid Values:
ACTIVE | INACTIVERequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
