Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

TagResource

Assigns one or more tags (key-value pairs) to the specified resource. Both sinks and links can be tagged.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

Important

Unlike tagging permissions in other AWS services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:ResourceTag permission does not allow you to tag and untag links and sinks.

Request Syntax


PUT /tags/ResourceArn HTTP/1.1
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

ResourceArn

The ARN of the resource that you're adding tags to.

The ARN format of a sink is arn:aws:oam:Region:account-id:sink/sink-id

The ARN format of a link is arn:aws:oam:Region:account-id:link/link-id

For more information about ARN format, see CloudWatch Logs resources and operations.

Pattern: ^arn:(\w|-)+:oam:.+:.+:.+

Required: Yes

Request Body

The request accepts the following data in JSON format.

Tags

The list of key-value pairs to associate with the resource.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

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

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: Yes

Response Syntax


HTTP/1.1 200

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.

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

TooManyTagsException

A resource can have no more than 50 tags.

HTTP Status Code: 400

ValidationException

The value of a parameter in the request caused an error.

HTTP Status Code: 400