Skip to content
AWS for Query.Farm

aws.connect.search_users

Example SQL Queries

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

Description

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

AfterContactWorkTimeLimit is returned in milliseconds.

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.

InstanceID is a required field. The "Required: No" below is incorrect.

VARCHAR
search_criteria Input Column

The search criteria to be used to return users.

The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. 

STRUCT(
    "string_condition" STRUCT(
        "field_name" VARCHAR,
        "value" VARCHAR,
        "comparison_type" VARCHAR
    ),
    "list_condition" STRUCT(
        "target_list_type" VARCHAR,
        "conditions" STRUCT(
            "string_condition" STRUCT(
                "field_name" VARCHAR,
                "value" VARCHAR,
                "comparison_type" VARCHAR
            ),
            "number_condition" STRUCT(
                "field_name" VARCHAR,
                "min_value" BIGINT,
                "max_value" BIGINT,
                "comparison_type" VARCHAR
            )
        )[]
    ),
    "hierarchy_group_condition" STRUCT(
        "value" VARCHAR,
        "hierarchy_group_match_type" VARCHAR
    )
)
Show child fields
search_criteria.hierarchy_group_condition

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

Show child fields
search_criteria.hierarchy_group_condition.hierarchy_group_match_type

The type of hierarchy group match.

search_criteria.hierarchy_group_condition.value

The value in the hierarchy group condition.

search_criteria.list_condition

A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.

Show child fields
search_criteria.list_condition.conditions[]
Show child fields
search_criteria.list_condition.conditions[].number_condition

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

Show child fields
search_criteria.list_condition.conditions[].number_condition.comparison_type

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

search_criteria.list_condition.conditions[].number_condition.field_name

The name of the field in the number condition.

search_criteria.list_condition.conditions[].number_condition.max_value

The maxValue to be used while evaluating the number condition.

search_criteria.list_condition.conditions[].number_condition.min_value

The minValue to be used while evaluating the number condition.

search_criteria.list_condition.conditions[].string_condition

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

The currently supported values for FieldName are name and
 value.

Show child fields
search_criteria.list_condition.conditions[].string_condition.comparison_type

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

search_criteria.list_condition.conditions[].string_condition.field_name

The name of the field in the string condition.

search_criteria.list_condition.conditions[].string_condition.value

The value of the string.

search_criteria.list_condition.target_list_type

The type of target list that will be used to filter the users.

search_criteria.string_condition

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

The currently supported values for FieldName are Username, FirstName, LastName, RoutingProfileId, SecurityProfileId, 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(
    "tag_filter" STRUCT(
        "or_conditions" STRUCT(
            "tag_key" VARCHAR,
            "tag_value" VARCHAR
        )[][],
        "and_conditions" STRUCT(
            "tag_key" VARCHAR,
            "tag_value" VARCHAR
        )[],
        "tag_condition" STRUCT(
            "tag_key" VARCHAR,
            "tag_value" VARCHAR
        )
    ),
    "user_attribute_filter" STRUCT(
        "or_conditions" STRUCT(
            "tag_conditions" STRUCT(
                "tag_key" VARCHAR,
                "tag_value" VARCHAR
            )[],
            "hierarchy_group_condition" STRUCT(
                "value" VARCHAR,
                "hierarchy_group_match_type" VARCHAR
            )
        )[],
        "and_condition" STRUCT(
            "tag_conditions" STRUCT(
                "tag_key" VARCHAR,
                "tag_value" VARCHAR
            )[],
            "hierarchy_group_condition" STRUCT(
                "value" VARCHAR,
                "hierarchy_group_match_type" VARCHAR
            )
        ),
        "tag_condition" STRUCT(
            "tag_key" VARCHAR,
            "tag_value" VARCHAR
        ),
        "hierarchy_group_condition" STRUCT(
            "value" VARCHAR,
            "hierarchy_group_match_type" VARCHAR
        )
    )
)
Show child fields
search_filter.tag_filter

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

  • Top level list specifies conditions that need to be applied with OR operator

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

