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

TagResource

Adds tags to an AWS IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.

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 ARN of the resource to tag.

Pattern: arn:[^:]*:greengrass:[^:]*:(aws|[0-9]+):(components|deployments|coreDevices):.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

tags

A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.

Type: String to string map

Map Entries: Maximum number of 200 items.

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

Value Length Constraints: 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.

InternalServerException

AWS IoT Greengrass can't process your request right now. Try again later.

retryAfterSeconds: The amount of time to wait before you retry the request.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

resourceId: The ID of the resource that isn't found.
resourceType: The type of the resource that isn't found.

HTTP Status Code: 404

ValidationException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

fields: The list of fields that failed to validate.
reason: The reason for the validation exception.

HTTP Status Code: 400