Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeEntityAggregatesForOrganization

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

Request Syntax


{
   "awsAccountIds": [ "string" ],
   "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.

awsAccountIds

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

Type: Array of strings

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

Length Constraints: Maximum length of 12.

Pattern: ^\S+$

Required: No

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 25 items.

Length Constraints: Maximum length of 1600.

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

Required: Yes

Response Syntax


{
   "organizationEntityAggregates": [ 
      { 
         "accounts": [ 
            { 
               "accountId": "string",
               "count": number,
               "statuses": { 
                  "string" : number 
               }
            }
         ],
         "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.

organizationEntityAggregates

The list of entity aggregates for each of the specified accounts that are affected by each of the specified events.

Type: Array of OrganizationEntityAggregate objects

Errors

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