DeleteRule
Deletes the specified rule.
Before you can delete the rule, you must remove all targets, using RemoveTargets.
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 service on your behalf. These
rules are created by those other Amazon 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.
Request Syntax
{
"EventBusName": "string
",
"Force": boolean
,
"Name": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- EventBusName
-
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
(arn:aws[\w-]*:events:[a-z]{2}-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+
Required: No
- Force
-
If this is a managed rule, created by an Amazon service on your behalf, you must specify
Force
asTrue
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 usingDescribeRule
orListRules
and checking theManagedBy
field of the response.Type: Boolean
Required: No
- Name
-
The name of the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_A-Za-z0-9]+
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConcurrentModificationException
-
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400
- InternalException
-
This exception occurs due to unexpected causes.
HTTP Status Code: 500
- ManagedRuleException
-
This rule was created by an Amazon service on behalf of your account. It is managed by that service. If you see this error in response to
DeleteRule
orRemoveTargets
, you can use theForce
parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by usingDisableRule
,EnableRule
,PutTargets
,PutRule
,TagResource
, orUntagResource
.HTTP Status Code: 400
- ResourceNotFoundException
-
An entity that you specified does not exist.
HTTP Status Code: 400
Examples
Deletes a rule named "test"
The following is an example of a DeleteRule request.
Sample Request
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AWSEvents.DeleteRule
{
"Name": "test"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: