Skip to content
AWS for Query.Farm

aws.workmail.get_impersonation_role_effect

Example SQL Queries

SELECT * FROM
aws.workmail.get_impersonation_role_effect
WHERE
"organization_id" = 'VALUE'
AND "impersonation_role_id" = 'VALUE'
AND "target_user" = 'VALUE';

Description

Tests whether the given impersonation role can impersonate a target user.

Table Definition

Column NameColumn Data Type
impersonation_role_id Required Input Column

The impersonation role ID to test.

VARCHAR
organization_id Required Input Column

The WorkMail organization where the impersonation role is defined.

VARCHAR
target_user Required Input Column

The WorkMail organization user chosen to test the impersonation role. The following identity formats are available:

  • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

  • Email address: user@domain.tld

  • User name: user 

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
effect

Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY.

VARCHAR
matched_rules

A list of the rules that match the input and produce the configured effect.

STRUCT(
    "impersonation_rule_id" VARCHAR,
    "name" VARCHAR
)[]
Show child fields
matched_rules[]
Show child fields
matched_rules[].impersonation_rule_id

The ID of the rule that matched the input

matched_rules[].name

The name of the rule that matched the input.

type

The impersonation role type.

VARCHAR