Amazon Health Dashboard · JSON Structure

Health Describe Affected Entities For Organization Request Structure

DescribeAffectedEntitiesForOrganizationRequest schema from Amazon Health Dashboard API

Type: object Properties: 4 Required: 1
Health MonitoringNotificationsOperationsService Status

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

Properties

organizationEntityFilters locale nextToken maxResults

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-describe-affected-entities-for-organization-request-structure.json",
  "name": "DescribeAffectedEntitiesForOrganizationRequest",
  "description": "DescribeAffectedEntitiesForOrganizationRequest schema from Amazon Health Dashboard API",
  "type": "object",
  "properties": {
    "organizationEntityFilters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationEntityFiltersList"
        },
        {
          "description": "A JSON set of elements including the <code>awsAccountId</code> and the <code>eventArn</code>."
        }
      ]
    },
    "locale": {
      "allOf": [
        {
          "$ref": "#/components/schemas/locale"
        },
        {
          "description": "The locale (language) to return information in. English (en) is the default and the only supported value at this time."
        }
      ]
    },
    "nextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/nextToken"
        },
        {
          "description": "If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value."
        }
      ]
    },
    "maxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/maxResultsLowerRange"
        },
        {
          "description": "The maximum number of items to return in one batch, between 10 and 100, inclusive."
        }
      ]
    }
  },
  "required": [
    "organizationEntityFilters"
  ]
}