[ aws . lakeformation ]

create-data-cells-filter

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-data-cells-filter
--table-data <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--table-data (structure)

A DataCellsFilter structure containing information about the data cells filter.

TableCatalogId -> (string)

The ID of the catalog to which the table belongs.

DatabaseName -> (string)

A database in the Glue Data Catalog.

TableName -> (string)

A table in the database.

Name -> (string)

The name given by the user to the data filter cell.

RowFilter -> (structure)

A PartiQL predicate.

FilterExpression -> (string)

A filter expression.

AllRowsWildcard -> (structure)

A wildcard for all rows.

ColumnNames -> (list)

A list of column names.

(string)

ColumnWildcard -> (structure)

A wildcard with exclusions.

You must specify either a ColumnNames list or the ColumnWildCard .

ExcludedColumnNames -> (list)

Excludes column names. Any column with this name will be excluded.

(string)

Shorthand Syntax:

TableCatalogId=string,DatabaseName=string,TableName=string,Name=string,RowFilter={FilterExpression=string,AllRowsWildcard={}},ColumnNames=string,string,ColumnWildcard={ExcludedColumnNames=[string,string]}

JSON Syntax:

{
  "TableCatalogId": "string",
  "DatabaseName": "string",
  "TableName": "string",
  "Name": "string",
  "RowFilter": {
    "FilterExpression": "string",
    "AllRowsWildcard": {

    }
  },
  "ColumnNames": ["string", ...],
  "ColumnWildcard": {
    "ExcludedColumnNames": ["string", ...]
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

None