Skip to content
AWS for Query.Farm

aws.health.describe_event_details_for_organization

Example SQL Queries

SELECT * FROM
aws.health.describe_event_details_for_organization
WHERE
"organization_event_detail_filters" = 'VALUE';

Description

Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in your organization. This information includes standard event data (such as the Amazon Web Services Region and service), an event description, and (depending on the event) possible metadata. This operation doesn't return affected entities, such as the resources related to the event. To return affected entities, use the DescribeAffectedEntitiesForOrganization operation.

Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.

When you call the DescribeEventDetailsForOrganization operation, specify the organizationEventDetailFilters object in the request. Depending on the Health event type, note the following differences:

  • To return event details for a public event, you must specify a null value for the awsAccountId parameter. If you specify an account ID for a public event, Health returns an error message because public events aren't specific to an account.

  • To return event details for an event that is specific to an account in your organization, you must specify the awsAccountId parameter in the request. If you don't specify an account ID, Health returns an error message because the event is specific to an account in your organization.

For more information, see Event.

This operation doesn't support resource-level permissions. You can't 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
organization_event_detail_filters Required Input Column

A set of JSON elements that includes the awsAccountId and the eventArn.

STRUCT(
    "event_arn" VARCHAR,
    "aws_account_id" VARCHAR
)[]
Show child fields
organization_event_detail_filters[]
Show child fields
organization_event_detail_filters[].aws_account_id

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

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

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(
    "aws_account_id" VARCHAR,
    "event_arn" VARCHAR,
    "error_name" VARCHAR,
    "error_message" VARCHAR
)[]
Show child fields
failed_set[]
Show child fields
failed_set[].aws_account_id

Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.

failed_set[].error_message

A message that describes the error.

If you call the DescribeEventDetailsForOrganization operation and receive one of the following errors, follow the recommendations in the message:

  • We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an Amazon Web Services account ID in the request.

  • We couldn't find an account specific event for the specified Amazon Web Services account. To find an event that is public, you must enter a null value for the Amazon Web Services account ID in the request.

  • Your Amazon Web Services account doesn't include the Amazon Web Services Support plan required to use the Health API. You must have either a Business, Enterprise On-Ramp, or Enterprise Support plan.

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(
    "aws_account_id" VARCHAR,
    "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[].aws_account_id

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

successful_set[].event

Summary information about an Health event.

Health events can be public or account-specific:

  • Public events might be service events that are not specific to an Amazon Web Services account. For example, if there is an issue with an Amazon Web Services Region, Health provides information about the event, even if you don't use services or resources in that Region.

  • Account-specific events are specific to either your Amazon Web Services account or an account in your organization. For example, if there's an issue with Amazon Elastic Compute Cloud in a Region that you use, Health provides information about the event and the affected resources in the account.

You can determine if an event is public or account-specific by using the eventScopeCode parameter. For more information, see eventScopeCode.

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 detailed description of the event. Included in the information returned by the DescribeEventDetails operation.

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.