Skip to content
AWS for Query.Farm

aws.workmail.list_groups_for_entity

Example SQL Queries

SELECT * FROM
aws.workmail.list_groups_for_entity
WHERE
"organization_id" = 'VALUE'
AND "entity_id" = 'VALUE';

Description

Returns all the groups to which an entity belongs.

Table Definition

Column NameColumn Data Type
entity_id Required Input Column

The identifier for the entity.

The entity ID can accept UserId or GroupID, Username or Groupname, or email.

  • Entity ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

  • Email address: entity@domain.tld

  • Entity name: entity

VARCHAR
organization_id Required Input Column

The identifier for the organization under which the entity exists.

VARCHAR
filters Input Column

Limit the search results based on the filter criteria.

STRUCT(
    "group_name_prefix" VARCHAR
)
Show child fields
filters.group_name_prefix

Filters only group names that start with the provided name prefix.

max_results Input Column

The maximum number of results to return in a single call.

BIGINT
next_token Input Column

The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.

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
groups

The overview of groups in an organization.

STRUCT(
    "group_id" VARCHAR,
    "group_name" VARCHAR
)[]
Show child fields
groups[]
Show child fields
groups[].group_id

Group ID that matched the group.

groups[].group_name

Group name that matched the group.