Skip to content
AWS for Query.Farm

aws.health.describe_event_details

Example SQL Queries

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

Description

Returns detailed information about one or more specified events. Information includes standard event data (Amazon Web Services Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve the entities, use the DescribeAffectedEntities operation.

If a specified event can't be retrieved, an error message is returned for that event.

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
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[]
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.

failed_set

Error messages for any events that could not be retrieved.

STRUCT(
    "event_arn" VARCHAR,
    "error_name" VARCHAR,
    "error_message" VARCHAR
)[]
Show child fields
failed_set[]
Show child fields
failed_set[].error_message

A message that describes the error.

failed_set[].error_name

The name of the error.

failed_set[].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

successful_set

Information about the events that could be retrieved.

STRUCT(
    "event" STRUCT(
        "arn" VARCHAR,
        "service" VARCHAR,
        "event_type_code" VARCHAR,
        "event_type_category" VARCHAR,
        "region" VARCHAR,
        "availability_zone" VARCHAR,
        "start_time" TIMESTAMP_S,
        "end_time" TIMESTAMP_S,
        "last_updated_time" TIMESTAMP_S,
        "status_code" VARCHAR,
        "event_scope_code" VARCHAR
    ),
    "event_description" STRUCT(
        "latest_description" VARCHAR
    ),
    "event_metadata" MAP(VARCHAR, VARCHAR)
)[]
Show child fields
successful_set[]
Show child fields
successful_set[].event

Summary information about the event.

Show child fields
successful_set[].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

successful_set[].event.availability_zone

The Amazon Web Services Availability Zone of the event. For example, us-east-1a.

successful_set[].event.end_time

The date and time that the event ended.

successful_set[].event.event_scope_code

This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.

  • If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty.

  • If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response.

  • If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.

successful_set[].event.event_type_category

A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.

successful_set[].event.event_type_code

The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

successful_set[].event.last_updated_time

The most recent date and time that the event was updated.

successful_set[].event.region

The Amazon Web Services Region name of the event.

successful_set[].event.service

The Amazon Web Service that is affected by the event. For example, EC2, RDS.

successful_set[].event.start_time

The date and time that the event began.

successful_set[].event.status_code

The most recent status of the event. Possible values are open, closed, and upcoming.

successful_set[].event_description

The most recent description of the event.

Show child fields
successful_set[].event_description.latest_description

The most recent description of the event.

successful_set[].event_metadata

Additional metadata about the event.