Data Filter APIs - AWS Lake Formation

Data Filter APIs

The Data Filter APIs describes how to manage data cell filters in AWS Lake Formation.

Data Types

DataCellsFilter Structure

A structure that describes certain columns on certain rows.

Fields

  • TableCatalogIdRequired: Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

    The ID of the catalog to which the table belongs.

  • DatabaseNameRequired: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

    A database in the AWS Glue Data Catalog.

  • TableNameRequired: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

    A table in the database.

  • NameRequired: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

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

  • RowFilter – A RowFilter object.

    A PartiQL predicate.

  • ColumnNames – An array of UTF-8 strings.

    A list of column names.

  • ColumnWildcard – A ColumnWildcard object.

    A wildcard with exclusions.

    You must specify either a ColumnNames list or the ColumnWildCard.

RowFilter Structure

A PartiQL predicate.

Fields

  • FilterExpression – Predicate string, not more than 2048 bytes long, matching the URI address multi-line string pattern.

    A filter expression.

  • AllRowsWildcard – An empty-structure named AllRowsWildcard.

    A wildcard for all rows.

Operations

CreateDataCellsFilter Action (Python: create_data_cells_filter)

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

Request

  • TableDataRequired: A DataCellsFilter object.

    A DataCellsFilter structure containing information about the data cells filter.

Response

  • No Response parameters.

Errors

  • AlreadyExistsException

  • InvalidInputException

  • EntityNotFoundException

  • ResourceNumberLimitExceededException

  • InternalServiceException

  • OperationTimeoutException

  • AccessDeniedException

DeleteDataCellsFilter Action (Python: delete_data_cells_filter)

Deletes a data cell filter.

Request

  • TableData – A DataCellsFilter object.

    A DataCellsFilter structure containing information about the data cells filter.

  • TableCatalogId – Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

    The ID of the catalog to which the table belongs.

  • DatabaseName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

    A database in the AWS Glue Data Catalog.

  • TableName – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

    A table in the database.

  • Name – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

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

Response

  • No Response parameters.

Errors

  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

  • AccessDeniedException

ListDataCellsFilter Action (Python: list_data_cells_filter)

Lists all the data cell filters on a table.

Request

  • Table – A TableResource object.

    A table in the AWS Glue Data Catalog.

  • NextToken – UTF-8 string.

    A continuation token, if this is a continuation call.

  • MaxResults – Number (integer), not less than 1 or more than 1000.

    The maximum size of the response.

Response

  • DataCellsFilters – An array of DataCellsFilter objects.

    A list of DataCellFilter structures.

  • NextToken – UTF-8 string.

    A continuation token, if not all requested data cell filters have been returned.

Errors

  • InvalidInputException

  • OperationTimeoutException

  • InternalServiceException

  • AccessDeniedException