Struct rusoto_personalize_runtime::GetRecommendationsRequest

pub struct GetRecommendationsRequest {
    pub campaign_arn: String,
    pub context: Option<HashMap<String, String>>,
    pub filter_arn: Option<String>,
    pub filter_values: Option<HashMap<String, String>>,
    pub item_id: Option<String>,
    pub num_results: Option<i64>,
    pub user_id: Option<String>,
}

Fields

campaign_arn: String

The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

context: Option<HashMap<String, String>>

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

filter_arn: Option<String>

The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.

When using this parameter, be sure the filter resource is ACTIVE.

filter_values: Option<HashMap<String, String>>

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.

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, see Filtering Recommendations.

item_id: Option<String>

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

num_results: Option<i64>

The number of results to return. The default is 25. The maximum is 500.

user_id: Option<String>

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

Trait Implementations

impl Clone for GetRecommendationsRequest

pub fn clone(&self) -> GetRecommendationsRequest

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetRecommendationsRequest

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GetRecommendationsRequest

pub fn default() -> GetRecommendationsRequest

Returns the "default value" for a type.

impl PartialEq<GetRecommendationsRequest> for GetRecommendationsRequest

pub fn eq(&self, other: &GetRecommendationsRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &GetRecommendationsRequest) -> bool

This method tests for !=.

impl Serialize for GetRecommendationsRequest

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GetRecommendationsRequest