Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeEntityAggregates

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

Request Syntax


{
   "eventArns": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

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"

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Length Constraints: Maximum length of 1600.

Pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}

Required: No

Response Syntax


{
   "entityAggregates": [ 
      { 
         "count": number,
         "eventArn": "string",
         "statuses": { 
            "string" : number 
         }
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

entityAggregates

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

Type: Array of EntityAggregate objects

Errors

For information about the errors that are common to all actions, see Common Errors.