Show child fields
search_filter.tag_filter.and_conditions[]
Show child fields
search_filter.tag_filter.and_conditions[].tag_key

The tag key in the tag condition.

search_filter.tag_filter.and_conditions[].tag_value

The tag value in the tag condition.

search_filter.tag_filter.or_conditions[][]
Show child fields
search_filter.tag_filter.or_conditions[][].tag_key

The tag key in the tag condition.

search_filter.tag_filter.or_conditions[][].tag_value

The tag value in the tag condition.

search_filter.tag_filter.tag_condition

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

Show child fields
search_filter.tag_filter.tag_condition.tag_key

The tag key in the tag condition.

search_filter.tag_filter.tag_condition.tag_value

The tag value in the tag condition.

search_filter.user_attribute_filter

An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the SearchFilter.

This accepts an OR of 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.

Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request will throw AccessDeniedException.

Show child fields
search_filter.user_attribute_filter.and_condition

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

Show child fields
search_filter.user_attribute_filter.and_condition.hierarchy_group_condition

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

Show child fields
search_filter.user_attribute_filter.and_condition.hierarchy_group_condition.hierarchy_group_match_type

The type of hierarchy group match.

search_filter.user_attribute_filter.and_condition.hierarchy_group_condition.value

The value in the hierarchy group condition.

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

The tag key in the tag condition.

search_filter.user_attribute_filter.and_condition.tag_conditions[].tag_value

The tag value in the tag condition.

search_filter.user_attribute_filter.hierarchy_group_condition

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

Show child fields
search_filter.user_attribute_filter.hierarchy_group_condition.hierarchy_group_match_type

The type of hierarchy group match.

search_filter.user_attribute_filter.hierarchy_group_condition.value

The value in the hierarchy group condition.

search_filter.user_attribute_filter.or_conditions[]
Show child fields
search_filter.user_attribute_filter.or_conditions[].hierarchy_group_condition

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

Show child fields
search_filter.user_attribute_filter.or_conditions[].hierarchy_group_condition.hierarchy_group_match_type

The type of hierarchy group match.

search_filter.user_attribute_filter.or_conditions[].hierarchy_group_condition.value

The value in the hierarchy group condition.

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

The tag key in the tag condition.

search_filter.user_attribute_filter.or_conditions[].tag_conditions[].tag_value

The tag value in the tag condition.

search_filter.user_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.user_attribute_filter.tag_condition.tag_key

The tag key in the tag condition.

search_filter.user_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 users who matched your search query.

BIGINT
users

Information about the users.

STRUCT(
    "arn" VARCHAR,
    "directory_user_id" VARCHAR,
    "hierarchy_group_id" VARCHAR,
    "id" VARCHAR,
    "identity_info" STRUCT(
        "first_name" VARCHAR,
        "last_name" VARCHAR
    ),
    "phone_config" STRUCT(
        "phone_type" VARCHAR,
        "auto_accept" BOOLEAN,
        "after_contact_work_time_limit" BIGINT,
        "desk_phone_number" VARCHAR
    ),
    "routing_profile_id" VARCHAR,
    "security_profile_ids" VARCHAR[],
    "tags" MAP(VARCHAR, VARCHAR),
    "username" VARCHAR
)[]
Show child fields
users[]
Show child fields
users[].arn

The Amazon Resource Name (ARN) of the user.

users[].directory_user_id

The directory identifier of the user.

users[].hierarchy_group_id

The identifier of the user's hierarchy group.

users[].id

The identifier of the user's summary.

users[].identity_info

The user's first name and last name.

Show child fields
users[].identity_info.first_name

The user's first name.

users[].identity_info.last_name

The user's last name.

users[].phone_config

Contains information about the phone configuration settings for a user.

Show child fields
users[].phone_config.after_contact_work_time_limit

The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.

When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.

users[].phone_config.auto_accept

The Auto accept setting.

users[].phone_config.desk_phone_number

The phone number for the user's desk phone.

users[].phone_config.phone_type

The phone type.

users[].routing_profile_id

The identifier of the user's routing profile.

users[].security_profile_ids[]
users[].tags

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

users[].username

The name of the user.