:doc:`Personalize <../../personalize>` / Client / list_filters

************
list_filters
************



.. py:method:: Personalize.Client.list_filters(**kwargs)

  

  Lists all filters that belong to a given dataset group.

  

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


  **Request Syntax**
  ::

    response = client.list_filters(
        datasetGroupArn='string',
        nextToken='string',
        maxResults=123
    )
    
  :type datasetGroupArn: string
  :param datasetGroupArn: 

    The ARN of the dataset group that contains the filters.

    

  
  :type nextToken: string
  :param nextToken: 

    A token returned from the previous call to ``ListFilters`` for getting the next set of filters (if they exist).

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of filters to return.

    

  
  
  :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 for getting the next set of filters (if they exist).

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

  
  *   :py:class:`Personalize.Client.exceptions.InvalidNextTokenException`

  