Skip to content
AWS for Query.Farm

aws.connect.describe_user_hierarchy_structure

Example SQL Queries

SELECT * FROM
aws.connect.describe_user_hierarchy_structure
WHERE
"instance_id" = 'VALUE';

Description

Describes the hierarchy structure of the specified Amazon Connect instance.

Table Definition

Column NameColumn Data Type
instance_id Required Input Column

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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
hierarchy_structure

Information about the hierarchy structure.

STRUCT(
    "level_one" STRUCT(
        "id" VARCHAR,
        "arn" VARCHAR,
        "name" VARCHAR,
        "last_modified_time" TIMESTAMP_S,
        "last_modified_region" VARCHAR
    ),
    "level_two" STRUCT(
        "id" VARCHAR,
        "arn" VARCHAR,
        "name" VARCHAR,
        "last_modified_time" TIMESTAMP_S,
        "last_modified_region" VARCHAR
    ),
    "level_three" STRUCT(
        "id" VARCHAR,
        "arn" VARCHAR,
        "name" VARCHAR,
        "last_modified_time" TIMESTAMP_S,
        "last_modified_region" VARCHAR
    ),
    "level_four" STRUCT(
        "id" VARCHAR,
        "arn" VARCHAR,
        "name" VARCHAR,
        "last_modified_time" TIMESTAMP_S,
        "last_modified_region" VARCHAR
    ),
    "level_five" STRUCT(
        "id" VARCHAR,
        "arn" VARCHAR,
        "name" VARCHAR,
        "last_modified_time" TIMESTAMP_S,
        "last_modified_region" VARCHAR
    )
)
Show child fields
hierarchy_structure.level_five

Information about level five.

Show child fields
hierarchy_structure.level_five.arn

The Amazon Resource Name (ARN) of the hierarchy level.

hierarchy_structure.level_five.id

The identifier of the hierarchy level.

hierarchy_structure.level_five.last_modified_region

The Amazon Web Services Region where this resource was last modified.

hierarchy_structure.level_five.last_modified_time

The timestamp when this resource was last modified.

hierarchy_structure.level_five.name

The name of the hierarchy level.

hierarchy_structure.level_four

Information about level four.

Show child fields
hierarchy_structure.level_four.arn

The Amazon Resource Name (ARN) of the hierarchy level.

hierarchy_structure.level_four.id

The identifier of the hierarchy level.

hierarchy_structure.level_four.last_modified_region

The Amazon Web Services Region where this resource was last modified.

hierarchy_structure.level_four.last_modified_time

The timestamp when this resource was last modified.

hierarchy_structure.level_four.name

The name of the hierarchy level.

hierarchy_structure.level_one

Information about level one.

Show child fields
hierarchy_structure.level_one.arn

The Amazon Resource Name (ARN) of the hierarchy level.

hierarchy_structure.level_one.id

The identifier of the hierarchy level.

hierarchy_structure.level_one.last_modified_region

The Amazon Web Services Region where this resource was last modified.

hierarchy_structure.level_one.last_modified_time

The timestamp when this resource was last modified.

hierarchy_structure.level_one.name

The name of the hierarchy level.

hierarchy_structure.level_three

Information about level three.

Show child fields
hierarchy_structure.level_three.arn

The Amazon Resource Name (ARN) of the hierarchy level.

hierarchy_structure.level_three.id

The identifier of the hierarchy level.

hierarchy_structure.level_three.last_modified_region

The Amazon Web Services Region where this resource was last modified.

hierarchy_structure.level_three.last_modified_time

The timestamp when this resource was last modified.

hierarchy_structure.level_three.name

The name of the hierarchy level.

hierarchy_structure.level_two

Information about level two.

Show child fields
hierarchy_structure.level_two.arn

The Amazon Resource Name (ARN) of the hierarchy level.

hierarchy_structure.level_two.id

The identifier of the hierarchy level.

hierarchy_structure.level_two.last_modified_region

The Amazon Web Services Region where this resource was last modified.

hierarchy_structure.level_two.last_modified_time

The timestamp when this resource was last modified.

hierarchy_structure.level_two.name

The name of the hierarchy level.