OrganizationEntityAggregate
The aggregate results of entities affected by the specified event in your organization. The results are aggregated by the entity status codes for the specified set of accountsIDs.
Contents
- accounts
-
A list of entity aggregates for each of the specified accounts in your organization that are affected by a specific event. If there are no
awsAccountIds
provided in the request, this field will be empty in the response.Type: Array of AccountEntityAggregate objects
Required: No
- count
-
The number of entities for the organization that match the filter criteria for the specified events.
Type: Integer
Required: No
- eventArn
-
A list of event ARNs (unique identifiers). For example:
"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"
Type: String
Length Constraints: Maximum length of 1600.
Pattern:
arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}
Required: No
- statuses
-
The number of affected entities aggregated by the entitiy status codes.
Type: String to integer map
Valid Keys:
IMPAIRED | UNIMPAIRED | UNKNOWN | PENDING | RESOLVED
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: