UntagResource
Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge, rules and event buses 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 EventBridge resource from which you are removing tags.
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 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 AWS service on behalf of your account. It is managed by that service. If you see this error in response to
DeleteRuleorRemoveTargets, you can use theForceparameter 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
Removes two tags from an EventBridge 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:
