TagDeliveryStreamCommand

Suggest an Edit

Adds or updates tags for the specified Firehose stream. A tag is a key-value pair 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. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see Using Cost Allocation Tags  in the Amazon Web Services Billing and Cost Management User Guide.

Each Firehose stream can have up to 50 tags.

This operation has a limit of five transactions per second per account.

Example Syntax

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

import { FirehoseClient, TagDeliveryStreamCommand } from "@aws-sdk/client-firehose"; // ES Modules import
// const { FirehoseClient, TagDeliveryStreamCommand } = require("@aws-sdk/client-firehose"); // CommonJS import
const client = new FirehoseClient(config);
const input = { // TagDeliveryStreamInput
  DeliveryStreamName: "STRING_VALUE", // required
  Tags: [ // TagDeliveryStreamInputTagList // required
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE",
    },
  ],
};
const command = new TagDeliveryStreamCommand(input);
const response = await client.send(command);
// {};

TagDeliveryStreamCommand Input

See TagDeliveryStreamCommandInput for more details

Parameter
Type
Description
DeliveryStreamName
Required
string | undefined

The name of the Firehose stream to which you want to add the tags.

Tags
Required
Tag[] | undefined

A set of key-value pairs to use to create the tags.

TagDeliveryStreamCommand Output

See TagDeliveryStreamCommandOutput for details

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

Throws

Name
Fault
Details
InvalidArgumentException
client

The specified input parameter has a value that is not valid.

LimitExceededException
client

You have already reached the limit for a requested resource.

ResourceInUseException
client

The resource is already in use and not available for this operation.

ResourceNotFoundException
client

The specified resource could not be found.

FirehoseServiceException
Base exception class for all service exceptions from Firehose service.