UntagResource
Removes one or more tags from the specified resource. Currently, alarms, dashboards, metric streams and Contributor Insights rules support tagging.
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 CloudWatch resource that you're removing tags from.
The ARN format of an alarm is
arn:aws:cloudwatch:Region:account-id:alarm:alarm-nameThe ARN format of a Contributor Insights rule is
arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-nameThe ARN format of a dashboard is
arn:aws:cloudwatch::account-id:dashboard/dashboard-nameThe ARN format of a metric stream is
arn:aws:cloudwatch:Region:account-id:metric-stream/metric-stream-nameFor more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
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 Error Types.
- ConcurrentModificationException
-
More than one process tried to modify a resource at the same time.
HTTP Status Code: 429
- ConflictException
-
This operation attempted to create a resource that already exists.
HTTP Status Code: 409
- InternalServiceError
-
Request processing has failed due to some unknown error, exception, or failure.
- Message
HTTP Status Code: 500
- InvalidParameterValue
-
The value of an input parameter is bad or out-of-range.
- message
HTTP Status Code: 400
- ResourceNotFoundException
-
The named resource does not exist.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: