describe_event_details_for_organization
(**kwargs)¶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.
Note
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:
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.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.
Note
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 .
See also: AWS API Documentation
Request Syntax
response = client.describe_event_details_for_organization(
organizationEventDetailFilters=[
{
'eventArn': 'string',
'awsAccountId': 'string'
},
],
locale='string'
)
[REQUIRED]
A set of JSON elements that includes the awsAccountId
and the eventArn
.
The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations.
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
The 12-digit Amazon Web Services account numbers that contains the affected entities.
dict
Response Syntax
{
'successfulSet': [
{
'awsAccountId': 'string',
'event': {
'arn': 'string',
'service': 'string',
'eventTypeCode': 'string',
'eventTypeCategory': 'issue'|'accountNotification'|'scheduledChange'|'investigation',
'region': 'string',
'availabilityZone': 'string',
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'statusCode': 'open'|'closed'|'upcoming',
'eventScopeCode': 'PUBLIC'|'ACCOUNT_SPECIFIC'|'NONE'
},
'eventDescription': {
'latestDescription': 'string'
},
'eventMetadata': {
'string': 'string'
}
},
],
'failedSet': [
{
'awsAccountId': 'string',
'eventArn': 'string',
'errorName': 'string',
'errorMessage': 'string'
},
]
}
Response Structure
(dict) --
successfulSet (list) --
Information about the events that could be retrieved.
(dict) --
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 Amazon Web Services account numbers that contains the affected entities.
event (dict) --
Summary information about an Health event.
Health events can be public or account-specific:
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. 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
service (string) --
The Amazon Web Services 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) --
A list of event type category codes. Possible values are issue
, accountNotification
, or scheduledChange
. Currently, the investigation
value isn't supported at this time.
region (string) --
The Amazon Web Services Region name of the event.
availabilityZone (string) --
The Amazon Web Services Availability Zone of the event. For example, us-east-1a.
startTime (datetime) --
The date and time that the event began.
endTime (datetime) --
The date and time that the event ended.
lastUpdatedTime (datetime) --
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 Health event is a public Amazon Web Services service event or an account-specific event.
eventScopeCode
value is PUBLIC
, then the affectedAccounts
value is always empty.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.eventScopeCode
value is NONE
, then the eventArn
that you specified in the request is invalid or doesn't exist.eventDescription (dict) --
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 (dict) --
Additional metadata about the event.
failedSet (list) --
Error messages for any events that could not be retrieved.
(dict) --
Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.
awsAccountId (string) --
Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.
eventArn (string) --
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
errorName (string) --
The name of the error.
errorMessage (string) --
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:
Exceptions
Health.Client.exceptions.UnsupportedLocale