disable_rule

disable_rule(**kwargs)

Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.

When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect.

See also: AWS API Documentation

Request Syntax

response = client.disable_rule(
    Name='string',
    EventBusName='string'
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the rule.

  • EventBusName (string) -- The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
Returns

None

Exceptions

  • EventBridge.Client.exceptions.ResourceNotFoundException
  • EventBridge.Client.exceptions.ConcurrentModificationException
  • EventBridge.Client.exceptions.ManagedRuleException
  • EventBridge.Client.exceptions.InternalException