Skip to content
AWS for Query.Farm

aws.mailmanager.get_archive

Example SQL Queries

SELECT * FROM
aws.mailmanager.get_archive
WHERE
"archive_id" = 'VALUE';

Description

Retrieves the full details and current state of a specified email archive.

Table Definition

Column NameColumn Data Type
archive_id Required Input Column

The unique identifier of the archive.

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.

archive_arn

The Amazon Resource Name (ARN) of the archive.

VARCHAR
archive_name

The unique name assigned to the archive.

VARCHAR
archive_state

The current state of the archive:

  • ACTIVE – The archive is ready and available for use.

  • PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state. 

VARCHAR
created_timestamp

The timestamp of when the archive was created.

TIMESTAMP_S
kms_key_arn

The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive.

VARCHAR
last_updated_timestamp

The timestamp of when the archive was modified.

TIMESTAMP_S
retention

The retention period for emails in this archive.

STRUCT(
    "retention_period" VARCHAR
)
Show child fields
retention.retention_period

The enum value sets the period for retaining emails in an archive.