EventBridge / Client / put_rule

put_rule#

EventBridge.Client.put_rule(**kwargs)#

Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule.

A single rule watches for events from a single event bus. Events generated by Amazon Web Services services go to your account’s default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus.

If you are updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead, they are replaced with null values.

When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect.

A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.

When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions.

If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.

Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.

To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.

An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets.

Request Syntax

response = client.put_rule(
    Name='string',
    ScheduleExpression='string',
    EventPattern='string',
    State='ENABLED'|'DISABLED'|'ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS',
    Description='string',
    RoleArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    EventBusName='string'
)

Parameters:

Name (string) –
[REQUIRED]

The name of the rule that you are creating or updating.
ScheduleExpression (string) – The scheduling expression. For example, “cron(0 20 * * ? *)” or “rate(5 minutes)”.
EventPattern (string) – The event pattern. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide .
State (string) –
The state of the rule.

Valid values include:
- DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
- ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.
- ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail. Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide . This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.
Description (string) – A description of the rule.
RoleArn (string) –
The Amazon Resource Name (ARN) of the IAM role associated with the rule.

If you’re setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.
Tags (list) –
The list of key-value pairs to associate with the rule.
- (dict) –
  
  A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.
  - Key (string) – [REQUIRED]
    
    A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
  - Value (string) – [REQUIRED]
    
    The value for the specified tag key.
EventBusName (string) – The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.

Return type:

dict

Returns:

Response Syntax

{
    'RuleArn': 'string'
}

Response Structure

(dict) –
- RuleArn (string) –
  
  The Amazon Resource Name (ARN) of the rule.

Exceptions

EventBridge.Client.exceptions.InvalidEventPatternException
EventBridge.Client.exceptions.LimitExceededException
EventBridge.Client.exceptions.ConcurrentModificationException
EventBridge.Client.exceptions.ManagedRuleException
EventBridge.Client.exceptions.InternalException
EventBridge.Client.exceptions.ResourceNotFoundException