UntagDeliveryStreamCommand

Suggest an Edit

Removes tags from the specified Firehose stream. Removed tags are deleted, and you can't recover them after this operation successfully completes.

If you specify a tag that doesn't exist, the operation ignores it.

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, UntagDeliveryStreamCommand } from "@aws-sdk/client-firehose"; // ES Modules import
// const { FirehoseClient, UntagDeliveryStreamCommand } = require("@aws-sdk/client-firehose"); // CommonJS import
const client = new FirehoseClient(config);
const input = { // UntagDeliveryStreamInput
  DeliveryStreamName: "STRING_VALUE", // required
  TagKeys: [ // TagKeyList // required
    "STRING_VALUE",
  ],
};
const command = new UntagDeliveryStreamCommand(input);
const response = await client.send(command);
// {};

UntagDeliveryStreamCommand Input

See UntagDeliveryStreamCommandInput for more details

Parameter
Type
Description
DeliveryStreamName
Required
string | undefined

The name of the Firehose stream.

TagKeys
Required
string[] | undefined

A list of tag keys. Each corresponding tag is removed from the delivery stream.

UntagDeliveryStreamCommand Output

See UntagDeliveryStreamCommandOutput 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.