-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Amazon Personalize Runtime SDK. -- -- Derived from API version 2018-05-22 of the AWS service -- descriptions, licensed under Apache 2.0. -- -- The types from this library are intended to be used with -- amazonka, which provides mechanisms for specifying AuthN/AuthZ -- information, sending requests, and receiving responses. -- -- It is recommended to use generic lenses or optics from packages such -- as generic-lens or optics to modify optional fields and -- deconstruct responses. -- -- Generated lenses can be found in -- Amazonka.PersonalizeRuntime.Lens and are suitable for use with -- a lens package such as lens or lens-family-core. -- -- See Amazonka.PersonalizeRuntime and the AWS -- documentation to get started. @package amazonka-personalize-runtime @version 2.0 module Amazonka.PersonalizeRuntime.Types.PredictedItem -- | An object that identifies an item. -- -- The and APIs return a list of PredictedItems. -- -- See: newPredictedItem smart constructor. data PredictedItem PredictedItem' :: Maybe Text -> Maybe Text -> Maybe Double -> PredictedItem -- | The recommended item ID. [$sel:itemId:PredictedItem'] :: PredictedItem -> Maybe Text -- | The name of the promotion that included the predicted item. [$sel:promotionName:PredictedItem'] :: PredictedItem -> Maybe Text -- | A numeric representation of the model's certainty that the item will -- be the next user selection. For more information on scoring logic, see -- how-scores-work. [$sel:score:PredictedItem'] :: PredictedItem -> Maybe Double -- | Create a value of PredictedItem with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:itemId:PredictedItem', predictedItem_itemId - The -- recommended item ID. -- -- $sel:promotionName:PredictedItem', -- predictedItem_promotionName - The name of the promotion that -- included the predicted item. -- -- $sel:score:PredictedItem', predictedItem_score - A -- numeric representation of the model's certainty that the item will be -- the next user selection. For more information on scoring logic, see -- how-scores-work. newPredictedItem :: PredictedItem -- | The recommended item ID. predictedItem_itemId :: Lens' PredictedItem (Maybe Text) -- | The name of the promotion that included the predicted item. predictedItem_promotionName :: Lens' PredictedItem (Maybe Text) -- | A numeric representation of the model's certainty that the item will -- be the next user selection. For more information on scoring logic, see -- how-scores-work. predictedItem_score :: Lens' PredictedItem (Maybe Double) instance GHC.Generics.Generic Amazonka.PersonalizeRuntime.Types.PredictedItem.PredictedItem instance GHC.Show.Show Amazonka.PersonalizeRuntime.Types.PredictedItem.PredictedItem instance GHC.Read.Read Amazonka.PersonalizeRuntime.Types.PredictedItem.PredictedItem instance GHC.Classes.Eq Amazonka.PersonalizeRuntime.Types.PredictedItem.PredictedItem instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.PersonalizeRuntime.Types.PredictedItem.PredictedItem instance Data.Hashable.Class.Hashable Amazonka.PersonalizeRuntime.Types.PredictedItem.PredictedItem instance Control.DeepSeq.NFData Amazonka.PersonalizeRuntime.Types.PredictedItem.PredictedItem module Amazonka.PersonalizeRuntime.Types.Promotion -- | Contains information on a promotion. A promotion defines additional -- business rules that apply to a configurable subset of recommended -- items. -- -- See: newPromotion smart constructor. data Promotion Promotion' :: Maybe Text -> Maybe (HashMap Text (Sensitive Text)) -> Maybe Text -> Maybe Natural -> Promotion -- | 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. [$sel:filterArn:Promotion'] :: Promotion -> Maybe Text -- | 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. [$sel:filterValues:Promotion'] :: Promotion -> Maybe (HashMap Text (Sensitive Text)) -- | The name of the promotion. [$sel:name:Promotion'] :: Promotion -> Maybe Text -- | The percentage of recommended items to apply the promotion to. [$sel:percentPromotedItems:Promotion'] :: Promotion -> Maybe Natural -- | Create a value of Promotion with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filterArn:Promotion', promotion_filterArn - 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. -- -- $sel:filterValues:Promotion', promotion_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. -- -- $sel:name:Promotion', promotion_name - The name of the -- promotion. -- -- $sel:percentPromotedItems:Promotion', -- promotion_percentPromotedItems - The percentage of recommended -- items to apply the promotion to. newPromotion :: Promotion -- | 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. promotion_filterArn :: Lens' Promotion (Maybe Text) -- | 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. promotion_filterValues :: Lens' Promotion (Maybe (HashMap Text Text)) -- | The name of the promotion. promotion_name :: Lens' Promotion (Maybe Text) -- | The percentage of recommended items to apply the promotion to. promotion_percentPromotedItems :: Lens' Promotion (Maybe Natural) instance GHC.Generics.Generic Amazonka.PersonalizeRuntime.Types.Promotion.Promotion instance GHC.Show.Show Amazonka.PersonalizeRuntime.Types.Promotion.Promotion instance GHC.Classes.Eq Amazonka.PersonalizeRuntime.Types.Promotion.Promotion instance Data.Hashable.Class.Hashable Amazonka.PersonalizeRuntime.Types.Promotion.Promotion instance Control.DeepSeq.NFData Amazonka.PersonalizeRuntime.Types.Promotion.Promotion instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.PersonalizeRuntime.Types.Promotion.Promotion module Amazonka.PersonalizeRuntime.Types -- | API version 2018-05-22 of the Amazon Personalize Runtime SDK -- configuration. defaultService :: Service -- | Provide a valid value for the field or parameter. _InvalidInputException :: AsError a => Fold a ServiceError -- | The specified resource does not exist. _ResourceNotFoundException :: AsError a => Fold a ServiceError -- | An object that identifies an item. -- -- The and APIs return a list of PredictedItems. -- -- See: newPredictedItem smart constructor. data PredictedItem PredictedItem' :: Maybe Text -> Maybe Text -> Maybe Double -> PredictedItem -- | The recommended item ID. [$sel:itemId:PredictedItem'] :: PredictedItem -> Maybe Text -- | The name of the promotion that included the predicted item. [$sel:promotionName:PredictedItem'] :: PredictedItem -> Maybe Text -- | A numeric representation of the model's certainty that the item will -- be the next user selection. For more information on scoring logic, see -- how-scores-work. [$sel:score:PredictedItem'] :: PredictedItem -> Maybe Double -- | Create a value of PredictedItem with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:itemId:PredictedItem', predictedItem_itemId - The -- recommended item ID. -- -- $sel:promotionName:PredictedItem', -- predictedItem_promotionName - The name of the promotion that -- included the predicted item. -- -- $sel:score:PredictedItem', predictedItem_score - A -- numeric representation of the model's certainty that the item will be -- the next user selection. For more information on scoring logic, see -- how-scores-work. newPredictedItem :: PredictedItem -- | The recommended item ID. predictedItem_itemId :: Lens' PredictedItem (Maybe Text) -- | The name of the promotion that included the predicted item. predictedItem_promotionName :: Lens' PredictedItem (Maybe Text) -- | A numeric representation of the model's certainty that the item will -- be the next user selection. For more information on scoring logic, see -- how-scores-work. predictedItem_score :: Lens' PredictedItem (Maybe Double) -- | Contains information on a promotion. A promotion defines additional -- business rules that apply to a configurable subset of recommended -- items. -- -- See: newPromotion smart constructor. data Promotion Promotion' :: Maybe Text -> Maybe (HashMap Text (Sensitive Text)) -> Maybe Text -> Maybe Natural -> Promotion -- | 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. [$sel:filterArn:Promotion'] :: Promotion -> Maybe Text -- | 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. [$sel:filterValues:Promotion'] :: Promotion -> Maybe (HashMap Text (Sensitive Text)) -- | The name of the promotion. [$sel:name:Promotion'] :: Promotion -> Maybe Text -- | The percentage of recommended items to apply the promotion to. [$sel:percentPromotedItems:Promotion'] :: Promotion -> Maybe Natural -- | Create a value of Promotion with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filterArn:Promotion', promotion_filterArn - 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. -- -- $sel:filterValues:Promotion', promotion_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. -- -- $sel:name:Promotion', promotion_name - The name of the -- promotion. -- -- $sel:percentPromotedItems:Promotion', -- promotion_percentPromotedItems - The percentage of recommended -- items to apply the promotion to. newPromotion :: Promotion -- | 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. promotion_filterArn :: Lens' Promotion (Maybe Text) -- | 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. promotion_filterValues :: Lens' Promotion (Maybe (HashMap Text Text)) -- | The name of the promotion. promotion_name :: Lens' Promotion (Maybe Text) -- | The percentage of recommended items to apply the promotion to. promotion_percentPromotedItems :: Lens' Promotion (Maybe Natural) -- | Returns a list of recommended items. For campaigns, the campaign's -- Amazon Resource Name (ARN) is required and the required user and item -- input depends on the recipe type used to create the solution backing -- the campaign as follows: -- -- -- -- Campaigns that are backed by a solution created using a recipe of type -- PERSONALIZED_RANKING use the API. -- -- For recommenders, the recommender's ARN is required and the required -- item and user input depends on the use case (domain-based recipe) -- backing the recommender. For information on use case requirements see -- Choosing recommender use cases. module Amazonka.PersonalizeRuntime.GetRecommendations -- | See: newGetRecommendations smart constructor. data GetRecommendations GetRecommendations' :: Maybe Text -> Maybe (HashMap Text (Sensitive Text)) -> Maybe Text -> Maybe (HashMap Text (Sensitive Text)) -> Maybe Text -> Maybe Natural -> Maybe [Promotion] -> Maybe Text -> Maybe Text -> GetRecommendations -- | The Amazon Resource Name (ARN) of the campaign to use for getting -- recommendations. [$sel:campaignArn:GetRecommendations'] :: GetRecommendations -> Maybe Text -- | 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. [$sel:context:GetRecommendations'] :: GetRecommendations -> Maybe (HashMap Text (Sensitive Text)) -- | 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. [$sel:filterArn:GetRecommendations'] :: GetRecommendations -> Maybe Text -- | 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 and user -- segments. [$sel:filterValues:GetRecommendations'] :: GetRecommendations -> Maybe (HashMap Text (Sensitive Text)) -- | The item ID to provide recommendations for. -- -- Required for RELATED_ITEMS recipe type. [$sel:itemId:GetRecommendations'] :: GetRecommendations -> Maybe Text -- | The number of results to return. The default is 25. The maximum is -- 500. [$sel:numResults:GetRecommendations'] :: GetRecommendations -> Maybe Natural -- | The promotions to apply to the recommendation request. A promotion -- defines additional business rules that apply to a configurable subset -- of recommended items. [$sel:promotions:GetRecommendations'] :: GetRecommendations -> Maybe [Promotion] -- | The Amazon Resource Name (ARN) of the recommender to use to get -- recommendations. Provide a recommender ARN if you created a Domain -- dataset group with a recommender for a domain use case. [$sel:recommenderArn:GetRecommendations'] :: GetRecommendations -> Maybe Text -- | The user ID to provide recommendations for. -- -- Required for USER_PERSONALIZATION recipe type. [$sel:userId:GetRecommendations'] :: GetRecommendations -> Maybe Text -- | Create a value of GetRecommendations with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:campaignArn:GetRecommendations', -- getRecommendations_campaignArn - The Amazon Resource Name (ARN) -- of the campaign to use for getting recommendations. -- -- $sel:context:GetRecommendations', -- getRecommendations_context - 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. -- -- GetRecommendations, getRecommendations_filterArn - 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. -- -- GetRecommendations, getRecommendations_filterValues - -- 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 and user -- segments. -- -- GetRecommendations, getRecommendations_itemId - The item -- ID to provide recommendations for. -- -- Required for RELATED_ITEMS recipe type. -- -- $sel:numResults:GetRecommendations', -- getRecommendations_numResults - The number of results to -- return. The default is 25. The maximum is 500. -- -- $sel:promotions:GetRecommendations', -- getRecommendations_promotions - The promotions to apply to the -- recommendation request. A promotion defines additional business rules -- that apply to a configurable subset of recommended items. -- -- $sel:recommenderArn:GetRecommendations', -- getRecommendations_recommenderArn - The Amazon Resource Name -- (ARN) of the recommender to use to get recommendations. Provide a -- recommender ARN if you created a Domain dataset group with a -- recommender for a domain use case. -- -- $sel:userId:GetRecommendations', -- getRecommendations_userId - The user ID to provide -- recommendations for. -- -- Required for USER_PERSONALIZATION recipe type. newGetRecommendations :: GetRecommendations -- | The Amazon Resource Name (ARN) of the campaign to use for getting -- recommendations. getRecommendations_campaignArn :: Lens' GetRecommendations (Maybe Text) -- | 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. getRecommendations_context :: Lens' GetRecommendations (Maybe (HashMap Text Text)) -- | 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. getRecommendations_filterArn :: Lens' GetRecommendations (Maybe Text) -- | 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 and user -- segments. getRecommendations_filterValues :: Lens' GetRecommendations (Maybe (HashMap Text Text)) -- | The item ID to provide recommendations for. -- -- Required for RELATED_ITEMS recipe type. getRecommendations_itemId :: Lens' GetRecommendations (Maybe Text) -- | The number of results to return. The default is 25. The maximum is -- 500. getRecommendations_numResults :: Lens' GetRecommendations (Maybe Natural) -- | The promotions to apply to the recommendation request. A promotion -- defines additional business rules that apply to a configurable subset -- of recommended items. getRecommendations_promotions :: Lens' GetRecommendations (Maybe [Promotion]) -- | The Amazon Resource Name (ARN) of the recommender to use to get -- recommendations. Provide a recommender ARN if you created a Domain -- dataset group with a recommender for a domain use case. getRecommendations_recommenderArn :: Lens' GetRecommendations (Maybe Text) -- | The user ID to provide recommendations for. -- -- Required for USER_PERSONALIZATION recipe type. getRecommendations_userId :: Lens' GetRecommendations (Maybe Text) -- | See: newGetRecommendationsResponse smart constructor. data GetRecommendationsResponse GetRecommendationsResponse' :: Maybe [PredictedItem] -> Maybe Text -> Int -> GetRecommendationsResponse -- | A list of recommendations sorted in descending order by prediction -- score. There can be a maximum of 500 items in the list. [$sel:itemList:GetRecommendationsResponse'] :: GetRecommendationsResponse -> Maybe [PredictedItem] -- | The ID of the recommendation. [$sel:recommendationId:GetRecommendationsResponse'] :: GetRecommendationsResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:GetRecommendationsResponse'] :: GetRecommendationsResponse -> Int -- | Create a value of GetRecommendationsResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:itemList:GetRecommendationsResponse', -- getRecommendationsResponse_itemList - A list of recommendations -- sorted in descending order by prediction score. There can be a maximum -- of 500 items in the list. -- -- $sel:recommendationId:GetRecommendationsResponse', -- getRecommendationsResponse_recommendationId - The ID of the -- recommendation. -- -- $sel:httpStatus:GetRecommendationsResponse', -- getRecommendationsResponse_httpStatus - The response's http -- status code. newGetRecommendationsResponse :: Int -> GetRecommendationsResponse -- | A list of recommendations sorted in descending order by prediction -- score. There can be a maximum of 500 items in the list. getRecommendationsResponse_itemList :: Lens' GetRecommendationsResponse (Maybe [PredictedItem]) -- | The ID of the recommendation. getRecommendationsResponse_recommendationId :: Lens' GetRecommendationsResponse (Maybe Text) -- | The response's http status code. getRecommendationsResponse_httpStatus :: Lens' GetRecommendationsResponse Int instance GHC.Generics.Generic Amazonka.PersonalizeRuntime.GetRecommendations.GetRecommendations instance GHC.Show.Show Amazonka.PersonalizeRuntime.GetRecommendations.GetRecommendations instance GHC.Classes.Eq Amazonka.PersonalizeRuntime.GetRecommendations.GetRecommendations instance GHC.Generics.Generic Amazonka.PersonalizeRuntime.GetRecommendations.GetRecommendationsResponse instance GHC.Show.Show Amazonka.PersonalizeRuntime.GetRecommendations.GetRecommendationsResponse instance GHC.Read.Read Amazonka.PersonalizeRuntime.GetRecommendations.GetRecommendationsResponse instance GHC.Classes.Eq Amazonka.PersonalizeRuntime.GetRecommendations.GetRecommendationsResponse instance Amazonka.Types.AWSRequest Amazonka.PersonalizeRuntime.GetRecommendations.GetRecommendations instance Control.DeepSeq.NFData Amazonka.PersonalizeRuntime.GetRecommendations.GetRecommendationsResponse instance Data.Hashable.Class.Hashable Amazonka.PersonalizeRuntime.GetRecommendations.GetRecommendations instance Control.DeepSeq.NFData Amazonka.PersonalizeRuntime.GetRecommendations.GetRecommendations instance Amazonka.Data.Headers.ToHeaders Amazonka.PersonalizeRuntime.GetRecommendations.GetRecommendations instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.PersonalizeRuntime.GetRecommendations.GetRecommendations instance Amazonka.Data.Path.ToPath Amazonka.PersonalizeRuntime.GetRecommendations.GetRecommendations instance Amazonka.Data.Query.ToQuery Amazonka.PersonalizeRuntime.GetRecommendations.GetRecommendations -- | Re-ranks a list of recommended items for the given user. The first -- item in the list is deemed the most likely item to be of interest to -- the user. -- -- The solution backing the campaign must have been created using a -- recipe of type PERSONALIZED_RANKING. module Amazonka.PersonalizeRuntime.GetPersonalizedRanking -- | See: newGetPersonalizedRanking smart constructor. data GetPersonalizedRanking GetPersonalizedRanking' :: Maybe (HashMap Text (Sensitive Text)) -> Maybe Text -> Maybe (HashMap Text (Sensitive Text)) -> Text -> [Text] -> Text -> GetPersonalizedRanking -- | 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. [$sel:context:GetPersonalizedRanking'] :: GetPersonalizedRanking -> Maybe (HashMap Text (Sensitive Text)) -- | The Amazon Resource Name (ARN) of a filter you created to include -- items or exclude items from recommendations for a given user. For more -- information, see Filtering Recommendations. [$sel:filterArn:GetPersonalizedRanking'] :: GetPersonalizedRanking -> Maybe Text -- | 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. [$sel:filterValues:GetPersonalizedRanking'] :: GetPersonalizedRanking -> Maybe (HashMap Text (Sensitive Text)) -- | The Amazon Resource Name (ARN) of the campaign to use for generating -- the personalized ranking. [$sel:campaignArn:GetPersonalizedRanking'] :: GetPersonalizedRanking -> Text -- | A list of items (by itemId) to rank. If an item was not -- included in the training dataset, the item is appended to the end of -- the reranked list. The maximum is 500. [$sel:inputList:GetPersonalizedRanking'] :: GetPersonalizedRanking -> [Text] -- | The user for which you want the campaign to provide a personalized -- ranking. [$sel:userId:GetPersonalizedRanking'] :: GetPersonalizedRanking -> Text -- | Create a value of GetPersonalizedRanking with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:context:GetPersonalizedRanking', -- getPersonalizedRanking_context - 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. -- -- GetPersonalizedRanking, getPersonalizedRanking_filterArn -- - The Amazon Resource Name (ARN) of a filter you created to include -- items or exclude items from recommendations for a given user. For more -- information, see Filtering Recommendations. -- -- GetPersonalizedRanking, -- getPersonalizedRanking_filterValues - 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. -- -- $sel:campaignArn:GetPersonalizedRanking', -- getPersonalizedRanking_campaignArn - The Amazon Resource Name -- (ARN) of the campaign to use for generating the personalized ranking. -- -- $sel:inputList:GetPersonalizedRanking', -- getPersonalizedRanking_inputList - A list of items (by -- itemId) to rank. If an item was not included in the training -- dataset, the item is appended to the end of the reranked list. The -- maximum is 500. -- -- $sel:userId:GetPersonalizedRanking', -- getPersonalizedRanking_userId - The user for which you want the -- campaign to provide a personalized ranking. newGetPersonalizedRanking :: Text -> Text -> GetPersonalizedRanking -- | 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. getPersonalizedRanking_context :: Lens' GetPersonalizedRanking (Maybe (HashMap Text Text)) -- | The Amazon Resource Name (ARN) of a filter you created to include -- items or exclude items from recommendations for a given user. For more -- information, see Filtering Recommendations. getPersonalizedRanking_filterArn :: Lens' GetPersonalizedRanking (Maybe Text) -- | 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. getPersonalizedRanking_filterValues :: Lens' GetPersonalizedRanking (Maybe (HashMap Text Text)) -- | The Amazon Resource Name (ARN) of the campaign to use for generating -- the personalized ranking. getPersonalizedRanking_campaignArn :: Lens' GetPersonalizedRanking Text -- | A list of items (by itemId) to rank. If an item was not -- included in the training dataset, the item is appended to the end of -- the reranked list. The maximum is 500. getPersonalizedRanking_inputList :: Lens' GetPersonalizedRanking [Text] -- | The user for which you want the campaign to provide a personalized -- ranking. getPersonalizedRanking_userId :: Lens' GetPersonalizedRanking Text -- | See: newGetPersonalizedRankingResponse smart -- constructor. data GetPersonalizedRankingResponse GetPersonalizedRankingResponse' :: Maybe [PredictedItem] -> Maybe Text -> Int -> GetPersonalizedRankingResponse -- | A list of items in order of most likely interest to the user. The -- maximum is 500. [$sel:personalizedRanking:GetPersonalizedRankingResponse'] :: GetPersonalizedRankingResponse -> Maybe [PredictedItem] -- | The ID of the recommendation. [$sel:recommendationId:GetPersonalizedRankingResponse'] :: GetPersonalizedRankingResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:GetPersonalizedRankingResponse'] :: GetPersonalizedRankingResponse -> Int -- | Create a value of GetPersonalizedRankingResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:personalizedRanking:GetPersonalizedRankingResponse', -- getPersonalizedRankingResponse_personalizedRanking - A list of -- items in order of most likely interest to the user. The maximum is -- 500. -- -- $sel:recommendationId:GetPersonalizedRankingResponse', -- getPersonalizedRankingResponse_recommendationId - The ID of the -- recommendation. -- -- $sel:httpStatus:GetPersonalizedRankingResponse', -- getPersonalizedRankingResponse_httpStatus - The response's http -- status code. newGetPersonalizedRankingResponse :: Int -> GetPersonalizedRankingResponse -- | A list of items in order of most likely interest to the user. The -- maximum is 500. getPersonalizedRankingResponse_personalizedRanking :: Lens' GetPersonalizedRankingResponse (Maybe [PredictedItem]) -- | The ID of the recommendation. getPersonalizedRankingResponse_recommendationId :: Lens' GetPersonalizedRankingResponse (Maybe Text) -- | The response's http status code. getPersonalizedRankingResponse_httpStatus :: Lens' GetPersonalizedRankingResponse Int instance GHC.Generics.Generic Amazonka.PersonalizeRuntime.GetPersonalizedRanking.GetPersonalizedRanking instance GHC.Show.Show Amazonka.PersonalizeRuntime.GetPersonalizedRanking.GetPersonalizedRanking instance GHC.Classes.Eq Amazonka.PersonalizeRuntime.GetPersonalizedRanking.GetPersonalizedRanking instance GHC.Generics.Generic Amazonka.PersonalizeRuntime.GetPersonalizedRanking.GetPersonalizedRankingResponse instance GHC.Show.Show Amazonka.PersonalizeRuntime.GetPersonalizedRanking.GetPersonalizedRankingResponse instance GHC.Read.Read Amazonka.PersonalizeRuntime.GetPersonalizedRanking.GetPersonalizedRankingResponse instance GHC.Classes.Eq Amazonka.PersonalizeRuntime.GetPersonalizedRanking.GetPersonalizedRankingResponse instance Amazonka.Types.AWSRequest Amazonka.PersonalizeRuntime.GetPersonalizedRanking.GetPersonalizedRanking instance Control.DeepSeq.NFData Amazonka.PersonalizeRuntime.GetPersonalizedRanking.GetPersonalizedRankingResponse instance Data.Hashable.Class.Hashable Amazonka.PersonalizeRuntime.GetPersonalizedRanking.GetPersonalizedRanking instance Control.DeepSeq.NFData Amazonka.PersonalizeRuntime.GetPersonalizedRanking.GetPersonalizedRanking instance Amazonka.Data.Headers.ToHeaders Amazonka.PersonalizeRuntime.GetPersonalizedRanking.GetPersonalizedRanking instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.PersonalizeRuntime.GetPersonalizedRanking.GetPersonalizedRanking instance Amazonka.Data.Path.ToPath Amazonka.PersonalizeRuntime.GetPersonalizedRanking.GetPersonalizedRanking instance Amazonka.Data.Query.ToQuery Amazonka.PersonalizeRuntime.GetPersonalizedRanking.GetPersonalizedRanking module Amazonka.PersonalizeRuntime.Lens -- | 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. getPersonalizedRanking_context :: Lens' GetPersonalizedRanking (Maybe (HashMap Text Text)) -- | The Amazon Resource Name (ARN) of a filter you created to include -- items or exclude items from recommendations for a given user. For more -- information, see Filtering Recommendations. getPersonalizedRanking_filterArn :: Lens' GetPersonalizedRanking (Maybe Text) -- | 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. getPersonalizedRanking_filterValues :: Lens' GetPersonalizedRanking (Maybe (HashMap Text Text)) -- | The Amazon Resource Name (ARN) of the campaign to use for generating -- the personalized ranking. getPersonalizedRanking_campaignArn :: Lens' GetPersonalizedRanking Text -- | A list of items (by itemId) to rank. If an item was not -- included in the training dataset, the item is appended to the end of -- the reranked list. The maximum is 500. getPersonalizedRanking_inputList :: Lens' GetPersonalizedRanking [Text] -- | The user for which you want the campaign to provide a personalized -- ranking. getPersonalizedRanking_userId :: Lens' GetPersonalizedRanking Text -- | A list of items in order of most likely interest to the user. The -- maximum is 500. getPersonalizedRankingResponse_personalizedRanking :: Lens' GetPersonalizedRankingResponse (Maybe [PredictedItem]) -- | The ID of the recommendation. getPersonalizedRankingResponse_recommendationId :: Lens' GetPersonalizedRankingResponse (Maybe Text) -- | The response's http status code. getPersonalizedRankingResponse_httpStatus :: Lens' GetPersonalizedRankingResponse Int -- | The Amazon Resource Name (ARN) of the campaign to use for getting -- recommendations. getRecommendations_campaignArn :: Lens' GetRecommendations (Maybe Text) -- | 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. getRecommendations_context :: Lens' GetRecommendations (Maybe (HashMap Text Text)) -- | 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. getRecommendations_filterArn :: Lens' GetRecommendations (Maybe Text) -- | 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 and user -- segments. getRecommendations_filterValues :: Lens' GetRecommendations (Maybe (HashMap Text Text)) -- | The item ID to provide recommendations for. -- -- Required for RELATED_ITEMS recipe type. getRecommendations_itemId :: Lens' GetRecommendations (Maybe Text) -- | The number of results to return. The default is 25. The maximum is -- 500. getRecommendations_numResults :: Lens' GetRecommendations (Maybe Natural) -- | The promotions to apply to the recommendation request. A promotion -- defines additional business rules that apply to a configurable subset -- of recommended items. getRecommendations_promotions :: Lens' GetRecommendations (Maybe [Promotion]) -- | The Amazon Resource Name (ARN) of the recommender to use to get -- recommendations. Provide a recommender ARN if you created a Domain -- dataset group with a recommender for a domain use case. getRecommendations_recommenderArn :: Lens' GetRecommendations (Maybe Text) -- | The user ID to provide recommendations for. -- -- Required for USER_PERSONALIZATION recipe type. getRecommendations_userId :: Lens' GetRecommendations (Maybe Text) -- | A list of recommendations sorted in descending order by prediction -- score. There can be a maximum of 500 items in the list. getRecommendationsResponse_itemList :: Lens' GetRecommendationsResponse (Maybe [PredictedItem]) -- | The ID of the recommendation. getRecommendationsResponse_recommendationId :: Lens' GetRecommendationsResponse (Maybe Text) -- | The response's http status code. getRecommendationsResponse_httpStatus :: Lens' GetRecommendationsResponse Int -- | The recommended item ID. predictedItem_itemId :: Lens' PredictedItem (Maybe Text) -- | The name of the promotion that included the predicted item. predictedItem_promotionName :: Lens' PredictedItem (Maybe Text) -- | A numeric representation of the model's certainty that the item will -- be the next user selection. For more information on scoring logic, see -- how-scores-work. predictedItem_score :: Lens' PredictedItem (Maybe Double) -- | 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. promotion_filterArn :: Lens' Promotion (Maybe Text) -- | 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. promotion_filterValues :: Lens' Promotion (Maybe (HashMap Text Text)) -- | The name of the promotion. promotion_name :: Lens' Promotion (Maybe Text) -- | The percentage of recommended items to apply the promotion to. promotion_percentPromotedItems :: Lens' Promotion (Maybe Natural) module Amazonka.PersonalizeRuntime.Waiters -- | Derived from API version 2018-05-22 of the AWS service -- descriptions, licensed under Apache 2.0. module Amazonka.PersonalizeRuntime -- | API version 2018-05-22 of the Amazon Personalize Runtime SDK -- configuration. defaultService :: Service -- | Provide a valid value for the field or parameter. _InvalidInputException :: AsError a => Fold a ServiceError -- | The specified resource does not exist. _ResourceNotFoundException :: AsError a => Fold a ServiceError -- | See: newGetPersonalizedRanking smart constructor. data GetPersonalizedRanking GetPersonalizedRanking' :: Maybe (HashMap Text (Sensitive Text)) -> Maybe Text -> Maybe (HashMap Text (Sensitive Text)) -> Text -> [Text] -> Text -> GetPersonalizedRanking -- | Create a value of GetPersonalizedRanking with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:context:GetPersonalizedRanking', -- getPersonalizedRanking_context - 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. -- -- GetPersonalizedRanking, getPersonalizedRanking_filterArn -- - The Amazon Resource Name (ARN) of a filter you created to include -- items or exclude items from recommendations for a given user. For more -- information, see Filtering Recommendations. -- -- GetPersonalizedRanking, -- getPersonalizedRanking_filterValues - 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. -- -- $sel:campaignArn:GetPersonalizedRanking', -- getPersonalizedRanking_campaignArn - The Amazon Resource Name -- (ARN) of the campaign to use for generating the personalized ranking. -- -- $sel:inputList:GetPersonalizedRanking', -- getPersonalizedRanking_inputList - A list of items (by -- itemId) to rank. If an item was not included in the training -- dataset, the item is appended to the end of the reranked list. The -- maximum is 500. -- -- $sel:userId:GetPersonalizedRanking', -- getPersonalizedRanking_userId - The user for which you want the -- campaign to provide a personalized ranking. newGetPersonalizedRanking :: Text -> Text -> GetPersonalizedRanking -- | See: newGetPersonalizedRankingResponse smart -- constructor. data GetPersonalizedRankingResponse GetPersonalizedRankingResponse' :: Maybe [PredictedItem] -> Maybe Text -> Int -> GetPersonalizedRankingResponse -- | Create a value of GetPersonalizedRankingResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:personalizedRanking:GetPersonalizedRankingResponse', -- getPersonalizedRankingResponse_personalizedRanking - A list of -- items in order of most likely interest to the user. The maximum is -- 500. -- -- $sel:recommendationId:GetPersonalizedRankingResponse', -- getPersonalizedRankingResponse_recommendationId - The ID of the -- recommendation. -- -- $sel:httpStatus:GetPersonalizedRankingResponse', -- getPersonalizedRankingResponse_httpStatus - The response's http -- status code. newGetPersonalizedRankingResponse :: Int -> GetPersonalizedRankingResponse -- | See: newGetRecommendations smart constructor. data GetRecommendations GetRecommendations' :: Maybe Text -> Maybe (HashMap Text (Sensitive Text)) -> Maybe Text -> Maybe (HashMap Text (Sensitive Text)) -> Maybe Text -> Maybe Natural -> Maybe [Promotion] -> Maybe Text -> Maybe Text -> GetRecommendations -- | Create a value of GetRecommendations with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:campaignArn:GetRecommendations', -- getRecommendations_campaignArn - The Amazon Resource Name (ARN) -- of the campaign to use for getting recommendations. -- -- $sel:context:GetRecommendations', -- getRecommendations_context - 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. -- -- GetRecommendations, getRecommendations_filterArn - 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. -- -- GetRecommendations, getRecommendations_filterValues - -- 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 and user -- segments. -- -- GetRecommendations, getRecommendations_itemId - The item -- ID to provide recommendations for. -- -- Required for RELATED_ITEMS recipe type. -- -- $sel:numResults:GetRecommendations', -- getRecommendations_numResults - The number of results to -- return. The default is 25. The maximum is 500. -- -- $sel:promotions:GetRecommendations', -- getRecommendations_promotions - The promotions to apply to the -- recommendation request. A promotion defines additional business rules -- that apply to a configurable subset of recommended items. -- -- $sel:recommenderArn:GetRecommendations', -- getRecommendations_recommenderArn - The Amazon Resource Name -- (ARN) of the recommender to use to get recommendations. Provide a -- recommender ARN if you created a Domain dataset group with a -- recommender for a domain use case. -- -- $sel:userId:GetRecommendations', -- getRecommendations_userId - The user ID to provide -- recommendations for. -- -- Required for USER_PERSONALIZATION recipe type. newGetRecommendations :: GetRecommendations -- | See: newGetRecommendationsResponse smart constructor. data GetRecommendationsResponse GetRecommendationsResponse' :: Maybe [PredictedItem] -> Maybe Text -> Int -> GetRecommendationsResponse -- | Create a value of GetRecommendationsResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:itemList:GetRecommendationsResponse', -- getRecommendationsResponse_itemList - A list of recommendations -- sorted in descending order by prediction score. There can be a maximum -- of 500 items in the list. -- -- $sel:recommendationId:GetRecommendationsResponse', -- getRecommendationsResponse_recommendationId - The ID of the -- recommendation. -- -- $sel:httpStatus:GetRecommendationsResponse', -- getRecommendationsResponse_httpStatus - The response's http -- status code. newGetRecommendationsResponse :: Int -> GetRecommendationsResponse -- | An object that identifies an item. -- -- The and APIs return a list of PredictedItems. -- -- See: newPredictedItem smart constructor. data PredictedItem PredictedItem' :: Maybe Text -> Maybe Text -> Maybe Double -> PredictedItem -- | Create a value of PredictedItem with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:itemId:PredictedItem', predictedItem_itemId - The -- recommended item ID. -- -- $sel:promotionName:PredictedItem', -- predictedItem_promotionName - The name of the promotion that -- included the predicted item. -- -- $sel:score:PredictedItem', predictedItem_score - A -- numeric representation of the model's certainty that the item will be -- the next user selection. For more information on scoring logic, see -- how-scores-work. newPredictedItem :: PredictedItem -- | Contains information on a promotion. A promotion defines additional -- business rules that apply to a configurable subset of recommended -- items. -- -- See: newPromotion smart constructor. data Promotion Promotion' :: Maybe Text -> Maybe (HashMap Text (Sensitive Text)) -> Maybe Text -> Maybe Natural -> Promotion -- | Create a value of Promotion with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filterArn:Promotion', promotion_filterArn - 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. -- -- $sel:filterValues:Promotion', promotion_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. -- -- $sel:name:Promotion', promotion_name - The name of the -- promotion. -- -- $sel:percentPromotedItems:Promotion', -- promotion_percentPromotedItems - The percentage of recommended -- items to apply the promotion to. newPromotion :: Promotion