Skip to content
AWS for Query.Farm

aws.health.describe_events

Example SQL Queries

SELECT * FROM
aws.health.describe_events;

Description

Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.

If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent event.

  • When you call the DescribeEvents operation and specify an entity for the entityValues parameter, Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event.

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

Table Definition

Column NameColumn Data Type
filter Input Column

Values to narrow the results returned.

STRUCT(
    "event_arns" VARCHAR[],
    "event_type_codes" VARCHAR[],
    "services" VARCHAR[],
    "regions" VARCHAR[],
    "availability_zones" VARCHAR[],
    "start_times" STRUCT(
        "from" TIMESTAMP_S,
        "to" TIMESTAMP_S
    )[],
    "end_times" STRUCT(
        "from" TIMESTAMP_S,
        "to" TIMESTAMP_S
    )[],
    "last_updated_times" STRUCT(
        "from" TIMESTAMP_S,
        "to" TIMESTAMP_S
    )[],
    "entity_arns" VARCHAR[],
    "entity_values" VARCHAR[],
    "event_type_categories" VARCHAR[],
    "tags" MAP(VARCHAR, VARCHAR)[],
    "event_status_codes" VARCHAR[]
)
Show child fields
filter.availability_zones[]
filter.end_times[]
Show child fields
filter.end_times[].from

The starting date and time of a time range.

filter.end_times[].to

The ending date and time of a time range.

filter.entity_arns[]
filter.entity_values[]
filter.event_arns[]
filter.event_status_codes[]
filter.event_type_categories[]
filter.event_type_codes[]
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.regions[]
filter.services[]
filter.start_times[]
Show child fields
filter.start_times[].from

The starting date and time of a time range.

filter.start_times[].to

The ending date and time of a time range.

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.

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
availability_zone

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

VARCHAR
end_time

The date and time that the event ended.

TIMESTAMP_S
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.

VARCHAR
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.

VARCHAR
event_type_code

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

VARCHAR
last_updated_time

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

TIMESTAMP_S
region

The Amazon Web Services Region name of the event.

VARCHAR
service

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

VARCHAR
start_time

The date and time that the event began.

TIMESTAMP_S
status_code

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

VARCHAR