LakeFormation / Client / get_data_cells_filter

get_data_cells_filter#

LakeFormation.Client.get_data_cells_filter(**kwargs)#

Returns a data cells filter.

See also: AWS API Documentation

Request Syntax

response = client.get_data_cells_filter(
    TableCatalogId='string',
    DatabaseName='string',
    TableName='string',
    Name='string'
)
Parameters:

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'DataCellsFilter': {
        'TableCatalogId': 'string',
        'DatabaseName': 'string',
        'TableName': 'string',
        'Name': 'string',
        'RowFilter': {
            'FilterExpression': 'string',
            'AllRowsWildcard': {}
        },
        'ColumnNames': [
            'string',
        ],
        'ColumnWildcard': {
            'ExcludedColumnNames': [
                'string',
            ]
        },
        'VersionId': 'string'
    }
}

Response Structure

  • (dict) –

    • DataCellsFilter (dict) –

      A structure that describes certain columns on certain rows.

      • 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 (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.

Exceptions

  • LakeFormation.Client.exceptions.EntityNotFoundException

  • LakeFormation.Client.exceptions.InvalidInputException

  • LakeFormation.Client.exceptions.OperationTimeoutException

  • LakeFormation.Client.exceptions.InternalServiceException

  • LakeFormation.Client.exceptions.AccessDeniedException