Amazon CloudWatch Events
API Reference (API Version 2015-10-07)

ListTagsForResource

Displays the tags associated with a CloudWatch Events resource. In CloudWatch Events, rules can be tagged.

Request Syntax

{ "ResourceARN": "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 Events rule for which you want to view tags.

Type: String

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

Required: Yes

Response Syntax

{ "Tags": [ { "Key": "string", "Value": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Tags

The list of tag keys and values associated with the rule you specified

Type: Array of Tag objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400

Example

Removes two tags from a CloudWatch Events 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.ListTagsForResource { "ResourceARN": "arn:aws:events:us-west-1:123456789012:rule/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> { "Tags": [ { "Key": "Stack", "Value": "Prod" }, { "Key": "CostCenter", "Value": "12345" } ] }

See Also

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