AWS Lake Formation

2023/03/08 - AWS Lake Formation - 2 new 2 updated api methods

Changes  This release adds two new API support "GetDataCellsFiler" and "UpdateDataCellsFilter", and also updates the corresponding documentation.

GetDataCellsFilter (new) Link ¶

Returns a data cells filter.

See also: AWS API Documentation

Request Syntax

client.get_data_cells_filter(
    TableCatalogId='string',
    DatabaseName='string',
    TableName='string',
    Name='string'
)
type TableCatalogId

string

param TableCatalogId

[REQUIRED]

The ID of the catalog to which the table belongs.

type DatabaseName

string

param DatabaseName

[REQUIRED]

A database in the Glue Data Catalog.

type TableName

string

param TableName

[REQUIRED]

A table in the database.

type Name

string

param Name

[REQUIRED]

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

rtype

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.

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

UpdateDataCellsFilter (new) Link ¶

Updates a data cell filter.

See also: AWS API Documentation

Request Syntax

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

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

dict

param TableData

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

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

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

CreateDataCellsFilter (updated) Link ¶
Changes (request)
{'TableData': {'VersionId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

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'
    }
)
type TableData

dict

param TableData

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

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

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

ListDataCellsFilter (updated) Link ¶
Changes (response)
{'DataCellsFilters': {'VersionId': 'string'}}

Lists all the data cell filters on a table.

See also: AWS API Documentation

Request Syntax

client.list_data_cells_filter(
    Table={
        'CatalogId': 'string',
        'DatabaseName': 'string',
        'Name': 'string',
        'TableWildcard': {}

    },
    NextToken='string',
    MaxResults=123
)
type Table

dict

param Table

A table in the Glue Data Catalog.

  • CatalogId (string) --

    The identifier for the Data Catalog. By default, it is the account ID of the caller.

  • DatabaseName (string) -- [REQUIRED]

    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.

  • Name (string) --

    The name of the table.

  • TableWildcard (dict) --

    A wildcard object representing every table under a database.

    At least one of TableResource$Name or TableResource$TableWildcard is required.

type NextToken

string

param NextToken

A continuation token, if this is a continuation call.

type MaxResults

integer

param MaxResults

The maximum size of the response.

rtype

dict

returns

Response Syntax

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

Response Structure

  • (dict) --

    • DataCellsFilters (list) --

      A list of DataCellFilter structures.

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

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

    • NextToken (string) --

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