Delete Rule

eventbridge_delete_rule

R Documentation

Deletes the specified rule

Description

Deletes the specified rule.

Before you can delete the rule, you must remove all targets, using remove_targets.

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

If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException is returned.

Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These rules are created by those other Amazon Web Services services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule.

Usage

eventbridge_delete_rule(Name, EventBusName, Force)

Arguments

Name	[required] The name of the rule.
EventBusName	The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
Force	If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify Force as True to delete the rule. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using describe_rule or list_rules and checking the ManagedBy field of the response.

Value

An empty list.

Request syntax

svc$delete_rule(
  Name = "string",
  EventBusName = "string",
  Force = TRUE|FALSE
)