Skip to content
AWS for Query.Farm

aws.health.describe_entity_aggregates_for_organization

Example SQL Queries

SELECT * FROM
aws.health.describe_entity_aggregates_for_organization
WHERE
"event_arns" = 'VALUE';

Description

Returns a list of entity aggregates for your Organizations that are affected by each of the specified events.

Table Definition

Column NameColumn Data Type
event_arns Required Input Column

A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101" 

VARCHAR[]
Show child fields
event_arns[]
aws_account_ids Input Column

A list of 12-digit Amazon Web Services account numbers that contains the affected entities.

VARCHAR[]
Show child fields
aws_account_ids[]
_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.

organization_entity_aggregates

The list of entity aggregates for each of the specified accounts that are affected by each of the specified events.

STRUCT(
    "event_arn" VARCHAR,
    "count" BIGINT,
    "statuses" MAP(VARCHAR, BIGINT),
    "accounts" STRUCT(
        "account_id" VARCHAR,
        "count" BIGINT,
        "statuses" MAP(VARCHAR, BIGINT)
    )[]
)[]
Show child fields
organization_entity_aggregates[]
Show child fields
organization_entity_aggregates[].accounts[]
Show child fields
organization_entity_aggregates[].accounts[].account_id

The 12-digit Amazon Web Services account numbers that contains the affected entities.

organization_entity_aggregates[].accounts[].count

The number of entities that match the filter criteria for the specified events.

organization_entity_aggregates[].accounts[].statuses

The number of affected entities aggregated by the entity status codes.

organization_entity_aggregates[].count

The number of entities for the organization that match the filter criteria for the specified events.

organization_entity_aggregates[].event_arn

A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"

organization_entity_aggregates[].statuses

The number of affected entities aggregated by the entitiy status codes.