DeleteLFTagCommand

Suggest an Edit

Deletes the specified LF-tag given a key name. If the input parameter tag key was not found, then the operation will throw an exception. When you delete an LF-tag, the LFTagPolicy attached to the LF-tag becomes invalid. If the deleted LF-tag was still assigned to any resource, the tag policy attach to the deleted LF-tag will no longer be applied to the resource.

Example Syntax

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

import { LakeFormationClient, DeleteLFTagCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import
// const { LakeFormationClient, DeleteLFTagCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import
const client = new LakeFormationClient(config);
const input = { // DeleteLFTagRequest
  CatalogId: "STRING_VALUE",
  TagKey: "STRING_VALUE", // required
};
const command = new DeleteLFTagCommand(input);
const response = await client.send(command);
// {};

DeleteLFTagCommand Input

See DeleteLFTagCommandInput for more details

Parameter
Type
Description
TagKey
Required
string | undefined

The key-name for the LF-tag to delete.

CatalogId
string | undefined

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.

DeleteLFTagCommand Output

See DeleteLFTagCommandOutput for details

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

Throws

Name
Fault
Details
AccessDeniedException
client

Access to a resource was denied.

EntityNotFoundException
client

A specified entity does not exist.

InternalServiceException
server

An internal service error occurred.

InvalidInputException
client

The input provided was not valid.

OperationTimeoutException
client

The operation timed out.

LakeFormationServiceException
Base exception class for all service exceptions from LakeFormation service.