CreateDataCellsFilterCommand

Creates a data cell filter to allow one to grant access to certain columns on certain rows.

Example Syntax

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

import { LakeFormationClient, CreateDataCellsFilterCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import
// const { LakeFormationClient, CreateDataCellsFilterCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import
const client = new LakeFormationClient(config);
const input = { // CreateDataCellsFilterRequest
  TableData: { // DataCellsFilter
    TableCatalogId: "STRING_VALUE", // required
    DatabaseName: "STRING_VALUE", // required
    TableName: "STRING_VALUE", // required
    Name: "STRING_VALUE", // required
    RowFilter: { // RowFilter
      FilterExpression: "STRING_VALUE",
      AllRowsWildcard: {},
    },
    ColumnNames: [ // ColumnNames
      "STRING_VALUE",
    ],
    ColumnWildcard: { // ColumnWildcard
      ExcludedColumnNames: [
        "STRING_VALUE",
      ],
    },
    VersionId: "STRING_VALUE",
  },
};
const command = new CreateDataCellsFilterCommand(input);
const response = await client.send(command);
// {};

CreateDataCellsFilterCommand Input

Parameter
Type
Description
TableData
Required
DataCellsFilter | undefined

A DataCellsFilter structure containing information about the data cells filter.

CreateDataCellsFilterCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

Access to a resource was denied.

AlreadyExistsException
client

A resource to be created or added already exists.

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.