Skip to content
AWS for Query.Farm

aws.health.describe_affected_entities

Example SQL Queries

SELECT * FROM
aws.health.describe_affected_entities
WHERE
"filter" = 'VALUE';

Description

Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.

At least one event ARN is required.

  • This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

  • This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.

Table Definition

Column NameColumn Data Type
filter Required Input Column

Values to narrow the results returned. At least one event ARN is required.

STRUCT(
    "event_arns" VARCHAR[],
    "entity_arns" VARCHAR[],
    "entity_values" VARCHAR[],
    "last_updated_times" STRUCT(
        "from" TIMESTAMP_S,
        "to" TIMESTAMP_S
    )[],
    "tags" MAP(VARCHAR, VARCHAR)[],
    "status_codes" VARCHAR[]
)
Show child fields
filter.entity_arns[]
filter.entity_values[]
filter.event_arns[]
filter.last_updated_times[]
Show child fields
filter.last_updated_times[].from

The starting date and time of a time range.

filter.last_updated_times[].to

The ending date and time of a time range.

filter.status_codes[]
filter.tags[]
locale Input Column

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

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_account_id

The 12-digit Amazon Web Services account number that contains the affected entity.

VARCHAR
entity_arn

The unique identifier for the entity. Format: arn:aws:health:entity-region:aws-account:entity/entity-id . Example: arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K 

VARCHAR
entity_url

The URL of the affected entity.

VARCHAR
entity_value

The ID of the affected entity.

VARCHAR
event_arn

The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.

For example, an event ARN might look like the following:

arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 

VARCHAR
last_updated_time

The most recent time that the entity was updated.

TIMESTAMP_S
status_code

The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, and UNKNOWN.

VARCHAR
tags

A map of entity tags attached to the affected entity.

Currently, the tags property isn't supported.

MAP(VARCHAR, VARCHAR)