EventFilter

{
  "$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-event-filter-schema.json",
  "title": "EventFilter",
  "description": "The values to use to filter results from the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html\">DescribeEvents</a> and <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html\">DescribeEventAggregates</a> operations.",
  "type": "object",
  "properties": {
    "eventArns": {
      "allOf": [
        {
          "$ref": "#/components/schemas/eventArnList"
        },
        {
          "description": "A list of event ARNs (unique identifiers). For example: <code>\"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456\", \"arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101\"</code> "
        }
      ]
    },
    "eventTypeCodes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/eventTypeList"
        },
        {
          "description": "A list of unique identifiers for event types. For example, <code>\"AWS_EC2_SYSTEM_MAINTENANCE_EVENT\",\"AWS_RDS_MAINTENANCE_SCHEDULED\".</code> "
        }
      ]
    },
    "services": {
      "allOf": [
        {
          "$ref": "#/components/schemas/serviceList"
        },
        {
          "description": "The Amazon Web Services services associated with the event. For example, <code>EC2</code>, <code>RDS</code>."
        }
      ]
    },
    "regions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/regionList"
        },
        {
          "description": "A list of Amazon Web Services Regions."
        }
      ]
    },
    "availabilityZones": {
      "allOf": [
        {
          "$ref": "#/components/schemas/availabilityZones"
        },
        {
          "description": "A list of Amazon Web Services Availability Zones."
        }
      ]
    },
    "startTimes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/dateTimeRangeList"
        },
        {
          "description": "A list of dates and times that the event began."
        }
      ]
    },
    "endTimes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/dateTimeRangeList"
        },
        {
          "description": "A list of dates and times that the event ended."
        }
      ]
    },
    "lastUpdatedTimes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/dateTimeRangeList"
        },
        {
          "description": "A list of dates and times that the event was last updated."
        }
      ]
    },
    "entityArns": {
      "allOf": [
        {
          "$ref": "#/components/schemas/entityArnList"
        },
        {
          "description": "A list of entity ARNs (unique identifiers)."
        }
      ]
    },
    "entityValues": {
      "allOf": [
        {
          "$ref": "#/components/schemas/entityValueList"
        },
        {
          "description": "A list of entity identifiers, such as EC2 instance IDs (<code>i-34ab692e</code>) or EBS volumes (<code>vol-426ab23e</code>)."
        }
      ]
    },
    "eventTypeCategories": {
      "allOf": [
        {
          "$ref": "#/components/schemas/eventTypeCategoryList"
        },
        {
          "description": "A list of event type category codes. Possible values are <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently, the <code>investigation</code> value isn't supported at this time."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/tagFilter"
        },
        {
          "description": "<p>A map of entity tags attached to the affected entity.</p> <note> <p>Currently, the <code>tags</code> property isn't supported.</p> </note>"
        }
      ]
    },
    "eventStatusCodes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/eventStatusCodeList"
        },
        {
          "description": "A list of event status codes."
        }
      ]
    }
  }
}