:doc:`UserNotifications <../../notifications>` / Paginator / ListManagedNotificationEvents

*****************************
ListManagedNotificationEvents
*****************************



.. py:class:: UserNotifications.Paginator.ListManagedNotificationEvents

  ::

    
    paginator = client.get_paginator('list_managed_notification_events')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`UserNotifications.Client.list_managed_notification_events`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListManagedNotificationEvents>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          startTime=datetime(2015, 1, 1),
          endTime=datetime(2015, 1, 1),
          locale='de_DE'|'en_CA'|'en_US'|'en_UK'|'es_ES'|'fr_CA'|'fr_FR'|'id_ID'|'it_IT'|'ja_JP'|'ko_KR'|'pt_BR'|'tr_TR'|'zh_CN'|'zh_TW',
          source='string',
          organizationalUnitId='string',
          relatedAccount='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type startTime: datetime
    :param startTime: 

      The earliest time of events to return from this call.

      

    
    :type endTime: datetime
    :param endTime: 

      Latest time of events to return from this call.

      

    
    :type locale: string
    :param locale: 

      The locale code of the language used for the retrieved NotificationEvent. The default locale is English (en_US).

      

    
    :type source: string
    :param source: 

      The Amazon Web Services service the event originates from. For example aws.cloudwatch.

      

    
    :type organizationalUnitId: string
    :param organizationalUnitId: 

      The Organizational Unit Id that an Amazon Web Services account belongs to.

      

    
    :type relatedAccount: string
    :param relatedAccount: 

      The Amazon Web Services account ID associated with the Managed Notification Events.

      

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

      
      ::

        {
            'managedNotificationEvents': [
                {
                    'arn': 'string',
                    'managedNotificationConfigurationArn': 'string',
                    'relatedAccount': 'string',
                    'creationTime': datetime(2015, 1, 1),
                    'notificationEvent': {
                        'schemaVersion': 'v1.0',
                        'sourceEventMetadata': {
                            'eventOriginRegion': 'string',
                            'source': 'string',
                            'eventType': 'string'
                        },
                        'messageComponents': {
                            'headline': 'string'
                        },
                        'eventStatus': 'HEALTHY'|'UNHEALTHY',
                        'notificationType': 'ALERT'|'WARNING'|'ANNOUNCEMENT'|'INFORMATIONAL'
                    },
                    'aggregationEventType': 'AGGREGATE'|'CHILD'|'NONE',
                    'organizationalUnitId': 'string',
                    'aggregationSummary': {
                        'eventCount': 123,
                        'aggregatedBy': [
                            {
                                'name': 'string',
                                'value': 'string'
                            },
                        ],
                        'aggregatedAccounts': {
                            'name': 'string',
                            'count': 123,
                            'sampleValues': [
                                'string',
                            ]
                        },
                        'aggregatedRegions': {
                            'name': 'string',
                            'count': 123,
                            'sampleValues': [
                                'string',
                            ]
                        },
                        'aggregatedOrganizationalUnits': {
                            'name': 'string',
                            'count': 123,
                            'sampleValues': [
                                'string',
                            ]
                        },
                        'additionalSummarizationDimensions': [
                            {
                                'name': 'string',
                                'count': 123,
                                'sampleValues': [
                                    'string',
                                ]
                            },
                        ]
                    },
                    'aggregatedNotificationRegions': [
                        'string',
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **managedNotificationEvents** *(list) --* 

          A list of Managed Notification Events matching the request criteria.

          
          

          - *(dict) --* 

            Describes an overview and metadata for a ManagedNotificationEvent.

            
            

            - **arn** *(string) --* 

              The Amazon Resource Name (ARN) of the ManagedNotificationEvent.

              
            

            - **managedNotificationConfigurationArn** *(string) --* 

              The Amazon Resource Name (ARN) of the ``ManagedNotificationConfiguration``.

              
            

            - **relatedAccount** *(string) --* 

              The account that related to the ``ManagedNotificationEvent``.

              
            

            - **creationTime** *(datetime) --* 

              The creation time of the ``ManagedNotificationEvent``.

              
            

            - **notificationEvent** *(dict) --* 
              

              - **schemaVersion** *(string) --* 

                The schema version of the ``ManagedNotificationEvent``.

                
              

              - **sourceEventMetadata** *(dict) --* 

                Contains metadata about the event that caused the ``ManagedNotificationEvent``.

                
                

                - **eventOriginRegion** *(string) --* 

                  The Region where the notification originated.

                  
                

                - **source** *(string) --* 

                  The source service of the notification.

                   

                  Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, ``aws.ec2`` and ``aws.cloudwatch``. For more information, see `Event delivery from Amazon Web Services services <https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level>`__ in the *Amazon EventBridge User Guide*.

                  
                

                - **eventType** *(string) --* 

                  The event Type of the notification.

                  
            
              

              - **messageComponents** *(dict) --* 

                Contains the headline message component.

                
                

                - **headline** *(string) --* 

                  A sentence long summary. For example, titles or an email subject line.

                  
            
              

              - **eventStatus** *(string) --* 

                The managed notification event status.

                 

                
                * Values: 

                  
                  * ``HEALTHY`` 

                    
                    * All ``EventRules`` are ``ACTIVE``.
                    

                  
                   
                  * ``UNHEALTHY`` 

                    
                    * Some ``EventRules`` are ``ACTIVE`` and some are ``INACTIVE``.
                    

                  
                  

                
                

                
              

              - **notificationType** *(string) --* 

                The Type of event causing the notification.

                 

                
                * Values: 

                  
                  * ``ALERT`` 

                    
                    * A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.
                    

                  
                   
                  * ``WARNING`` 

                    
                    * A notification about an event where an issue is about to arise. For example, something is approaching a threshold.
                    

                  
                   
                  * ``ANNOUNCEMENT`` 

                    
                    * A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.
                    

                  
                   
                  * ``INFORMATIONAL`` 

                    
                    * A notification about informational messages. For example, recommendations, service announcements, or reminders.
                    

                  
                  

                
                

                
          
            

            - **aggregationEventType** *(string) --* 

              The notifications aggregation type.

               

              
              * Values: 

                
                * ``AGGREGATE`` 

                  
                  * The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.
                  

                
                 
                * ``CHILD`` 

                  
                  * Some ``EventRules`` are ``ACTIVE`` and some are ``INACTIVE``. Any call can be run.
                  

                
                 
                * ``NONE`` 

                  
                  * The notification isn't aggregated.
                  

                
                

              
              

              
            

            - **organizationalUnitId** *(string) --* 

              The Organizational Unit Id that an Amazon Web Services account belongs to.

              
            

            - **aggregationSummary** *(dict) --* 

              Provides additional information about the aggregation key.

              
              

              - **eventCount** *(integer) --* 

                Indicates the number of events associated with the aggregation key.

                
              

              - **aggregatedBy** *(list) --* 

                Indicates the criteria or rules by which notifications have been grouped together.

                
                

                - *(dict) --* 

                  Key-value collection that indicate how notifications are grouped.

                  
                  

                  - **name** *(string) --* 

                    Indicates the type of aggregation key.

                    
                  

                  - **value** *(string) --* 

                    Indicates the value associated with the aggregation key name.

                    
              
            
              

              - **aggregatedAccounts** *(dict) --* 

                Indicates the Amazon Web Services accounts in the aggregation key.

                
                

                - **name** *(string) --* 

                  Name of the summarization dimension.

                  
                

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

                  Total number of occurrences for this dimension.

                  
                

                - **sampleValues** *(list) --* 

                  Indicates the sample values found within the dimension.

                  
                  

                  - *(string) --* 
              
            
              

              - **aggregatedRegions** *(dict) --* 

                Indicates the Amazon Web Services Regions in the aggregation key.

                
                

                - **name** *(string) --* 

                  Name of the summarization dimension.

                  
                

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

                  Total number of occurrences for this dimension.

                  
                

                - **sampleValues** *(list) --* 

                  Indicates the sample values found within the dimension.

                  
                  

                  - *(string) --* 
              
            
              

              - **aggregatedOrganizationalUnits** *(dict) --* 

                Indicates the collection of organizational units that are involved in the aggregation key.

                
                

                - **name** *(string) --* 

                  Name of the summarization dimension.

                  
                

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

                  Total number of occurrences for this dimension.

                  
                

                - **sampleValues** *(list) --* 

                  Indicates the sample values found within the dimension.

                  
                  

                  - *(string) --* 
              
            
              

              - **additionalSummarizationDimensions** *(list) --* 

                List of additional dimensions used to group and summarize data.

                
                

                - *(dict) --* 

                  Provides an overview of how data is summarized across different dimensions.

                  
                  

                  - **name** *(string) --* 

                    Name of the summarization dimension.

                    
                  

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

                    Total number of occurrences for this dimension.

                    
                  

                  - **sampleValues** *(list) --* 

                    Indicates the sample values found within the dimension.

                    
                    

                    - *(string) --* 
                
              
            
          
            

            - **aggregatedNotificationRegions** *(list) --* 

              The list of the regions where the aggregated notifications in this ``NotificationEvent`` originated.

              
              

              - *(string) --* 
          
        
      
        

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

          A token to resume pagination.

          
    