{
"$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-affected-entity-schema.json",
"title": "AffectedEntity",
"description": "Information about an entity that is affected by a Health event.",
"type": "object",
"properties": {
"entityArn": {
"allOf": [
{
"$ref": "#/components/schemas/entityArn"
},
{
"description": "The unique identifier for the entity. Format: arn:aws:health:entity-region:aws-account:entity/entity-id . Example: arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K "
}
]
},
"eventArn": {
"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
IMPAIRED, UNIMPAIRED, and UNKNOWN."
}
]
},
"tags": {
"allOf": [
{
"$ref": "#/components/schemas/tagSet"
},
{
"description": "A map of entity tags attached to the affected entity.
Currently, the tags property isn't supported.