DescribeAffectedEntitiesForOrganizationRequest

DescribeAffectedEntitiesForOrganizationRequest schema from Amazon Health Dashboard API

Health MonitoringNotificationsOperationsService Status

Properties

Name Type Description
organizationEntityFilters object
locale object
nextToken object
maxResults object
View JSON Schema on GitHub

JSON Schema

health-describe-affected-entities-for-organization-request-schema.json Raw ↑
{
  "$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-describe-affected-entities-for-organization-request-schema.json",
  "title": "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"
  ]
}