Skip to content
AWS for Query.Farm

aws.kendra.list_featured_results_sets

Example SQL Queries

SELECT * FROM
aws.kendra.list_featured_results_sets
WHERE
"index_id" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
index_id Required Input Column

The identifier of the index used for featuring results.

VARCHAR
max_results Input Column

The maximum number of featured results sets to return.

BIGINT
next_token Input Column

If the response is truncated, Amazon Kendra returns a pagination token in the response.

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
featured_results_set_summary_items

An array of summary information for one or more featured results sets.

STRUCT(
    "featured_results_set_id" VARCHAR,
    "featured_results_set_name" VARCHAR,
    "status" VARCHAR,
    "last_updated_timestamp" BIGINT,
    "creation_timestamp" BIGINT
)[]
Show child fields
featured_results_set_summary_items[]
Show child fields
featured_results_set_summary_items[].creation_timestamp

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

featured_results_set_summary_items[].featured_results_set_id

The identifier of the set of featured results.

featured_results_set_summary_items[].featured_results_set_name

The name for the set of featured results.

featured_results_set_summary_items[].last_updated_timestamp

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

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