TagResource
Assigns one or more tags (key-value pairs) to the specified Amazon Location Service resource.
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.
You can use the TagResource
operation with an Amazon Location Service
resource that already has tags. If you specify a new tag key for the resource, this tag
is appended to the tags already associated with the resource. If you specify a tag key
that's already associated with the resource, the new tag value that you specify replaces
the previous value for that tag.
You can associate up to 50 tags with a resource.
Request Syntax
POST /tags/ResourceArn
HTTP/1.1
Content-type: application/json
{
"Tags": {
"string
" : "string
"
}
}
URI Request Parameters
The request uses the following URI parameters.
- ResourceArn
-
The Amazon Resource Name (ARN) of the resource whose tags you want to update.
-
Format example:
arn:aws:geo:region:account-id:resourcetype/ExampleResource
Length Constraints: Minimum length of 0. Maximum length of 1600.
Pattern:
arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?
Required: Yes
-
Request Body
The request accepts the following data in JSON format.
- Tags
-
Applies one or more tags to specific resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.
Format:
"key" : "value"
Restrictions:
-
Maximum 50 tags per resource.
-
Each tag key must be unique and must have exactly one associated value.
-
Maximum key length: 128 Unicode characters in UTF-8.
-
Maximum value length: 256 Unicode characters in UTF-8.
-
Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @
-
Cannot use "aws:" as a prefix for a key.
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.
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
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.
- AccessDeniedException
-
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
HTTP Status Code: 403
- InternalServerException
-
The request has failed to process because of an unknown server error, exception, or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource that you've entered was not found in your AWS account.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied because of request throttling.
HTTP Status Code: 429
- ValidationException
-
The input failed to meet the constraints specified by the AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: