Skip to content
AWS for Query.Farm

aws.workmail.get_mail_domain

Example SQL Queries

SELECT * FROM
aws.workmail.get_mail_domain
WHERE
"organization_id" = 'VALUE'
AND "domain_name" = 'VALUE';

Description

Gets details for a mail domain, including domain records required to configure your domain with recommended security.

Table Definition

Column NameColumn Data Type
domain_name Required Input Column

The domain from which you want to retrieve details.

VARCHAR
organization_id Required Input Column

The WorkMail organization for which the domain is retrieved.

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
dkim_verification_status

Indicates the status of a DKIM verification.

VARCHAR
is_default

Specifies whether the domain is the default domain for your organization.

BOOLEAN
is_test_domain

Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.

BOOLEAN
ownership_verification_status

Indicates the status of the domain ownership verification.

VARCHAR
records

A list of the DNS records that WorkMail recommends adding in your DNS provider for the best user experience. The records configure your domain with DMARC, SPF, DKIM, and direct incoming email traffic to SES. See admin guide for more details.

STRUCT(
    "type" VARCHAR,
    "hostname" VARCHAR,
    "value" VARCHAR
)[]
Show child fields
records[]
Show child fields
records[].hostname

The DNS hostname.- For example, domain.example.com.

records[].type

The RFC 1035 record type. Possible values: CNAME, A, MX.

records[].value

The value returned by the DNS for a query to that hostname and record type.