Health / Client / describe_entity_aggregates_for_organization
describe_entity_aggregates_for_organization#
- Health.Client.describe_entity_aggregates_for_organization(**kwargs)#
Returns a list of entity aggregates for your Organizations that are affected by each of the specified events.
See also: AWS API Documentation
Request Syntax
response = client.describe_entity_aggregates_for_organization( eventArns=[ 'string', ], awsAccountIds=[ 'string', ] )
- Parameters:
eventArns (list) –
[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"
(string) –
awsAccountIds (list) –
A list of 12-digit Amazon Web Services account numbers that contains the affected entities.
(string) –
- Return type:
dict
- Returns:
Response Syntax
{ 'organizationEntityAggregates': [ { 'eventArn': 'string', 'count': 123, 'statuses': { 'string': 123 }, 'accounts': [ { 'accountId': 'string', 'count': 123, 'statuses': { 'string': 123 } }, ] }, ] }
Response Structure
(dict) –
organizationEntityAggregates (list) –
The list of entity aggregates for each of the specified accounts that are affected by each of the specified events.
(dict) –
The aggregate results of entities affected by the specified event in your organization. The results are aggregated by the entity status codes for the specified set of accountsIDs.
eventArn (string) –
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"
count (integer) –
The number of entities for the organization that match the filter criteria for the specified events.
statuses (dict) –
The number of affected entities aggregated by the entitiy status codes.
(string) –
(integer) –
accounts (list) –
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.(dict) –
The number of entities in an account that are impacted by a specific event aggregated by the entity status codes.
accountId (string) –
The 12-digit Amazon Web Services account numbers that contains the affected entities.
count (integer) –
The number of entities that match the filter criteria for the specified events.
statuses (dict) –
The number of affected entities aggregated by the entity status codes.
(string) –
(integer) –