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

******************
DescribeEventTypes
******************



.. py:class:: Health.Paginator.DescribeEventTypes

  ::

    
    paginator = client.get_paginator('describe_event_types')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          filter={
              'eventTypeCodes': [
                  'string',
              ],
              'services': [
                  'string',
              ],
              'eventTypeCategories': [
                  'issue'|'accountNotification'|'scheduledChange'|'investigation',
              ],
              'actionabilities': [
                  'ACTION_REQUIRED'|'ACTION_MAY_BE_REQUIRED'|'INFORMATIONAL',
              ],
              'personas': [
                  'OPERATIONS'|'SECURITY'|'BILLING',
              ]
          },
          locale='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type filter: dict
    :param filter: 

      Values to narrow the results returned.

      

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

        A list of event type codes.

        

      
        - *(string) --* 

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

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

        

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

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

        A list of actionability values to filter event types. Possible values are ``ACTION_REQUIRED``, ``ACTION_MAY_BE_REQUIRED`` and ``INFORMATIONAL``.

        

      
        - *(string) --* 

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

        A list of persona classifications to filter event types. Possible values are ``OPERATIONS``, ``SECURITY``, and ``BILLING``.

        

      
        - *(string) --* 

        
    
    
    :type locale: string
    :param locale: 

      The locale (language) to return information in. English (en) is the default and the only supported value at this time.

      

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

      
      ::

        {
            'eventTypes': [
                {
                    'service': 'string',
                    'code': 'string',
                    'category': 'issue'|'accountNotification'|'scheduledChange'|'investigation',
                    'actionability': 'ACTION_REQUIRED'|'ACTION_MAY_BE_REQUIRED'|'INFORMATIONAL',
                    'personas': [
                        'OPERATIONS'|'SECURITY'|'BILLING',
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **eventTypes** *(list) --* 

          A list of event types that match the filter criteria. Event types have a category ( ``issue``, ``accountNotification``, or ``scheduledChange``), a service (for example, ``EC2``, ``RDS``, ``DATAPIPELINE``, ``BILLING``), and a code (in the format ``AWS_SERVICE_DESCRIPTION ``; for example, ``AWS_EC2_SYSTEM_MAINTENANCE_EVENT``).

          
          

          - *(dict) --* 

            Contains the metadata about a type of event that is reported by Health. The ``EventType`` shows the category, service, and the event type code of the event. For example, an ``issue`` might be the category, ``EC2`` the service, and ``AWS_EC2_SYSTEM_MAINTENANCE_EVENT`` the event type code.

             

            You can use the `DescribeEventTypes <https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html>`__ API operation to return this information about an event.

             

            You can also use the Amazon CloudWatch Events console to create a rule so that you can get notified or take action when Health delivers a specific event to your Amazon Web Services account. For more information, see `Monitor for Health events with Amazon CloudWatch Events <https://docs.aws.amazon.com/health/latest/ug/cloudwatch-events-health.html>`__ in the *Health User Guide*.

            
            

            - **service** *(string) --* 

              The Amazon Web Services service that is affected by the event. For example, ``EC2``, ``RDS``.

              
            

            - **code** *(string) --* 

              The unique identifier for the event type. The format is ``AWS_SERVICE_DESCRIPTION ``; for example, ``AWS_EC2_SYSTEM_MAINTENANCE_EVENT``.

              
            

            - **category** *(string) --* 

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

              
            

            - **actionability** *(string) --* 

              The actionability classification of the event. Possible values are ``ACTION_REQUIRED``, ``ACTION_MAY_BE_REQUIRED`` and ``INFORMATIONAL``. Events with ``ACTION_REQUIRED`` actionability require customer action to resolve or mitigate the event. Events with ``ACTION_MAY_BE_REQUIRED`` actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required. Events with ``INFORMATIONAL`` actionability are provided for awareness and do not require immediate action.

              
            

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

              A list of persona classifications that indicate the target audience for the event. Possible values are ``OPERATIONS``, ``SECURITY``, and ``BILLING``. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.

              
              

              - *(string) --* 
          
        
      
        

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

          A token to resume pagination.

          
    