Skip to content
AWS for Query.Farm

aws.mailmanager.get_relay

Example SQL Queries

SELECT * FROM
aws.mailmanager.get_relay
WHERE
"relay_id" = 'VALUE';

Description

Fetch the relay resource and it's attributes.

Table Definition

Column NameColumn Data Type
relay_id Required Input Column

The unique relay identifier.

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.

authentication

The authentication attribute—contains the secret ARN where the customer relay server credentials are stored. 

STRUCT(
    "no_authentication" BOOLEAN,
    "secret_arn" VARCHAR
)
Show child fields
authentication.no_authentication

Keep an empty structure if the relay destination server does not require SMTP credential authentication.

authentication.secret_arn

The ARN of the secret created in secrets manager where the relay server's SMTP credentials are stored.

created_timestamp

The timestamp of when the relay was created.

TIMESTAMP_S
last_modified_timestamp

The timestamp of when relay was last updated.

TIMESTAMP_S
relay_arn

The Amazon Resource Name (ARN) of the relay.

VARCHAR
relay_name

The unique name of the relay.

VARCHAR
server_name

The destination relay server address.

VARCHAR
server_port

The destination relay server port.

BIGINT