Skip to content

Promotion

Source code in docs_src/capo_personalize_runtime/types/promotion.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class Promotion(TypedDict, closed=True):
    name: NotRequired["capo_personalize_runtime.types.name.Name"]
    """<p>The name of the promotion.</p>"""
    percent_promoted_items: NotRequired[
        "capo_personalize_runtime.types.percent_promoted_items.PercentPromotedItems"
    ]
    """<p>The percentage of recommended items to apply the promotion to.</p>"""
    filter_arn: NotRequired["capo_personalize_runtime.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the filter used by the promotion. This filter defines the criteria for promoted items. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/promoting-items.html#promotion-filters">Promotion filters</a>.</p>"""
    filter_values: NotRequired[
        "capo_personalize_runtime.types.filter_values.FilterValues"
    ]
    """<p>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. </p> <p>For filter expressions that use an <code>INCLUDE</code> element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an <code>EXCLUDE</code> element to exclude items, you can omit the <code>filter-values</code>. In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.</p> <p>For more information on creating filters, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering recommendations and user segments</a>.</p>"""

filter_arn instance-attribute 

filter_arn: NotRequired[Arn]

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.

filter_values instance-attribute 

filter_values: NotRequired[FilterValues]

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.

name instance-attribute 

name: NotRequired[Name]

The name of the promotion.

percent_promoted_items instance-attribute 

percent_promoted_items: NotRequired[PercentPromotedItems]

The percentage of recommended items to apply the promotion to.