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

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

Overview

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

Constant Summary collapse

SENSITIVE =
[:filter_expression]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_date_timeTime

The time at which the filter was created.

Returns:

  • (Time)


2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2837

class Filter < Struct.new(
  :name,
  :filter_arn,
  :creation_date_time,
  :last_updated_date_time,
  :dataset_group_arn,
  :failure_reason,
  :filter_expression,
  :status)
  SENSITIVE = [:filter_expression]
  include Aws::Structure
end

#dataset_group_arnString

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

Returns:

  • (String)


2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2837

class Filter < Struct.new(
  :name,
  :filter_arn,
  :creation_date_time,
  :last_updated_date_time,
  :dataset_group_arn,
  :failure_reason,
  :filter_expression,
  :status)
  SENSITIVE = [:filter_expression]
  include Aws::Structure
end

#failure_reasonString

If the filter failed, the reason for its failure.

Returns:

  • (String)


2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2837

class Filter < Struct.new(
  :name,
  :filter_arn,
  :creation_date_time,
  :last_updated_date_time,
  :dataset_group_arn,
  :failure_reason,
  :filter_expression,
  :status)
  SENSITIVE = [:filter_expression]
  include Aws::Structure
end

#filter_arnString

The ARN of the filter.

Returns:

  • (String)


2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2837

class Filter < Struct.new(
  :name,
  :filter_arn,
  :creation_date_time,
  :last_updated_date_time,
  :dataset_group_arn,
  :failure_reason,
  :filter_expression,
  :status)
  SENSITIVE = [:filter_expression]
  include Aws::Structure
end

#filter_expressionString

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.

Returns:

  • (String)


2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2837

class Filter < Struct.new(
  :name,
  :filter_arn,
  :creation_date_time,
  :last_updated_date_time,
  :dataset_group_arn,
  :failure_reason,
  :filter_expression,
  :status)
  SENSITIVE = [:filter_expression]
  include Aws::Structure
end

#last_updated_date_timeTime

The time at which the filter was last updated.

Returns:

  • (Time)


2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2837

class Filter < Struct.new(
  :name,
  :filter_arn,
  :creation_date_time,
  :last_updated_date_time,
  :dataset_group_arn,
  :failure_reason,
  :filter_expression,
  :status)
  SENSITIVE = [:filter_expression]
  include Aws::Structure
end

#nameString

The name of the filter.

Returns:

  • (String)


2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2837

class Filter < Struct.new(
  :name,
  :filter_arn,
  :creation_date_time,
  :last_updated_date_time,
  :dataset_group_arn,
  :failure_reason,
  :filter_expression,
  :status)
  SENSITIVE = [:filter_expression]
  include Aws::Structure
end

#statusString

The status of the filter.

Returns:

  • (String)


2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2837

class Filter < Struct.new(
  :name,
  :filter_arn,
  :creation_date_time,
  :last_updated_date_time,
  :dataset_group_arn,
  :failure_reason,
  :filter_expression,
  :status)
  SENSITIVE = [:filter_expression]
  include Aws::Structure
end