UserNotifications / Client / update_event_rule

update_event_rule#

UserNotifications.Client.update_event_rule(**kwargs)#

Updates an existing EventRule.

See also: AWS API Documentation

Request Syntax

response = client.update_event_rule(
    arn='string',
    eventPattern='string',
    regions=[
        'string',
    ]
)
Parameters:

  • arn (string) –

    [REQUIRED]

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

  • eventPattern (string) –

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

    For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

  • regions (list) –

    A list of AWS Regions that sends events to this EventRule.

    • (string) –

Return type:

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

          Describes EventRule status information.

          • 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

  • UserNotifications.Client.exceptions.AccessDeniedException

  • UserNotifications.Client.exceptions.ValidationException

  • UserNotifications.Client.exceptions.InternalServerException

  • UserNotifications.Client.exceptions.ThrottlingException

  • UserNotifications.Client.exceptions.ConflictException

  • UserNotifications.Client.exceptions.ResourceNotFoundException