Amazon EventBridge
API Reference (API Version 2015-10-07)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

UntagResource

Removes one or more tags from the specified EventBridge resource. In EventBridge, rules can be tagged.

Request Syntax

{ "ResourceARN": "string", "TagKeys": [ "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.

ResourceARN

The ARN of the rule that you're removing tags from.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: Yes

TagKeys

The list of tag keys to remove from the resource.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 128.

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 resource.

HTTP Status Code: 400

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

ManagedRuleException

An AWS service created this rule on behalf of your account. That service manages it. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You can't modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified doesn't exist.

HTTP Status Code: 400

Example

Removes two tags from a rule

The following is an example of an UntagResource 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.UntagResource { "ResourceARN": "arn:aws:events:us-west-1:123456789012:rule/test", "TagKeys": [ "CostCenter", "Team" ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: