UpdateLFTagExpressionCommand

Suggest an Edit

Updates the name of the LF-Tag expression to the new description and expression body provided. Updating a LF-Tag expression immediately changes the permission boundaries of all existing LFTagPolicy permission grants that reference the given LF-Tag expression.

Example Syntax

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

import { LakeFormationClient, UpdateLFTagExpressionCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import
// const { LakeFormationClient, UpdateLFTagExpressionCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import
const client = new LakeFormationClient(config);
const input = { // UpdateLFTagExpressionRequest
  Name: "STRING_VALUE", // required
  Description: "STRING_VALUE",
  CatalogId: "STRING_VALUE",
  Expression: [ // Expression // required
    { // LFTag
      TagKey: "STRING_VALUE", // required
      TagValues: [ // TagValueList // required
        "STRING_VALUE",
      ],
    },
  ],
};
const command = new UpdateLFTagExpressionCommand(input);
const response = await client.send(command);
// {};

UpdateLFTagExpressionCommand Input

See UpdateLFTagExpressionCommandInput for more details

Parameter
Type
Description
Expression
Required
LFTag[] | undefined

The LF-Tag expression body composed of one more LF-Tag key-value pairs.

Name
Required
string | undefined

The name for the LF-Tag expression.

CatalogId
string | undefined

The identifier for the Data Catalog. By default, the account ID.

Description
string | undefined

The description with information about the saved LF-Tag expression.

UpdateLFTagExpressionCommand Output

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

ResourceNumberLimitExceededException
client

A resource numerical limit was exceeded.

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