Skip to content
AWS for Query.Farm

aws.workmail.list_users

Example SQL Queries

SELECT * FROM
aws.workmail.list_users
WHERE
"organization_id" = 'VALUE';

Description

Returns summaries of the organization's users.

Table Definition

Column NameColumn Data Type
organization_id Required Input Column

The identifier for the organization under which the users exist.

VARCHAR
filters Input Column

Limit the user search results based on the filter criteria. You can only use one filter per request.

STRUCT(
    "username_prefix" VARCHAR,
    "display_name_prefix" VARCHAR,
    "primary_email_prefix" VARCHAR,
    "state" VARCHAR
)
Show child fields
filters.display_name_prefix

Filters only users with the provided display name prefix.

filters.primary_email_prefix

Filters only users with the provided email prefix.

filters.state

Filters only users with the provided state.

filters.username_prefix

Filters only users with the provided username prefix.

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

The date indicating when the user was disabled from WorkMail use.

TIMESTAMP_S
display_name

The display name of the user.

VARCHAR
email

The email of the user.

VARCHAR
enabled_date

The date indicating when the user was enabled for WorkMail use.

TIMESTAMP_S
id

The identifier of the user.

VARCHAR
name

The name of the user.

VARCHAR
state

The state of the user, which can be ENABLED, DISABLED, or DELETED.

VARCHAR
user_role

The role of the user.

VARCHAR