Skip to content

EntityAggregate

Source code in docs_src/capo_health/types/entity_aggregate.py
class EntityAggregate(TypedDict, closed=True):
    event_arn: NotRequired["capo_health.types.event_arn.eventArn"]
    """<p>The unique identifier for the event. The event ARN has the <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i> </code> format.</p> <p>For example, an event ARN might look like the following:</p> <p> <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code> </p>"""
    count: "capo_health.types.count.count"
    """<p>The number of entities that match the criteria for the specified events.</p>"""
    statuses: NotRequired["capo_health.types.entity_statuses.entityStatuses"]
    """<p>The number of affected entities aggregated by the entity status codes.</p>"""

count instance-attribute

count: count

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

event_arn instance-attribute

event_arn: NotRequired[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

statuses instance-attribute

statuses: NotRequired[entityStatuses]

The number of affected entities aggregated by the entity status codes.