Skip to content
AWS for Query.Farm

aws.workmail.describe_resource

Example SQL Queries

SELECT * FROM
aws.workmail.describe_resource
WHERE
"organization_id" = 'VALUE'
AND "resource_id" = 'VALUE';

Description

Returns the data available for the resource.

Table Definition

Column NameColumn Data Type
organization_id Required Input Column

The identifier associated with the organization for which the resource is described.

VARCHAR
resource_id Required Input Column

The identifier of the described resource.

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
booking_options

The booking options for the described resource.

STRUCT(
    "auto_accept_requests" BOOLEAN,
    "auto_decline_recurring_requests" BOOLEAN,
    "auto_decline_conflicting_requests" BOOLEAN
)
Show child fields
booking_options.auto_accept_requests

The resource's ability to automatically reply to requests. If disabled, delegates must be associated to the resource.

booking_options.auto_decline_conflicting_requests

The resource's ability to automatically decline any conflicting requests.

booking_options.auto_decline_recurring_requests

The resource's ability to automatically decline any recurring requests.

description

Description of the resource.

VARCHAR
disabled_date

The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.

TIMESTAMP_S
email

The email of the described resource.

VARCHAR
enabled_date

The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.

TIMESTAMP_S
hidden_from_global_address_list

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

BOOLEAN
name

The name of the described resource.

VARCHAR
state

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

VARCHAR
type

The type of the described resource.

VARCHAR