- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateLFTagCommand
Creates an LF-tag with the specified name and values.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LakeFormationClient, CreateLFTagCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import
// const { LakeFormationClient, CreateLFTagCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import
const client = new LakeFormationClient(config);
const input = { // CreateLFTagRequest
CatalogId: "STRING_VALUE",
TagKey: "STRING_VALUE", // required
TagValues: [ // TagValueList // required
"STRING_VALUE",
],
};
const command = new CreateLFTagCommand(input);
const response = await client.send(command);
// {};
CreateLFTagCommand Input
See CreateLFTagCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
TagKey Required | string | undefined | The key-name for the LF-tag. |
TagValues Required | string[] | undefined | A list of possible values an attribute can take. |
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. |
CreateLFTagCommand Output
See CreateLFTagCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
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. |