Skip to content
AWS for Query.Farm

aws.accessanalyzer.get_archive_rule

Example SQL Queries

SELECT * FROM
aws.accessanalyzer.get_archive_rule
WHERE
"analyzer_name" = 'VALUE'
AND "rule_name" = 'VALUE';

Description

Retrieves information about an archive rule.

To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.

Table Definition

Column NameColumn Data Type
analyzer_name Required Input Column

The name of the analyzer to retrieve rules from.

VARCHAR
rule_name Required Input Column

The name of the rule to retrieve.

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_rule

Contains information about an archive rule.

STRUCT(
    "rule_name" VARCHAR,
    "filter" MAP(VARCHAR, STRUCT(
            "eq" VARCHAR[],
            "neq" VARCHAR[],
            "contains" VARCHAR[],
            "exists" BOOLEAN
        )),
    "created_at" TIMESTAMP_S,
    "updated_at" TIMESTAMP_S
)
Show child fields
archive_rule.created_at

The time at which the archive rule was created.

archive_rule.filter

A filter used to define the archive rule.

archive_rule.rule_name

The name of the archive rule.

archive_rule.updated_at

The time at which the archive rule was last updated.