Skip to content
AWS for Query.Farm

aws.connect.search_user_hierarchy_groups

Example SQL Queries

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

Description

Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.

The UserHierarchyGroup with "LevelId": "0" is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.

Table Definition

Column NameColumn Data Type
instance_id Required Input Column

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

VARCHAR
search_criteria Input Column

The search criteria to be used to return UserHierarchyGroups.

STRUCT(
    "string_condition" STRUCT(
        "field_name" VARCHAR,
        "value" VARCHAR,
        "comparison_type" VARCHAR
    )
)
Show child fields
search_criteria.string_condition

A leaf node condition which can be used to specify a string condition.

The currently supported values for FieldName are name,

 parentId, levelId, and resourceID.

Show child fields
search_criteria.string_condition.comparison_type

The type of comparison to be made when evaluating the string condition.

search_criteria.string_condition.field_name

The name of the field in the string condition.

search_criteria.string_condition.value

The value of the string.

search_filter Input Column

Filters to be applied to search results.

STRUCT(
    "attribute_filter" STRUCT(
        "or_conditions" STRUCT(
            "tag_conditions" STRUCT(
                "tag_key" VARCHAR,
                "tag_value" VARCHAR
            )[]
        )[],
        "and_condition" STRUCT(
            "tag_conditions" STRUCT(
                "tag_key" VARCHAR,
                "tag_value" VARCHAR
            )[]
        ),
        "tag_condition" STRUCT(
            "tag_key" VARCHAR,
            "tag_value" VARCHAR
        )
    )
)
Show child fields
search_filter.attribute_filter

An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where:

  • The top level list specifies conditions that need to be applied with OR operator.

  • The inner list specifies conditions that need to be applied with AND operator.

Show child fields
search_filter.attribute_filter.and_condition

A list of conditions which would be applied together with an AND condition.

Show child fields
search_filter.attribute_filter.and_condition.tag_conditions[]
Show child fields
search_filter.attribute_filter.and_condition.tag_conditions[].tag_key

The tag key in the tag condition.

search_filter.attribute_filter.and_condition.tag_conditions[].tag_value

The tag value in the tag condition.

search_filter.attribute_filter.or_conditions[]
Show child fields
search_filter.attribute_filter.or_conditions[].tag_conditions[]
Show child fields
search_filter.attribute_filter.or_conditions[].tag_conditions[].tag_key

The tag key in the tag condition.

search_filter.attribute_filter.or_conditions[].tag_conditions[].tag_value

The tag value in the tag condition.

search_filter.attribute_filter.tag_condition

A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.

Show child fields
search_filter.attribute_filter.tag_condition.tag_key

The tag key in the tag condition.

search_filter.attribute_filter.tag_condition.tag_value

The tag value in the tag condition.

_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
approximate_total_count

The total number of userHierarchyGroups which matched your search query.

BIGINT
user_hierarchy_groups

Information about the userHierarchyGroups.

STRUCT(
    "id" VARCHAR,
    "arn" VARCHAR,
    "name" VARCHAR,
    "level_id" VARCHAR,
    "hierarchy_path" 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
        )
    ),
    "tags" MAP(VARCHAR, VARCHAR),
    "last_modified_time" TIMESTAMP_S,
    "last_modified_region" VARCHAR
)[]
Show child fields
user_hierarchy_groups[]
Show child fields
user_hierarchy_groups[].arn

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

user_hierarchy_groups[].hierarchy_path

Information about the levels in the hierarchy group.

Show child fields
user_hierarchy_groups[].hierarchy_path.level_five

Information about level five.

Show child fields
user_hierarchy_groups[].hierarchy_path.level_five.arn

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

user_hierarchy_groups[].hierarchy_path.level_five.id

The identifier of the hierarchy group.

user_hierarchy_groups[].hierarchy_path.level_five.last_modified_region

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

user_hierarchy_groups[].hierarchy_path.level_five.last_modified_time

The timestamp when this resource was last modified.

user_hierarchy_groups[].hierarchy_path.level_five.name

The name of the hierarchy group.

user_hierarchy_groups[].hierarchy_path.level_four

Information about level four.

Show child fields
user_hierarchy_groups[].hierarchy_path.level_four.arn

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

user_hierarchy_groups[].hierarchy_path.level_four.id

The identifier of the hierarchy group.

user_hierarchy_groups[].hierarchy_path.level_four.last_modified_region

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

user_hierarchy_groups[].hierarchy_path.level_four.last_modified_time

The timestamp when this resource was last modified.

user_hierarchy_groups[].hierarchy_path.level_four.name

The name of the hierarchy group.

user_hierarchy_groups[].hierarchy_path.level_one

Information about level one.

Show child fields
user_hierarchy_groups[].hierarchy_path.level_one.arn

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

user_hierarchy_groups[].hierarchy_path.level_one.id

The identifier of the hierarchy group.

user_hierarchy_groups[].hierarchy_path.level_one.last_modified_region

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

user_hierarchy_groups[].hierarchy_path.level_one.last_modified_time

The timestamp when this resource was last modified.

user_hierarchy_groups[].hierarchy_path.level_one.name

The name of the hierarchy group.

user_hierarchy_groups[].hierarchy_path.level_three

Information about level three.

Show child fields
user_hierarchy_groups[].hierarchy_path.level_three.arn

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

user_hierarchy_groups[].hierarchy_path.level_three.id

The identifier of the hierarchy group.

user_hierarchy_groups[].hierarchy_path.level_three.last_modified_region

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

user_hierarchy_groups[].hierarchy_path.level_three.last_modified_time

The timestamp when this resource was last modified.

user_hierarchy_groups[].hierarchy_path.level_three.name

The name of the hierarchy group.

user_hierarchy_groups[].hierarchy_path.level_two

Information about level two.

Show child fields
user_hierarchy_groups[].hierarchy_path.level_two.arn

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

user_hierarchy_groups[].hierarchy_path.level_two.id

The identifier of the hierarchy group.

user_hierarchy_groups[].hierarchy_path.level_two.last_modified_region

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

user_hierarchy_groups[].hierarchy_path.level_two.last_modified_time

The timestamp when this resource was last modified.

user_hierarchy_groups[].hierarchy_path.level_two.name

The name of the hierarchy group.

user_hierarchy_groups[].id

The identifier of the hierarchy group.

user_hierarchy_groups[].last_modified_region

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

user_hierarchy_groups[].last_modified_time

The timestamp when this resource was last modified.

user_hierarchy_groups[].level_id

The identifier of the level in the hierarchy group.

user_hierarchy_groups[].name

The name of the hierarchy group.

user_hierarchy_groups[].tags

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.