Amazon Health Dashboard · Schema
DescribeAffectedEntitiesForOrganizationResponse
DescribeAffectedEntitiesForOrganizationResponse schema from Amazon Health Dashboard API
Health MonitoringNotificationsOperationsService Status
Properties
| Name | Type | Description |
|---|---|---|
| entities | object | |
| failedSet | object | |
| nextToken | object |
JSON Schema
{
"$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-response-schema.json",
"title": "DescribeAffectedEntitiesForOrganizationResponse",
"description": "DescribeAffectedEntitiesForOrganizationResponse schema from Amazon Health Dashboard API",
"type": "object",
"properties": {
"entities": {
"allOf": [
{
"$ref": "#/components/schemas/EntityList"
},
{
"description": "A JSON set of elements including the <code>awsAccountId</code> and its <code>entityArn</code>, <code>entityValue</code> and its <code>entityArn</code>, <code>lastUpdatedTime</code>, and <code>statusCode</code>."
}
]
},
"failedSet": {
"allOf": [
{
"$ref": "#/components/schemas/DescribeAffectedEntitiesForOrganizationFailedSet"
},
{
"description": "A JSON set of elements of the failed response, including the <code>awsAccountId</code>, <code>errorMessage</code>, <code>errorName</code>, and <code>eventArn</code>."
}
]
},
"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."
}
]
}
}
}