Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Class: Aws::PersonalizeRuntime::Types::Promotion

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

Overview

Contains information on a promotion. A promotion defines additional business rules that apply to a configurable subset of recommended items.

Constant Summary collapse

SENSITIVE =
[:filter_values]

Instance Attribute Summary collapse

Instance Attribute Details

#filter_arnString

The Amazon Resource Name (ARN) of the filter used by the promotion. This filter defines the criteria for promoted items. For more information, see Promotion filters.

Returns:

  • (String)

472
473
474
475
476
477
478
479
# File 'gems/aws-sdk-personalizeruntime/lib/aws-sdk-personalizeruntime/types.rb', line 472

class Promotion < Struct.new(
  :name,
  :percent_promoted_items,
  :filter_arn,
  :filter_values)
  SENSITIVE = [:filter_values]
  include Aws::Structure
end

#filter_valuesHash<String,String>

The values to use when promoting items. For each placeholder parameter in your promotion's filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values. In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.

For more information on creating filters, see Filtering recommendations and user segments.

Returns:

  • (Hash<String,String>)

472
473
474
475
476
477
478
479
# File 'gems/aws-sdk-personalizeruntime/lib/aws-sdk-personalizeruntime/types.rb', line 472

class Promotion < Struct.new(
  :name,
  :percent_promoted_items,
  :filter_arn,
  :filter_values)
  SENSITIVE = [:filter_values]
  include Aws::Structure
end

#nameString

The name of the promotion.

Returns:

  • (String)

472
473
474
475
476
477
478
479
# File 'gems/aws-sdk-personalizeruntime/lib/aws-sdk-personalizeruntime/types.rb', line 472

class Promotion < Struct.new(
  :name,
  :percent_promoted_items,
  :filter_arn,
  :filter_values)
  SENSITIVE = [:filter_values]
  include Aws::Structure
end

#percent_promoted_itemsInteger

The percentage of recommended items to apply the promotion to.

Returns:

  • (Integer)

472
473
474
475
476
477
478
479
# File 'gems/aws-sdk-personalizeruntime/lib/aws-sdk-personalizeruntime/types.rb', line 472

class Promotion < Struct.new(
  :name,
  :percent_promoted_items,
  :filter_arn,
  :filter_values)
  SENSITIVE = [:filter_values]
  include Aws::Structure
end