:doc:`LakeFormation <../../lakeformation>` / Paginator / ListDataCellsFilter

*******************
ListDataCellsFilter
*******************



.. py:class:: LakeFormation.Paginator.ListDataCellsFilter

  ::

    
    paginator = client.get_paginator('list_data_cells_filter')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`LakeFormation.Client.list_data_cells_filter`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Table={
              'CatalogId': 'string',
              'DatabaseName': 'string',
              'Name': 'string',
              'TableWildcard': {}
              
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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 PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous 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'
                },
            ],
            
        }
        
      **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.

              
        
      
    