Skip to content
AWS for Query.Farm

aws.chime.get_user

Example SQL Queries

SELECT * FROM
aws.chime.get_user
WHERE
"account_id" = 'VALUE'
AND "user_id" = 'VALUE';

Description

Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.

To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.

Table Definition

Column NameColumn Data Type
account_id Required Input Column

The Amazon Chime account ID.

VARCHAR
user_id Required Input Column

The user ID.

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.

user

The user details.

STRUCT(
    "user_id" VARCHAR,
    "account_id" VARCHAR,
    "primary_email" VARCHAR,
    "primary_provisioned_number" VARCHAR,
    "display_name" VARCHAR,
    "license_type" VARCHAR,
    "user_type" VARCHAR,
    "user_registration_status" VARCHAR,
    "user_invitation_status" VARCHAR,
    "registered_on" TIMESTAMP_S,
    "invited_on" TIMESTAMP_S,
    "alexa_for_business_metadata" STRUCT(
        "is_alexa_for_business_enabled" BOOLEAN,
        "alexa_for_business_room_arn" VARCHAR
    ),
    "personal_pin" VARCHAR
)
Show child fields
user.account_id

The Amazon Chime account ID.

user.alexa_for_business_metadata

The Alexa for Business metadata.

Show child fields
user.alexa_for_business_metadata.alexa_for_business_room_arn

The ARN of the room resource.

user.alexa_for_business_metadata.is_alexa_for_business_enabled

Starts or stops Alexa for Business.

user.display_name

The display name of the user.

user.invited_on

Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

user.license_type

The license type for the user.

user.personal_pin

The user's personal meeting PIN.

user.primary_email

The primary email address of the user.

user.primary_provisioned_number

The primary phone number associated with the user.

user.registered_on

Date and time when the user is registered, in ISO 8601 format.

user.user_id

The user ID.

user.user_invitation_status

The user invite status.

user.user_registration_status

The user registration status.

user.user_type

The user type.