Skip to content
AWS for Query.Farm

aws.workmail.describe_user

Example SQL Queries

SELECT * FROM
aws.workmail.describe_user
WHERE
"organization_id" = 'VALUE'
AND "user_id" = 'VALUE';

Description

Provides information regarding the user.

Table Definition

Column NameColumn Data Type
organization_id Required Input Column

The identifier for the organization under which the user exists.

VARCHAR
user_id Required Input Column

The identifier for the described user.

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
city

City where the user is located.

VARCHAR
company

Company of the user.

VARCHAR
country

Country where the user is located.

VARCHAR
department

Department of the user.

VARCHAR
disabled_date

The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.

TIMESTAMP_S
display_name

The display name of the user.

VARCHAR
email

The email of the user.

VARCHAR
enabled_date

The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.

TIMESTAMP_S
first_name

First name of the user.

VARCHAR
hidden_from_global_address_list

If enabled, the user is hidden from the global address list.

BOOLEAN
initials

Initials of the user.

VARCHAR
job_title

Job title of the user.

VARCHAR
last_name

Last name of the user.

VARCHAR
mailbox_deprovisioned_date

The date when the mailbox was removed for the user.

TIMESTAMP_S
mailbox_provisioned_date

The date when the mailbox was created for the user.

TIMESTAMP_S
name

The name for the user.

VARCHAR
office

Office where the user is located.

VARCHAR
state

The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

VARCHAR
street

Street where the user is located.

VARCHAR
telephone

User's contact number.

VARCHAR
user_role

In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_USER.

VARCHAR
zip_code

Zip code of the user.

VARCHAR