Skip to content

OrganizationEntityAggregate

Source code in docs_src/capo_health/types/organization_entity_aggregate.py
class OrganizationEntityAggregate(TypedDict, closed=True):
    event_arn: NotRequired["capo_health.types.event_arn.eventArn"]
    """<p>A list of event ARNs (unique identifiers). For example: <code>"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"</code> </p>"""
    count: "capo_health.types.count.count"
    """<p>The number of entities for the organization that match the filter criteria for the specified events.</p>"""
    statuses: NotRequired["capo_health.types.entity_statuses.entityStatuses"]
    """<p>The number of affected entities aggregated by the entitiy status codes.</p>"""
    accounts: NotRequired[
        "capo_health.types.account_entity_aggregates_list.AccountEntityAggregatesList"
    ]
    """<p>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 <code>awsAccountIds</code> provided in the request, this field will be empty in the response.</p>"""

accounts instance-attribute

accounts: NotRequired[AccountEntityAggregatesList]

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.

count instance-attribute

count: count

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

event_arn instance-attribute

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

statuses instance-attribute

statuses: NotRequired[entityStatuses]

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