:doc:`Health <../../health>` / Client / describe_entity_aggregates

**************************
describe_entity_aggregates
**************************



.. py:method:: Health.Client.describe_entity_aggregates(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeEntityAggregates>`_  


  **Request Syntax**
  ::

    response = client.describe_entity_aggregates(
        eventArns=[
            'string',
        ]
    )
    
  :type eventArns: list
  :param 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"``

    

  
    - *(string) --* 

    

  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'entityAggregates': [
              {
                  'eventArn': 'string',
                  'count': 123,
                  'statuses': {
                      'string': 123
                  }
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **entityAggregates** *(list) --* 

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

        
        

        - *(dict) --* 

          The number of entities that are affected by one or more events. Returned by the `DescribeEntityAggregates <https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEntityAggregates.html>`__ operation.

          
          

          - **eventArn** *(string) --* 

            The unique identifier for the event. The event ARN has the ``arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID`` format.

             

            For example, an event ARN might look like the following:

             

            ``arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456``

            
          

          - **count** *(integer) --* 

            The number of entities that match the criteria for the specified events.

            
          

          - **statuses** *(dict) --* 

            The number of affected entities aggregated by the entity status codes.

            
            

            - *(string) --* 
              

              - *(integer) --* 
        
      
      
    
  