:doc:`Health <../../health>` / Paginator / DescribeEventAggregates

***********************
DescribeEventAggregates
***********************



.. py:class:: Health.Paginator.DescribeEventAggregates

  ::

    
    paginator = client.get_paginator('describe_event_aggregates')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Health.Client.describe_event_aggregates`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          filter={
              'actionabilities': [
                  'ACTION_REQUIRED'|'ACTION_MAY_BE_REQUIRED'|'INFORMATIONAL',
              ],
              'eventArns': [
                  'string',
              ],
              'eventTypeCodes': [
                  'string',
              ],
              'services': [
                  'string',
              ],
              'regions': [
                  'string',
              ],
              'availabilityZones': [
                  'string',
              ],
              'startTimes': [
                  {
                      'from': datetime(2015, 1, 1),
                      'to': datetime(2015, 1, 1)
                  },
              ],
              'endTimes': [
                  {
                      'from': datetime(2015, 1, 1),
                      'to': datetime(2015, 1, 1)
                  },
              ],
              'lastUpdatedTimes': [
                  {
                      'from': datetime(2015, 1, 1),
                      'to': datetime(2015, 1, 1)
                  },
              ],
              'entityArns': [
                  'string',
              ],
              'entityValues': [
                  'string',
              ],
              'eventTypeCategories': [
                  'issue'|'accountNotification'|'scheduledChange'|'investigation',
              ],
              'tags': [
                  {
                      'string': 'string'
                  },
              ],
              'eventStatusCodes': [
                  'open'|'closed'|'upcoming',
              ],
              'personas': [
                  'OPERATIONS'|'SECURITY'|'BILLING',
              ]
          },
          aggregateField='eventTypeCategory',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type filter: dict
    :param filter: 

      Values to narrow the results returned.

      

    
      - **actionabilities** *(list) --* 

        A list of actionability values to filter events. Use this to filter events based on whether they require action ( ``ACTION_REQUIRED``), may require action ( ``ACTION_MAY_BE_REQUIRED``) or are informational ( ``INFORMATIONAL``).

        

      
        - *(string) --* 

        
    
      - **eventArns** *(list) --* 

        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) --* 

        
    
      - **eventTypeCodes** *(list) --* 

        A list of unique identifiers for event types. For example, ``"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".``

        

      
        - *(string) --* 

        
    
      - **services** *(list) --* 

        The Amazon Web Services services associated with the event. For example, ``EC2``, ``RDS``.

        

      
        - *(string) --* 

        
    
      - **regions** *(list) --* 

        A list of Amazon Web Services Regions.

        

      
        - *(string) --* 

        
    
      - **availabilityZones** *(list) --* 

        A list of Amazon Web Services Availability Zones.

        

      
        - *(string) --* 

        
    
      - **startTimes** *(list) --* 

        A list of dates and times that the event began.

        

      
        - *(dict) --* 

          A range of dates and times that is used by the `EventFilter <https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html>`__ and `EntityFilter <https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html>`__ objects. If ``from`` is set and ``to`` is set: match items where the timestamp ( ``startTime``, ``endTime``, or ``lastUpdatedTime``) is between ``from`` and ``to`` inclusive. If ``from`` is set and ``to`` is not set: match items where the timestamp value is equal to or after ``from``. If ``from`` is not set and ``to`` is set: match items where the timestamp value is equal to or before ``to``.

          

        
          - **from** *(datetime) --* 

            The starting date and time of a time range.

            

          
          - **to** *(datetime) --* 

            The ending date and time of a time range.

            

          
        
    
      - **endTimes** *(list) --* 

        A list of dates and times that the event ended.

        

      
        - *(dict) --* 

          A range of dates and times that is used by the `EventFilter <https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html>`__ and `EntityFilter <https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html>`__ objects. If ``from`` is set and ``to`` is set: match items where the timestamp ( ``startTime``, ``endTime``, or ``lastUpdatedTime``) is between ``from`` and ``to`` inclusive. If ``from`` is set and ``to`` is not set: match items where the timestamp value is equal to or after ``from``. If ``from`` is not set and ``to`` is set: match items where the timestamp value is equal to or before ``to``.

          

        
          - **from** *(datetime) --* 

            The starting date and time of a time range.

            

          
          - **to** *(datetime) --* 

            The ending date and time of a time range.

            

          
        
    
      - **lastUpdatedTimes** *(list) --* 

        A list of dates and times that the event was last updated.

        

      
        - *(dict) --* 

          A range of dates and times that is used by the `EventFilter <https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html>`__ and `EntityFilter <https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html>`__ objects. If ``from`` is set and ``to`` is set: match items where the timestamp ( ``startTime``, ``endTime``, or ``lastUpdatedTime``) is between ``from`` and ``to`` inclusive. If ``from`` is set and ``to`` is not set: match items where the timestamp value is equal to or after ``from``. If ``from`` is not set and ``to`` is set: match items where the timestamp value is equal to or before ``to``.

          

        
          - **from** *(datetime) --* 

            The starting date and time of a time range.

            

          
          - **to** *(datetime) --* 

            The ending date and time of a time range.

            

          
        
    
      - **entityArns** *(list) --* 

        A list of entity ARNs (unique identifiers).

        

      
        - *(string) --* 

        
    
      - **entityValues** *(list) --* 

        A list of entity identifiers, such as EC2 instance IDs ( ``i-34ab692e``) or EBS volumes ( ``vol-426ab23e``).

        

      
        - *(string) --* 

        
    
      - **eventTypeCategories** *(list) --* 

        A list of event type category codes. Possible values are ``issue``, ``accountNotification``, or ``scheduledChange``. Currently, the ``investigation`` value isn't supported at this time.

        

      
        - *(string) --* 

        
    
      - **tags** *(list) --* 

        A map of entity tags attached to the affected entity.

         

        .. note::

          

          Currently, the ``tags`` property isn't supported.

          

        

      
        - *(dict) --* 

        
          - *(string) --* 

          
            - *(string) --* 

            
      
    
    
      - **eventStatusCodes** *(list) --* 

        A list of event status codes.

        

      
        - *(string) --* 

        
    
      - **personas** *(list) --* 

        A list of persona values to filter events. Use this to filter events based on their target audience: ``OPERATIONS``, ``SECURITY``, or ``BILLING``.

        

      
        - *(string) --* 

        
    
    
    :type aggregateField: string
    :param aggregateField: **[REQUIRED]** 

      The only currently supported value is ``eventTypeCategory``.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'eventAggregates': [
                {
                    'aggregateValue': 'string',
                    'count': 123
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **eventAggregates** *(list) --* 

          The number of events in each category that meet the optional filter criteria.

          
          

          - *(dict) --* 

            The number of events of each issue type. Returned by the `DescribeEventAggregates <https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html>`__ operation.

            
            

            - **aggregateValue** *(string) --* 

              The issue type for the associated count.

              
            

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

              The number of events of the associated issue type.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    