Skip to content
AWS for Query.Farm

aws.workmail.describe_group

Example SQL Queries

SELECT * FROM
aws.workmail.describe_group
WHERE
"organization_id" = 'VALUE'
AND "group_id" = 'VALUE';

Description

Returns the data available for the group.

Table Definition

Column NameColumn Data Type
group_id Required Input Column

The identifier of the described group.

VARCHAR
organization_id Required Input Column

The identifier for the organization under which the group exists.

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
disabled_date

The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.

TIMESTAMP_S
email

The email of the described group.

VARCHAR
enabled_date

The date and time when a user was registered to WorkMail, in UNIX epoch time format.

TIMESTAMP_S
hidden_from_global_address_list

If the value is set to true, the group is hidden from the address book.

BOOLEAN
name

The name of the described group.

VARCHAR
state

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

VARCHAR