Skip to content
AWS for Query.Farm

aws.events.list_archives

Example SQL Queries

SELECT * FROM
aws.events.list_archives;

Description

Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive names. Filter parameters are exclusive.

Table Definition

Column NameColumn Data Type
event_source_arn Input Column

The ARN of the event source associated with the archive.

VARCHAR
limit Input Column

The maximum number of results to return.

BIGINT
name_prefix Input Column

A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.

VARCHAR
next_token Input Column

The token returned by a previous call to retrieve the next set of results.

VARCHAR
state Input Column

The state 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.

_aws_region Input Column

The AWS region to use.

VARCHAR
archives

An array of Archive objects that include details about an archive.

STRUCT(
    "archive_name" VARCHAR,
    "event_source_arn" VARCHAR,
    "state" VARCHAR,
    "state_reason" VARCHAR,
    "retention_days" BIGINT,
    "size_bytes" BIGINT,
    "event_count" BIGINT,
    "creation_time" TIMESTAMP_S
)[]
Show child fields
archives[]
Show child fields
archives[].archive_name

The name of the archive.

archives[].creation_time

The time stamp for the time that the archive was created.

archives[].event_count

The number of events in the archive.

archives[].event_source_arn

The ARN of the event bus associated with the archive. Only events from this event bus are sent to the archive.

archives[].retention_days

The number of days to retain events in the archive before they are deleted.

archives[].size_bytes

The size of the archive, in bytes.

archives[].state

The current state of the archive.

archives[].state_reason

A description for the reason that the archive is in the current state.