TagResourceCommand

Suggest an Edit

Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags  in the Billing and Cost Management and Cost Management User Guide.

Example Syntax

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

import { KinesisVideoClient, TagResourceCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import
// const { KinesisVideoClient, TagResourceCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import
const client = new KinesisVideoClient(config);
const input = { // TagResourceInput
  ResourceARN: "STRING_VALUE", // required
  Tags: [ // TagList // required
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
};
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 Amazon Resource Name (ARN) of the signaling channel to which you want to add tags.

Tags
Required
Tag[] | undefined

A list of tags to associate with the specified signaling channel. Each tag is a key-value pair.

TagResourceCommand Output

See TagResourceCommandOutput for details

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

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have required permissions to perform this operation.

ClientLimitExceededException
client

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

InvalidArgumentException
client

The value for this input parameter is invalid.

ResourceNotFoundException
client

Amazon Kinesis Video Streams can't find the stream that you specified.

TagsPerResourceExceededLimitException
client

You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags.

KinesisVideoServiceException
Base exception class for all service exceptions from KinesisVideo service.