:doc:`UserNotifications <../../notifications>` / Client / update_event_rule

*****************
update_event_rule
*****************



.. py:method:: UserNotifications.Client.update_event_rule(**kwargs)

  

  Updates an existing ``EventRule``.

  

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


  **Request Syntax**
  ::

    response = client.update_event_rule(
        arn='string',
        eventPattern='string',
        regions=[
            'string',
        ]
    )
    
  :type arn: string
  :param arn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) to use to update the ``EventRule``.

    

  
  :type eventPattern: string
  :param eventPattern: 

    An additional event pattern used to further filter the events this ``EventRule`` receives.

     

    For more information, see `Amazon EventBridge event patterns <https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html>`__ in the *Amazon EventBridge User Guide.*

    

  
  :type regions: list
  :param regions: 

    A list of Amazon Web Services Regions that sends events to this ``EventRule``.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'arn': 'string',
          'notificationConfigurationArn': 'string',
          'statusSummaryByRegion': {
              'string': {
                  'status': 'ACTIVE'|'INACTIVE'|'CREATING'|'UPDATING'|'DELETING',
                  'reason': 'string'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The Amazon Resource Name (ARN) to use to update the ``EventRule``.

        
      

      - **notificationConfigurationArn** *(string) --* 

        The ARN of the ``NotificationConfiguration``.

        
      

      - **statusSummaryByRegion** *(dict) --* 

        The status of the action by Region.

        
        

        - *(string) --* 
          

          - *(dict) --* 

            Provides additional information about the current ``EventRule`` status.

            
            

            - **status** *(string) --* 

              The status of the ``EventRule``.

               

              
              * Values: 

                
                * ``ACTIVE`` 

                  
                  * The ``EventRule`` can process events.
                  

                
                 
                * ``INACTIVE`` 

                  
                  * The ``EventRule`` may be unable to process events.
                  

                
                 
                * ``CREATING`` 

                  
                  * The ``EventRule`` is being created. Only ``GET`` and ``LIST`` calls can be run.
                  

                
                 
                * ``UPDATING`` 

                  
                  * The ``EventRule`` is being updated. Only ``GET`` and ``LIST`` calls can be run.
                  

                
                 
                * ``DELETING`` 

                  
                  * The ``EventRule`` is being deleted. Only ``GET`` and ``LIST`` calls can be run.
                  

                
                

              
              

              
            

            - **reason** *(string) --* 

              A human-readable reason for ``EventRuleStatus``.

              
        
    
  
  
  **Exceptions**
  
  *   :py:class:`UserNotifications.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`UserNotifications.Client.exceptions.ValidationException`

  
  *   :py:class:`UserNotifications.Client.exceptions.InternalServerException`

  
  *   :py:class:`UserNotifications.Client.exceptions.ConflictException`

  
  *   :py:class:`UserNotifications.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`UserNotifications.Client.exceptions.ThrottlingException`

  