Personalize / Client / describe_filter



Describes a filter’s properties.

See also: AWS API Documentation

Request Syntax

response = client.describe_filter(

filterArn (string) –


The ARN of the filter to describe.

Return type:



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.

      • status (string) –

        The status of the filter.


  • Personalize.Client.exceptions.InvalidInputException

  • Personalize.Client.exceptions.ResourceNotFoundException