LakeFormation / Client / create_data_cells_filter

create_data_cells_filter#

LakeFormation.Client.create_data_cells_filter(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.create_data_cells_filter(
    TableData={
        'TableCatalogId': 'string',
        'DatabaseName': 'string',
        'TableName': 'string',
        'Name': 'string',
        'RowFilter': {
            'FilterExpression': 'string',
            'AllRowsWildcard': {}

        },
        'ColumnNames': [
            'string',
        ],
        'ColumnWildcard': {
            'ExcludedColumnNames': [
                'string',
            ]
        },
        'VersionId': 'string'
    }
)
Parameters:

TableData (dict) –

[REQUIRED]

A DataCellsFilter structure containing information about the data cells filter.

  • TableCatalogId (string) – [REQUIRED]

    The ID of the catalog to which the table belongs.

  • DatabaseName (string) – [REQUIRED]

    A database in the Glue Data Catalog.

  • TableName (string) – [REQUIRED]

    A table in the database.

  • Name (string) – [REQUIRED]

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

  • RowFilter (dict) –

    A PartiQL predicate.

    • FilterExpression (string) –

      A filter expression.

    • AllRowsWildcard (dict) –

      A wildcard for all rows.

  • ColumnNames (list) –

    A list of column names and/or nested column attributes. When specifying nested attributes, use a qualified dot (.) delimited format such as “address”.”zip”. Nested attributes within this list may not exceed a depth of 5.

    • (string) –

  • ColumnWildcard (dict) –

    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) –

  • VersionId (string) –

    The ID of the data cells filter version.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • LakeFormation.Client.exceptions.AlreadyExistsException

  • LakeFormation.Client.exceptions.InvalidInputException

  • LakeFormation.Client.exceptions.EntityNotFoundException

  • LakeFormation.Client.exceptions.ResourceNumberLimitExceededException

  • LakeFormation.Client.exceptions.InternalServiceException

  • LakeFormation.Client.exceptions.OperationTimeoutException

  • LakeFormation.Client.exceptions.AccessDeniedException