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

Class: Aws::Personalize::Types::CreateFilterRequest

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

Overview

Note:

When passing CreateFilterRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "Name", # required
  dataset_group_arn: "Arn", # required
  filter_expression: "FilterExpression", # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#dataset_group_arn ⇒ String

The ARN of the dataset group that the filter will belong to.

Returns:

  • (String) —

    The ARN of the dataset group that the filter will belong to.

#filter_expression ⇒ String

The filter expression that designates the interaction types that the filter will filter out. A 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. To filter out all items with any interactions history, set "*" as the EVENT_TYPE. For more information, see Using Filters with Amazon Personalize.

Returns:

  • (String) —

    The filter expression that designates the interaction types that the filter will filter out.

#name ⇒ String

The name of the filter to create.

Returns:

  • (String) —

    The name of the filter to create.