Skip to content
AWS for Query.Farm

aws.kendra.describe_access_control_configuration

Example SQL Queries

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

Description

Gets information about an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Table Definition

Column NameColumn Data Type
id Required Input Column

The identifier of the access control configuration you want to get information on.

VARCHAR
index_id Required Input Column

The identifier of the index for an access control configuration.

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
access_control_list

Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

STRUCT(
    "name" VARCHAR,
    "type" VARCHAR,
    "access" VARCHAR,
    "data_source_id" VARCHAR
)[]
Show child fields
access_control_list[]
Show child fields
access_control_list[].access

Whether to allow or deny document access to the principal.

access_control_list[].data_source_id

The identifier of the data source the principal should access documents from.

access_control_list[].name

The name of the user or group.

access_control_list[].type

The type of principal.

description

The description for the access control configuration.

VARCHAR
error_message

The error message containing details if there are issues processing the access control configuration.

VARCHAR
hierarchical_access_control_list

The list of principal lists that define the hierarchy for which documents users should have access to.

STRUCT(
    "principal_list" STRUCT(
        "name" VARCHAR,
        "type" VARCHAR,
        "access" VARCHAR,
        "data_source_id" VARCHAR
    )[]
)[]
Show child fields
hierarchical_access_control_list[]
Show child fields
hierarchical_access_control_list[].principal_list[]
Show child fields
hierarchical_access_control_list[].principal_list[].access

Whether to allow or deny document access to the principal.

hierarchical_access_control_list[].principal_list[].data_source_id

The identifier of the data source the principal should access documents from.

hierarchical_access_control_list[].principal_list[].name

The name of the user or group.

hierarchical_access_control_list[].principal_list[].type

The type of principal.

name

The name for the access control configuration.

VARCHAR