View a markdown version of this page

AWS::Kendra::FeaturedResultsSet - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Kendra::FeaturedResultsSet

Creates a set of featured results to display at the top of the search results page. Featured 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, then one or more specific documents are featured in the search results.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Kendra::FeaturedResultsSet",
  "Properties" : {
      "Description" : String,
      "FeaturedDocuments" : [ FeaturedDocument, ... ],
      "FeaturedResultsSetName" : String,
      "IndexId" : String,
      "QueryTexts" : [ String, ... ],
      "Status" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Kendra::FeaturedResultsSet
Properties:
  Description: String
  FeaturedDocuments: 
    - FeaturedDocument
  FeaturedResultsSetName: String
  IndexId: String
  QueryTexts: 
    - String
  Status: String
  Tags: 
    - Tag

Properties

Description

A description for the set of featured results.

Required: No

Type: String

Pattern: ^\P{C}*$

Minimum: 0

Maximum: 1000

Update requires: No interruption

FeaturedDocuments

A list of document IDs for the documents you want to feature at the top of the search results page.

Required: No

Type: Array of FeaturedDocument

Update requires: No interruption

FeaturedResultsSetName

A name for the set of featured results.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 1000

Update requires: No interruption

IndexId

The identifier of the index that you want to use for featuring results.

Required: Yes

Type: String

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

Minimum: 36

Maximum: 36

Update requires: Replacement

QueryTexts

A list of queries for featuring results.

Required: No

Type: Array of String

Minimum: 0

Maximum: 49

Update requires: No interruption

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. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.

Required: No

Type: String

Allowed values: ACTIVE | INACTIVE

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the features results set ID. For example:

{"Ref": "featured-results-set-id"}

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

Property description not available.

FeaturedResultsSetId

The identifier of the set of featured results.