TagResource
Adds one or more tag key and value pairs to an AWS Resource Explorer view or index.
Minimum permissions
To call this operation, you must have the following permissions:
-
Action:
resource-explorer-2:TagResource
Resource: The ARN of the specified view or index that you want to tag.
Related operations
-
To remove tags from an index or view, use UntagResource.
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 view or index that you want to attach tags to.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- Tags
-
A list of tag key and value pairs that you want to attach to the specified view or index.
Type: String to string map
Required: No
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 credentials that you used to call this operation don't have the minimum required permissions.
HTTP Status Code: 403
- ConflictException
-
If you attempted to create a view, then the request failed because either you specified parameters that didn’t match the original request, or you attempted to create a view with a name that already exists in this AWS Region.
If you attempted to create an index, then the request failed because either you specified parameters that didn't match the original request, or an index already exists in the current AWS Region.
If you attempted to update an index type to
AGGREGATOR
, then the request failed because you already have anAGGREGATOR
index in a different AWS Region.HTTP Status Code: 409
- InternalServerException
-
The request failed because of internal service error. Try your request again later.
HTTP Status Code: 500
- ThrottlingException
-
The request failed because you exceeded a rate limit for this operation. For more information, see Quotas for Resource Explorer.
HTTP Status Code: 429
- UnauthorizedException
-
The principal making the request isn't permitted to perform the operation.
HTTP Status Code: 401
- ValidationException
-
You provided an invalid value for one of the operation's parameters. Check the syntax for the operation, and try again.
HTTP Status Code: 400
Examples
Example
The following example adds a tag with the key name "environment" and the value "production" to the view specified by its ARN.
Sample Request
POST /tags/arn%3Aaws%3Aresource-explorer-2%3Aus-east-1%3A123456789012%3Aview%2FMy-View%2FEXAMPLE8-90ab-cdef-fedc-EXAMPLE11111 HTTP/1.1
Host: resource-explorer-2.us-east-1.amazonaws.com
X-Amz-Date: 20221101T200059Z
Accept-Encoding: identity
User-Agent: <UserAgentString>
Content-Length: <PayloadSizeBytes>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
{
"Tags": {
"environment": "production"
}
}
Sample Response
HTTP/1.1 200 OK
Date: Tue, 01 Nov 2022 20:00:59 GMT
Content-Type: application/json
Content-Length: <PayloadSizeBytes>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: