UpdateLFTagCommand

Suggest an Edit

Updates the list of possible values for the specified LF-tag key. If the LF-tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - "Update not allowed". Untag the attribute before deleting the LF-tag key's value.

Example Syntax

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

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

UpdateLFTagCommand Input

See UpdateLFTagCommandInput for more details

Parameter
Type
Description
TagKey
Required
string | undefined

The key-name for the LF-tag for which to add or delete values.

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.

TagValuesToAdd
string[] | undefined

A list of LF-tag values to add from the LF-tag.

TagValuesToDelete
string[] | undefined

A list of LF-tag values to delete from the LF-tag.

UpdateLFTagCommand Output

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

ConcurrentModificationException
client

Two processes are trying to modify a resource simultaneously.

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.