- 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.
GetLFTagCommand
Returns an LF-tag definition.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LakeFormationClient, GetLFTagCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import
// const { LakeFormationClient, GetLFTagCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import
const client = new LakeFormationClient(config);
const input = { // GetLFTagRequest
CatalogId: "STRING_VALUE",
TagKey: "STRING_VALUE", // required
};
const command = new GetLFTagCommand(input);
const response = await client.send(command);
// { // GetLFTagResponse
// CatalogId: "STRING_VALUE",
// TagKey: "STRING_VALUE",
// TagValues: [ // TagValueList
// "STRING_VALUE",
// ],
// };
GetLFTagCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
TagKey Required | string | undefined | The key-name for the LF-tag. |
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. |
GetLFTagCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
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. |
TagKey | string | undefined | The key-name for the LF-tag. |
TagValues | string[] | undefined | A list of possible values an attribute can take. |
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. |
LakeFormationServiceException | Base exception class for all service exceptions from LakeFormation service. |