[ aws . health ]

describe-event-details-for-organization

Description

Returns detailed information about one or more specified events for one or more accounts in your organization. Information includes standard event data (AWS Region, service, and so on, as returned by DescribeEventsForOrganization ), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the DescribeAffectedEntitiesForOrganization operation.

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

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

  • If the event is public, the awsAccountId parameter must be empty. If you specify an account ID for a public event, then an error message is returned. That’s because the event might apply to all AWS accounts and isn’t specific to an account in your organization.

  • If the event is specific to an account, then you must specify the awsAccountId parameter in the request. If you don’t specify an account ID, an error message returns because the event is specific to an AWS account in your organization.

For more information, see Event .

Note

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-event-details-for-organization
--organization-event-detail-filters <value>
[--locale <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--organization-event-detail-filters (list)

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

(structure)

The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations.

eventArn -> (string)

The unique identifier for the event. Format: arn:aws:health:*event-region* ::event/*SERVICE* /*EVENT_TYPE_CODE* /*EVENT_TYPE_PLUS_ID* `` . Example: ``Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

awsAccountId -> (string)

The 12-digit AWS account numbers that contains the affected entities.

Shorthand Syntax:

eventArn=string,awsAccountId=string ...

JSON Syntax:

[
  {
    "eventArn": "string",
    "awsAccountId": "string"
  }
  ...
]

--locale (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

successfulSet -> (list)

Information about the events that could be retrieved.

(structure)

Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by the DescribeEventDetailsForOrganization operation.

awsAccountId -> (string)

The 12-digit AWS account numbers that contains the affected entities.

event -> (structure)

Summary information about an AWS Health event.

AWS Health events can be public or account-specific:

  • Public events might be service events that are not specific to an AWS account. For example, if there is an issue with an AWS Region, AWS 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 AWS 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, AWS 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 .

arn -> (string)

The unique identifier for the event. Format: arn:aws:health:*event-region* ::event/*SERVICE* /*EVENT_TYPE_CODE* /*EVENT_TYPE_PLUS_ID* `` . Example: ``Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

service -> (string)

The AWS service that is affected by the event. For example, EC2 , RDS .

eventTypeCode -> (string)

The unique identifier for the event type. The format is AWS_*SERVICE* _*DESCRIPTION* `` ; for example, ``AWS_EC2_SYSTEM_MAINTENANCE_EVENT .

eventTypeCategory -> (string)

The category of the event. Possible values are issue , scheduledChange , and accountNotification .

region -> (string)

The AWS region name of the event.

availabilityZone -> (string)

The AWS Availability Zone of the event. For example, us-east-1a.

startTime -> (timestamp)

The date and time that the event began.

endTime -> (timestamp)

The date and time that the event ended.

lastUpdatedTime -> (timestamp)

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

statusCode -> (string)

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

eventScopeCode -> (string)

This parameter specifies if the AWS Health event is a public AWS 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 AWS accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have AWS 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.

eventDescription -> (structure)

The detailed description of the event. Included in the information returned by the DescribeEventDetails operation.

latestDescription -> (string)

The most recent description of the event.

eventMetadata -> (map)

Additional metadata about the event.

key -> (string)

value -> (string)

failedSet -> (list)

Error messages for any events that could not be retrieved.

(structure)

Error information returned when a DescribeEventDetailsForOrganization operation cannot find a specified event.

awsAccountId -> (string)

Error information returned when a DescribeEventDetailsForOrganization operation cannot find a specified event.

eventArn -> (string)

The unique identifier for the event. Format: arn:aws:health:*event-region* ::event/*SERVICE* /*EVENT_TYPE_CODE* /*EVENT_TYPE_PLUS_ID* `` . Example: ``Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

errorName -> (string)

The name of the error.

errorMessage -> (string)

A message that describes the error.