TagResourceCommand

Suggest an Edit

Adds or updates tags for the AWS resource with the specified ARN.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IvschatClient, TagResourceCommand } from "@aws-sdk/client-ivschat"; // ES Modules import
// const { IvschatClient, TagResourceCommand } = require("@aws-sdk/client-ivschat"); // CommonJS import
const client = new IvschatClient(config);
const input = { // TagResourceRequest
  resourceArn: "STRING_VALUE", // required
  tags: { // Tags // required
    "<keys>": "STRING_VALUE",
  },
};
const command = new TagResourceCommand(input);
const response = await client.send(command);
// {};

TagResourceCommand Input

See TagResourceCommandInput for more details

Parameter
Type
Description
resourceArn
Required
string | undefined

The ARN of the resource to be tagged. The ARN must be URL-encoded.

tags
Required
Record<string, string> | undefined

Array of tags to be added or updated. Array of maps, each of the form string:string (key:value). See Best practices and strategies  in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

TagResourceCommand Output

See TagResourceCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
InternalServerException
server
<p/>
ResourceNotFoundException
client
<p/>
ValidationException
client
<p/>
IvschatServiceException
Base exception class for all service exceptions from Ivschat service.