Describe Entity Aggregates For Organization

health_describe_entity_aggregates_for_organization

R Documentation

Returns a list of entity aggregates for your Organizations that are affected by each of the specified events¶

Description¶

Returns a list of entity aggregates for your Organizations that are affected by each of the specified events.

Usage¶

health_describe_entity_aggregates_for_organization(eventArns,
  awsAccountIds)

Arguments¶

eventArns

[required] 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"⁠

awsAccountIds

A list of 12-digit Amazon Web Services account numbers that contains the affected entities.

Value¶

A list with the following syntax:

list(
  organizationEntityAggregates = list(
    list(
      eventArn = "string",
      count = 123,
      statuses = list(
        123
      ),
      accounts = list(
        list(
          accountId = "string",
          count = 123,
          statuses = list(
            123
          )
        )
      )
    )
  )
)

Request syntax¶

svc$describe_entity_aggregates_for_organization(
  eventArns = list(
    "string"
  ),
  awsAccountIds = list(
    "string"
  )
)