amazonka-personalize-runtime-2.0: Amazon Personalize Runtime SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.PersonalizeRuntime.Types

Description

 
Synopsis

Service Configuration

defaultService :: Service Source #

API version 2018-05-22 of the Amazon Personalize Runtime SDK configuration.

Errors

_InvalidInputException :: AsError a => Fold a ServiceError Source #

Provide a valid value for the field or parameter.

_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #

The specified resource does not exist.

PredictedItem

data PredictedItem Source #

An object that identifies an item.

The and APIs return a list of PredictedItems.

See: newPredictedItem smart constructor.

Constructors

PredictedItem' 

Fields

  • itemId :: Maybe Text

    The recommended item ID.

  • promotionName :: Maybe Text

    The name of the promotion that included the predicted item.

  • score :: Maybe Double

    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.

Instances

Instances details
FromJSON PredictedItem Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

Generic PredictedItem Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

Associated Types

type Rep PredictedItem :: Type -> Type #

Read PredictedItem Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

Show PredictedItem Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

NFData PredictedItem Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

Methods

rnf :: PredictedItem -> () #

Eq PredictedItem Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

Hashable PredictedItem Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

type Rep PredictedItem Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.PredictedItem

type Rep PredictedItem = D1 ('MetaData "PredictedItem" "Amazonka.PersonalizeRuntime.Types.PredictedItem" "amazonka-personalize-runtime-2.0-F3C1CsdiQVG5CxrVfC5dKS" 'False) (C1 ('MetaCons "PredictedItem'" 'PrefixI 'True) (S1 ('MetaSel ('Just "itemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "promotionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))))

newPredictedItem :: PredictedItem Source #

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.

predictedItem_promotionName :: Lens' PredictedItem (Maybe Text) Source #

The name of the promotion that included the predicted item.

predictedItem_score :: Lens' PredictedItem (Maybe Double) Source #

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.

Promotion

data Promotion Source #

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

See: newPromotion smart constructor.

Constructors

Promotion' 

Fields

  • filterArn :: Maybe Text

    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.

  • filterValues :: Maybe (HashMap Text (Sensitive 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.

  • name :: Maybe Text

    The name of the promotion.

  • percentPromotedItems :: Maybe Natural

    The percentage of recommended items to apply the promotion to.

Instances

Instances details
ToJSON Promotion Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.Promotion

Generic Promotion Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.Promotion

Associated Types

type Rep Promotion :: Type -> Type #

Show Promotion Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.Promotion

NFData Promotion Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.Promotion

Methods

rnf :: Promotion -> () #

Eq Promotion Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.Promotion

Hashable Promotion Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.Promotion

type Rep Promotion Source # 
Instance details

Defined in Amazonka.PersonalizeRuntime.Types.Promotion

type Rep Promotion = D1 ('MetaData "Promotion" "Amazonka.PersonalizeRuntime.Types.Promotion" "amazonka-personalize-runtime-2.0-F3C1CsdiQVG5CxrVfC5dKS" 'False) (C1 ('MetaCons "Promotion'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "filterValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (Sensitive Text))))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "percentPromotedItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))

newPromotion :: Promotion Source #

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.

promotion_filterArn :: Lens' Promotion (Maybe Text) Source #

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_filterValues :: Lens' Promotion (Maybe (HashMap Text Text)) Source #

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_name :: Lens' Promotion (Maybe Text) Source #

The name of the promotion.

promotion_percentPromotedItems :: Lens' Promotion (Maybe Natural) Source #

The percentage of recommended items to apply the promotion to.