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

Inherits:

Struct

• Object
• Struct
• Aws::Personalize::Types::Filter

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:filter_expression]

Instance Attribute Summary

• #creation_date_time ⇒ Time

  The time at which the filter was created.

• #dataset_group_arn ⇒ String

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

• #failure_reason ⇒ String

  If the filter failed, the reason for its failure.

• #filter_arn ⇒ String

  The ARN of the filter.

• #filter_expression ⇒ 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.

• #name ⇒ String

  The name of the filter.

• #status ⇒ String

  The status of the filter.

Instance Attribute Details

#creation_date_time ⇒ Time

The time at which the filter was created.

Returns:

• (Time)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3147

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_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3147

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_reason ⇒ String

If the filter failed, the reason for its failure.

Returns:

• (String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3147

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_arn ⇒ String

The ARN of the filter.

Returns:

• (String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3147

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_expression ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3147

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_time ⇒ Time

The time at which the filter was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3147

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

#name ⇒ String

The name of the filter.

Returns:

• (String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3147

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

#status ⇒ String

The status of the filter.

Returns:

• (String)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 3147

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