GetActionRecommendationsRequest ¶

class GetActionRecommendationsRequest(TypedDict, closed=True):
    campaign_arn: NotRequired["capo_personalize_runtime.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED_ACTIONS recipe.</p>"""
    user_id: NotRequired["capo_personalize_runtime.types.user_id.UserID"]
    """<p>The user ID of the user to provide action recommendations for.</p>"""
    num_results: "capo_personalize_runtime.types.num_results.NumResults"
    """<p>The number of results to return. The default is 5. The maximum is 100.</p>"""
    filter_arn: NotRequired["capo_personalize_runtime.types.arn.Arn"]
    """<p>The ARN of the filter to apply to the returned recommendations. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p> <p>When using this parameter, be sure the filter resource is <code>ACTIVE</code>.</p>"""
    filter_values: NotRequired[
        "capo_personalize_runtime.types.filter_values.FilterValues"
    ]
    """<p>The values to use when filtering recommendations. For each placeholder parameter in your 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 actions, 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 actions, 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, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering recommendations and user segments</a>.</p>"""