Skip to content
AWS for Query.Farm

aws.kendra.describe_principal_mapping

Example SQL Queries

SELECT * FROM
aws.kendra.describe_principal_mapping
WHERE
"index_id" = 'VALUE'
AND "group_id" = 'VALUE';

Description

Describes the processing of PUT and DELETE actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed.

DescribePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Table Definition

Column NameColumn Data Type
group_id Required Input Column

Shows the identifier of the group to see information on the processing of PUT and DELETE actions for mapping users to their groups.

VARCHAR
index_id Required Input Column

Shows the identifier of the index to see information on the processing of PUT and DELETE actions for mapping users to their groups.

VARCHAR
data_source_id Input Column

Shows the identifier of the data source to see information on the processing of PUT and DELETE actions for mapping users to their 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
group_ordering_id_summaries

Shows the following information on the processing of PUT and DELETE actions for mapping users to their groups:

  • Status—the status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.

  • Last updated—the last date-time an action was updated.

  • Received—the last date-time an action was received or submitted.

  • Ordering ID—the latest action that should process and apply after other actions.

  • Failure reason—the reason an action could not be processed.

STRUCT(
    "status" VARCHAR,
    "last_updated_at" TIMESTAMP_S,
    "received_at" TIMESTAMP_S,
    "ordering_id" BIGINT,
    "failure_reason" VARCHAR
)[]
Show child fields
group_ordering_id_summaries[]
Show child fields
group_ordering_id_summaries[].failure_reason

The reason an action could not be processed. An action can be a PUT or DELETE action for mapping users to their groups.

group_ordering_id_summaries[].last_updated_at

The Unix timestamp when an action was last updated. An action can be a PUT or DELETE action for mapping users to their groups.

group_ordering_id_summaries[].ordering_id

The order in which actions should complete processing. An action can be a PUT or DELETE action for mapping users to their groups.

group_ordering_id_summaries[].received_at

The Unix timestamp when an action was received by Amazon Kendra. An action can be a PUT or DELETE action for mapping users to their groups.

group_ordering_id_summaries[].status

The current processing status of actions for mapping users to their groups. The status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.