DescribeEventDetailsForOrganization
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.
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.
Request Syntax
{
"locale": "string
",
"organizationEventDetailFilters": [
{
"awsAccountId": "string
",
"eventArn": "string
"
}
]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- locale
-
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 256.
Pattern:
.{2,256}
Required: No
- organizationEventDetailFilters
-
A set of JSON elements that includes the
awsAccountId
and theeventArn
.Type: Array of EventAccountFilter objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
Response Syntax
{
"failedSet": [
{
"awsAccountId": "string",
"errorMessage": "string",
"errorName": "string",
"eventArn": "string"
}
],
"successfulSet": [
{
"awsAccountId": "string",
"event": {
"arn": "string",
"availabilityZone": "string",
"endTime": number,
"eventScopeCode": "string",
"eventTypeCategory": "string",
"eventTypeCode": "string",
"lastUpdatedTime": number,
"region": "string",
"service": "string",
"startTime": number,
"statusCode": "string"
},
"eventDescription": {
"latestDescription": "string"
},
"eventMetadata": {
"string" : "string"
}
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- failedSet
-
Error messages for any events that could not be retrieved.
Type: Array of OrganizationEventDetailsErrorItem objects
- successfulSet
-
Information about the events that could be retrieved.
Type: Array of OrganizationEventDetails objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- UnsupportedLocale
-
The specified locale is not supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: