Skip to content
AWS for Query.Farm

aws.kendra.describe_featured_results_set

Example SQL Queries

SELECT * FROM
aws.kendra.describe_featured_results_set
WHERE
"index_id" = 'VALUE'
AND "featured_results_set_id" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
featured_results_set_id Required Input Column

The identifier of the set of featured results.

VARCHAR
index_id Required Input Column

The identifier of the index used for featuring results.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
creation_timestamp

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

BIGINT
description

The description for the set of featured results.

VARCHAR
featured_documents_missing

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.

STRUCT(
    "id" VARCHAR
)[]
Show child fields
featured_documents_missing[]
Show child fields
featured_documents_missing[].id

The identifier of the document that doesn't exist but you have specified as a featured document.

featured_documents_with_metadata

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.

STRUCT(
    "id" VARCHAR,
    "title" VARCHAR,
    "uri" VARCHAR
)[]
Show child fields
featured_documents_with_metadata[]
Show child fields
featured_documents_with_metadata[].id

The identifier of the featured document with its metadata. You can use the Query API to search for specific documents with their document IDs included in the result items, or you can use the console.

featured_documents_with_metadata[].title

The main title of the featured document.

featured_documents_with_metadata[].uri

The source URI location of the featured document.

featured_results_set_name

The name for the set of featured results.

VARCHAR
last_updated_timestamp

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

BIGINT
query_texts

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

VARCHAR[]
Show child fields
query_texts[]
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.

VARCHAR