Amazon Health Dashboard · JSON Structure

Health Entity Aggregate Structure

The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.

Type: object Properties: 2
Health MonitoringNotificationsOperationsService Status

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

Properties

eventArn count

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-entity-aggregate-structure.json",
  "name": "EntityAggregate",
  "description": "The number of entities that are affected by one or more events. Returned by the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEntityAggregates.html\">DescribeEntityAggregates</a> operation.",
  "type": "object",
  "properties": {
    "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>"
        }
      ]
    },
    "count": {
      "allOf": [
        {
          "$ref": "#/components/schemas/count"
        },
        {
          "description": "The number of entities that match the criteria for the specified events."
        }
      ]
    }
  }
}