Class SearchTablesByLFTagsCommandProtected

This operation allows a search on TABLE resources by LFTags. This will be used by admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use SearchTablesByLFTags to find all resources where the given LFTags are valid to verify whether the returned resources can be shared.

Example

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

import { LakeFormationClient, SearchTablesByLFTagsCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import
// const { LakeFormationClient, SearchTablesByLFTagsCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import
const client = new LakeFormationClient(config);
const input = { // SearchTablesByLFTagsRequest
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  CatalogId: "STRING_VALUE",
  Expression: [ // Expression // required
    { // LFTag
      TagKey: "STRING_VALUE", // required
      TagValues: [ // TagValueList // required
        "STRING_VALUE",
      ],
    },
  ],
};
const command = new SearchTablesByLFTagsCommand(input);
const response = await client.send(command);
// { // SearchTablesByLFTagsResponse
//   NextToken: "STRING_VALUE",
//   TableList: [ // TableLFTagsList
//     { // TaggedTable
//       Table: { // TableResource
//         CatalogId: "STRING_VALUE",
//         DatabaseName: "STRING_VALUE", // required
//         Name: "STRING_VALUE",
//         TableWildcard: {},
//       },
//       LFTagOnDatabase: [ // LFTagsList
//         { // LFTagPair
//           CatalogId: "STRING_VALUE",
//           TagKey: "STRING_VALUE", // required
//           TagValues: [ // TagValueList // required
//             "STRING_VALUE",
//           ],
//         },
//       ],
//       LFTagsOnTable: [
//         {
//           CatalogId: "STRING_VALUE",
//           TagKey: "STRING_VALUE", // required
//           TagValues: [ // required
//             "STRING_VALUE",
//           ],
//         },
//       ],
//       LFTagsOnColumns: [ // ColumnLFTagsList
//         { // ColumnLFTag
//           Name: "STRING_VALUE",
//           LFTags: [
//             {
//               CatalogId: "STRING_VALUE",
//               TagKey: "STRING_VALUE", // required
//               TagValues: [ // required
//                 "STRING_VALUE",
//               ],
//             },
//           ],
//         },
//       ],
//     },
//   ],
// };

Param

SearchTablesByLFTagsCommandInput

Returns

SearchTablesByLFTagsCommandOutput

See

• SearchTablesByLFTagsCommandInput for command's input shape.
• SearchTablesByLFTagsCommandOutput for command's response shape.
• config for LakeFormationClient's config shape.

Throws

AccessDeniedException (client fault)

Access to a resource was denied.

Throws

EntityNotFoundException (client fault)

A specified entity does not exist.

Throws

GlueEncryptionException (client fault)

An encryption operation failed.

Throws

InternalServiceException (server fault)

An internal service error occurred.

Throws

InvalidInputException (client fault)

The input provided was not valid.

Throws

OperationTimeoutException (client fault)

The operation timed out.

Throws

LakeFormationServiceException

Base exception class for all service exceptions from LakeFormation service.