{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-health-dashboard/refs/heads/main/json-schema/health-organization-event-schema.json", "title": "OrganizationEvent", "description": "Summary information about an event, returned by the DescribeEventsForOrganization operation.", "type": "object", "properties": { "arn": { "allOf": [ { "$ref": "#/components/schemas/eventArn" }, { "description": "
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
AWS_SERVICE_DESCRIPTION. For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT."
}
]
},
"eventTypeCategory": {
"allOf": [
{
"$ref": "#/components/schemas/eventTypeCategory"
},
{
"description": "A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time."
}
]
},
"eventScopeCode": {
"allOf": [
{
"$ref": "#/components/schemas/eventScopeCode"
},
{
"description": "This parameter specifies if the Health event is a public Amazon Web Services 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.
open, closed, and upcoming."
}
]
}
}
}