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

***************
describe_filter
***************



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

  

  Describes a filter's properties.

  

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


  **Request Syntax**
  ::

    response = client.describe_filter(
        filterArn='string'
    )
    
  :type filterArn: string
  :param filterArn: **[REQUIRED]** 

    The ARN of the filter to describe.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'filter': {
              'name': 'string',
              'filterArn': 'string',
              'creationDateTime': datetime(2015, 1, 1),
              'lastUpdatedDateTime': datetime(2015, 1, 1),
              'datasetGroupArn': 'string',
              'failureReason': 'string',
              'filterExpression': 'string',
              'status': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **filter** *(dict) --* 

        The filter's details.

        
        

        - **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 its failure.

          
        

        - **filterExpression** *(string) --* 

          Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see `Filter expressions <https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html>`__.

          
        

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

          The status of the filter.

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

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

  