Skip to content
AWS for Query.Farm

aws.connect.describe_user

Example SQL Queries

SELECT * FROM
aws.connect.describe_user
WHERE
"user_id" = 'VALUE'
AND "instance_id" = 'VALUE';

Description

Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

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
user_id Required Input Column

The identifier of the user account.

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
user

Information about the user account and configuration settings.

STRUCT(
    "id" VARCHAR,
    "arn" VARCHAR,
    "username" VARCHAR,
    "identity_info" STRUCT(
        "first_name" VARCHAR,
        "last_name" VARCHAR,
        "email" VARCHAR,
        "secondary_email" VARCHAR,
        "mobile" VARCHAR
    ),
    "phone_config" STRUCT(
        "phone_type" VARCHAR,
        "auto_accept" BOOLEAN,
        "after_contact_work_time_limit" BIGINT,
        "desk_phone_number" VARCHAR
    ),
    "directory_user_id" VARCHAR,
    "security_profile_ids" VARCHAR[],
    "routing_profile_id" VARCHAR,
    "hierarchy_group_id" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "last_modified_time" TIMESTAMP_S,
    "last_modified_region" VARCHAR
)
Show child fields
user.arn

The Amazon Resource Name (ARN) of the user account.

user.directory_user_id

The identifier of the user account in the directory used for identity management.

user.hierarchy_group_id

The identifier of the hierarchy group for the user.

user.id

The identifier of the user account.

user.identity_info

Information about the user identity.

Show child fields
user.identity_info.email

The email address. If you are using SAML for identity management and include this parameter, an error is returned.

user.identity_info.first_name

The first name. This is required if you are using Amazon Connect or SAML for identity management.

user.identity_info.last_name

The last name. This is required if you are using Amazon Connect or SAML for identity management.

user.identity_info.mobile

The user's mobile number.

user.identity_info.secondary_email

The user's secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.

Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

user.last_modified_region

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

user.last_modified_time

The timestamp when this resource was last modified.

user.phone_config

Information about the phone configuration for the user.

Show child fields
user.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.

user.phone_config.auto_accept

The Auto accept setting.

user.phone_config.desk_phone_number

The phone number for the user's desk phone.

user.phone_config.phone_type

The phone type.

user.routing_profile_id

The identifier of the routing profile for the user.

user.security_profile_ids[]
user.tags

The tags.

user.username

The user name assigned to the user account.