Menu
AWS Resource Groups
Welcome (API Version 2017-11-27)

Tag

Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.

Request Syntax

PUT /resources/Arn/tags HTTP/1.1 Content-type: application/json { "Tags": { "string" : "string" } }

URI Request Parameters

The request requires the following URI parameters.

Arn

The ARN of the resource to which to add tags.

Pattern: arn:aws:resource-groups:[a-z]{2}-[a-z]+-\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\.-]{1,128}

Request Body

The request accepts the following data in JSON format.

Tags

The tags to add to the specified resource. A tag is a string-to-string map of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Type: String to string map

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

Key Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

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

Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Arn": "string", "Tags": { "string" : "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.

Arn

The ARN of the tagged resource.

Type: String

Pattern: arn:aws:resource-groups:[a-z]{2}-[a-z]+-\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\.-]{1,128}

Tags

The tags that have been added to the specified resource.

Type: String to string map

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

Key Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

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

Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Errors

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

BadRequestException

The request does not comply with validation rules that are defined for the request parameters.

HTTP Status Code: 400

ForbiddenException

The caller is not authorized to make the request.

HTTP Status Code: 403

InternalServerErrorException

An internal error occurred while processing the request.

HTTP Status Code: 500

MethodNotAllowedException

The request uses an HTTP method which is not allowed for the specified resource.

HTTP Status Code: 405

NotFoundException

One or more resources specified in the request do not exist.

HTTP Status Code: 404

TooManyRequestsException

The caller has exceeded throttling limits.

HTTP Status Code: 429

See Also

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