Skip to content
AWS for Query.Farm

aws.kendra.list_experience_entities

Example SQL Queries

SELECT * FROM
aws.kendra.list_experience_entities
WHERE
"id" = 'VALUE'
AND "index_id" = 'VALUE';

Description

Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Table Definition

Column NameColumn Data Type
id Required Input Column

The identifier of your Amazon Kendra experience.

VARCHAR
index_id Required Input Column

The identifier of the index for your Amazon Kendra experience.

VARCHAR
next_token Input Column

If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of users or groups.

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
summary_items

An array of summary information for one or more users or groups.

STRUCT(
    "entity_id" VARCHAR,
    "entity_type" VARCHAR,
    "display_data" STRUCT(
        "user_name" VARCHAR,
        "group_name" VARCHAR,
        "identified_user_name" VARCHAR,
        "first_name" VARCHAR,
        "last_name" VARCHAR
    )
)[]
Show child fields
summary_items[]
Show child fields
summary_items[].display_data

Information about the user entity.

Show child fields
summary_items[].display_data.first_name

The first name of the user.

summary_items[].display_data.group_name

The name of the group.

summary_items[].display_data.identified_user_name

The user name of the user.

summary_items[].display_data.last_name

The last name of the user.

summary_items[].display_data.user_name

The name of the user.

summary_items[].entity_id

The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

summary_items[].entity_type

Shows the type as User or Group.