Amazon Health Dashboard · JSON Structure

Health Organization Affected Entities Error Item Structure

Error information returned when a DescribeAffectedEntitiesForOrganization operation can't find or process a specific entity.

Type: object Properties: 4
Health MonitoringNotificationsOperationsService Status

OrganizationAffectedEntitiesErrorItem is a JSON Structure definition published by Amazon Health Dashboard, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

awsAccountId eventArn errorName errorMessage

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-health-dashboard/refs/heads/main/json-structure/health-organization-affected-entities-error-item-structure.json",
  "name": "OrganizationAffectedEntitiesErrorItem",
  "description": "Error information returned when a <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html\">DescribeAffectedEntitiesForOrganization</a> operation can't find or process a specific entity.",
  "type": "object",
  "properties": {
    "awsAccountId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/accountId"
        },
        {
          "description": "The 12-digit Amazon Web Services account numbers that contains the affected entities."
        }
      ]
    },
    "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": "The unique identifier for the event type. The format is <code>AWS_SERVICE_DESCRIPTION</code>. For example, <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code>."
        }
      ]
    }
  }
}