You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Personalize::Types::Filter

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains information on a recommendation filter, including its ARN, status, and filter expression.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#creation_date_time ⇒ Time

The time at which the filter was created.

Returns:

  • (Time) —

    The time at which the filter was created.

#dataset_group_arn ⇒ String

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

Returns:

  • (String) —

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

#failure_reason ⇒ String

If the filter failed, the reason for its failure.

Returns:

  • (String) —

    If the filter failed, the reason for its failure.

#filter_arn ⇒ String

The ARN of the filter.

Returns:

  • (String) —

    The ARN of the filter.

#filter_expression ⇒ String

Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow the following format:

EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")

Where \"EVENT_TYPE\" is the type of event to filter out. For more information, see Using Filters with Amazon Personalize.

Returns:

  • (String) —

    Specifies the type of item interactions to filter out of recommendation results.

#last_updated_date_time ⇒ Time

The time at which the filter was last updated.

Returns:

  • (Time) —

    The time at which the filter was last updated.

#name ⇒ String

The name of the filter.

Returns:

  • (String) —

    The name of the filter.

#status ⇒ String

The status of the filter.

Returns:

  • (String) —

    The status of the filter.