EntityAggregate - AWS Health
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

EntityAggregate

The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.

Contents

count

The number of entities that match the criteria for the specified events.

Type: Integer

Required: No

eventArn

The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.

For example, an event ARN might look like the following:

arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

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 entity 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: