Describe Entity Aggregates

health_describe_entity_aggregates

R Documentation

Returns the number of entities that are affected by each of the specified events¶

Description¶

Returns the number of entities that are affected by each of the specified events.

Usage¶

health_describe_entity_aggregates(eventArns)

Arguments¶

eventArns

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"⁠

Value¶

A list with the following syntax:

list(
  entityAggregates = list(
    list(
      eventArn = "string",
      count = 123,
      statuses = list(
        123
      )
    )
  )
)

Request syntax¶

svc$describe_entity_aggregates(
  eventArns = list(
    "string"
  )
)