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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-personalize/types.rb

Overview

Note:

When making an API call, you may pass CreateFilterRequest data as a hash:

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

See Also:

Constant Summary collapse

SENSITIVE = 
[:filter_expression]

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) 


1009
1010
1011
1012
1013
1014
1015
 
# File 'lib/aws-sdk-personalize/types.rb', line 1009

class CreateFilterRequest < Struct.new(
  :name,
  :dataset_group_arn,
  :filter_expression)
  SENSITIVE = [:filter_expression]
  include Aws::Structure
end

#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].

[1]: docs.aws.amazon.com/personalize/latest/dg/filters.html

Returns:

  • (String) 


1009
1010
1011
1012
1013
1014
1015
 
# File 'lib/aws-sdk-personalize/types.rb', line 1009

class CreateFilterRequest < Struct.new(
  :name,
  :dataset_group_arn,
  :filter_expression)
  SENSITIVE = [:filter_expression]
  include Aws::Structure
end

#name ⇒ String

The name of the filter to create.

Returns:

  • (String) 


1009
1010
1011
1012
1013
1014
1015
 
# File 'lib/aws-sdk-personalize/types.rb', line 1009

class CreateFilterRequest < Struct.new(
  :name,
  :dataset_group_arn,
  :filter_expression)
  SENSITIVE = [:filter_expression]
  include Aws::Structure
end