featured_results_sets

Creates, updates, deletes, gets or lists a featured_results_sets resource.

Overview

Name	featured_results_sets
Type	Resource
Id	aws.kendra.featured_results_sets

Fields

The following fields are returned by SELECT queries:

describe_featured_results_set

Name	Datatype	Description
creation_timestamp	integer (int64)	The Unix timestamp when the set of the featured results was created.
description	string	The description for the set of featured results. (pattern: <code>^\P{C}*$</code>)
featured_documents_missing	array	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.
featured_documents_with_metadata	array	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.
featured_results_set_id	string	The identifier of the set of featured results. (pattern: <code>^[a-zA-Z-0-9]*</code>)
featured_results_set_name	string	The name for the set of featured results. (pattern: <code>[a-zA-Z0-9][ a-zA-Z0-9_-]*</code>)
last_updated_timestamp	integer (int64)	The timestamp when the set of featured results was last updated.
query_texts	array	The list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
status	string	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. (ACTIVE, INACTIVE)

list_featured_results_sets

Name	Datatype	Description
featured_results_set_summary_items	array	An array of summary information for one or more featured results sets.
next_token	string	If the response is truncated, Amazon Kendra returns a pagination token in the response.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_featured_results_set	select	region		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.
list_featured_results_sets	select	region		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.
create_featured_results_set	insert	region, IndexId, FeaturedResultsSetName		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. You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting Support.
update_featured_results_set	update	region, IndexId, FeaturedResultsSetId		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.
batch_delete_featured_results_set	exec	region, IndexId, FeaturedResultsSetIds		Removes one or more sets 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_featured_results_set

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.

SELECT
creation_timestamp,
description,
featured_documents_missing,
featured_documents_with_metadata,
featured_results_set_id,
featured_results_set_name,
last_updated_timestamp,
query_texts,
status
FROM aws.kendra.featured_results_sets
WHERE region = '{{ region }}' -- required
;

list_featured_results_sets

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.

SELECT
featured_results_set_summary_items,
next_token
FROM aws.kendra.featured_results_sets
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_featured_results_set

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. You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting Support.

INSERT INTO aws.kendra.featured_results_sets (
IndexId,
FeaturedResultsSetName,
Description,
ClientToken,
Status,
QueryTexts,
FeaturedDocuments,
Tags,
region
)
SELECT 
'{{ IndexId }}' /* required */,
'{{ FeaturedResultsSetName }}' /* required */,
'{{ Description }}',
'{{ ClientToken }}',
'{{ Status }}',
'{{ QueryTexts }}',
'{{ FeaturedDocuments }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
featured_results_set
;

Manifest

# Description fields are for documentation purposes
- name: featured_results_sets
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the featured_results_sets resource.
  - name: IndexId
    value: "{{ IndexId }}"
    description: |
      The identifier of the index that you want to use for featuring results.
  - name: FeaturedResultsSetName
    value: "{{ FeaturedResultsSetName }}"
    description: |
      A name for the set of featured results.
  - name: Description
    value: "{{ Description }}"
    description: |
      A description for the set of featured results.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A token that you provide to identify the request to create a set of featured results. Multiple calls to the CreateFeaturedResultsSet API with the same client token will create only one featured results set.
  - name: Status
    value: "{{ Status }}"
    description: |
      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.
    valid_values: ['ACTIVE', 'INACTIVE']
  - name: QueryTexts
    value:
      - "{{ QueryTexts }}"
    description: |
      A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
  - name: FeaturedDocuments
    description: |
      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 documents, see FeaturedResultsSet.
    value:
      - Id: "{{ Id }}"
  - name: Tags
    description: |
      A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols:_ . : / = + - @.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_featured_results_set

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.

UPDATE aws.kendra.featured_results_sets
SET 
IndexId = '{{ IndexId }}',
FeaturedResultsSetId = '{{ FeaturedResultsSetId }}',
FeaturedResultsSetName = '{{ FeaturedResultsSetName }}',
Description = '{{ Description }}',
Status = '{{ Status }}',
QueryTexts = '{{ QueryTexts }}',
FeaturedDocuments = '{{ FeaturedDocuments }}'
WHERE 
region = '{{ region }}' --required
AND IndexId = '{{ IndexId }}' --required
AND FeaturedResultsSetId = '{{ FeaturedResultsSetId }}' --required
RETURNING
featured_results_set;

Lifecycle Methods

batch_delete_featured_results_set

Removes one or more sets 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.

EXEC aws.kendra.featured_results_sets.batch_delete_featured_results_set 
@region='{{ region }}' --required 
@@json=
'{
"IndexId": "{{ IndexId }}", 
"FeaturedResultsSetIds": "{{ FeaturedResultsSetIds }}"
}'
;