:doc:`LakeFormation <../../lakeformation>` / Client / list_data_cells_filter

**********************
list_data_cells_filter
**********************



.. py:method:: LakeFormation.Client.list_data_cells_filter(**kwargs)

  

  Lists all the data cell filters on a table.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/ListDataCellsFilter>`_  


  **Request Syntax**
  ::

    response = 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 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.

            
      
    
      

      - **NextToken** *(string) --* 

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

        
  
  **Exceptions**
  
  *   :py:class:`LakeFormation.Client.exceptions.InvalidInputException`

  
  *   :py:class:`LakeFormation.Client.exceptions.OperationTimeoutException`

  
  *   :py:class:`LakeFormation.Client.exceptions.InternalServiceException`

  
  *   :py:class:`LakeFormation.Client.exceptions.AccessDeniedException`

  