:doc:`Personalize <../../personalize>` / Paginator / ListFilters

***********
ListFilters
***********



.. py:class:: Personalize.Paginator.ListFilters

  ::

    
    paginator = client.get_paginator('list_filters')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Personalize.Client.list_filters`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListFilters>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          datasetGroupArn='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type datasetGroupArn: string
    :param datasetGroupArn: 

      The ARN of the dataset group that contains the filters.

      

    
    :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**

      
      ::

        {
            'Filters': [
                {
                    'name': 'string',
                    'filterArn': 'string',
                    'creationDateTime': datetime(2015, 1, 1),
                    'lastUpdatedDateTime': datetime(2015, 1, 1),
                    'datasetGroupArn': 'string',
                    'failureReason': 'string',
                    'status': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Filters** *(list) --* 

          A list of returned filters.

          
          

          - *(dict) --* 

            A short summary of a filter's attributes.

            
            

            - **name** *(string) --* 

              The name of the filter.

              
            

            - **filterArn** *(string) --* 

              The ARN of the filter.

              
            

            - **creationDateTime** *(datetime) --* 

              The time at which the filter was created.

              
            

            - **lastUpdatedDateTime** *(datetime) --* 

              The time at which the filter was last updated.

              
            

            - **datasetGroupArn** *(string) --* 

              The ARN of the dataset group to which the filter belongs.

              
            

            - **failureReason** *(string) --* 

              If the filter failed, the reason for the failure.

              
            

            - **status** *(string) --* 

              The status of the filter.

              
        
      
        

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

          A token to resume pagination.

          
    