Amazon Health Dashboard · Schema
OrganizationEventDetailsErrorItem
Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.
Health MonitoringNotificationsOperationsService Status
Properties
| Name | Type | Description |
|---|---|---|
| awsAccountId | object | |
| eventArn | object | |
| errorName | object | |
| errorMessage | object |
JSON Schema
{
"$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-details-error-item-schema.json",
"title": "OrganizationEventDetailsErrorItem",
"description": "Error information returned when a <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html\">DescribeEventDetailsForOrganization</a> operation can't find a specified event.",
"type": "object",
"properties": {
"awsAccountId": {
"allOf": [
{
"$ref": "#/components/schemas/accountId"
},
{
"description": "Error information returned when a <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html\">DescribeEventDetailsForOrganization</a> operation can't find a specified event."
}
]
},
"eventArn": {
"allOf": [
{
"$ref": "#/components/schemas/eventArn"
},
{
"description": "<p>The unique identifier for the event. The event ARN has the <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i> </code> format.</p> <p>For example, an event ARN might look like the following:</p> <p> <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code> </p>"
}
]
},
"errorName": {
"allOf": [
{
"$ref": "#/components/schemas/string"
},
{
"description": "The name of the error."
}
]
},
"errorMessage": {
"allOf": [
{
"$ref": "#/components/schemas/string"
},
{
"description": "<p>A message that describes the error.</p> <p>If you call the <code>DescribeEventDetailsForOrganization</code> operation and receive one of the following errors, follow the recommendations in the message:</p> <ul> <li> <p>We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an Amazon Web Services account ID in the request.</p> </li> <li> <p>We couldn't find an account specific event for the specified Amazon Web Services account. To find an event that is public, you must enter a null value for the Amazon Web Services account ID in the request.</p> </li> <li> <p>Your Amazon Web Services account doesn't include the Amazon Web Services Support plan required to use the Health API. You must have either a Business, Enterprise On-Ramp, or Enterprise Support plan.</p> </li> </ul>"
}
]
}
}
}