libZSservicesZSamazonka-personalize-eventsZSamazonka-personalize-events
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.PersonalizeEvents.Types.Item

Description

 
Synopsis

Documentation

data Item Source #

Represents item metadata added to an Items dataset using the PutItems API. For more information see Importing Items Incrementally.

See: newItem smart constructor.

Constructors

Item' 

Fields

  • properties :: Maybe Text

    A string map of item-specific metadata. Each element in the map consists of a key-value pair. For example, {"numberOfRatings": "12"}.

    The keys use camel case names that match the fields in the schema for the Items dataset. In the previous example, the numberOfRatings matches the 'NUMBER_OF_RATINGS' field defined in the Items schema. For categorical string data, to include multiple categories for a single item, separate each category with a pipe separator (|). For example, \"Horror|Action\".

  • itemId :: Text

    The ID associated with the item.

Instances

Instances details
Eq Item Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Item

Methods

(==) :: Item -> Item -> Bool #

(/=) :: Item -> Item -> Bool #

Read Item Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Item

Show Item Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Item

Methods

showsPrec :: Int -> Item -> ShowS #

show :: Item -> String #

showList :: [Item] -> ShowS #

Generic Item Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Item

Associated Types

type Rep Item :: Type -> Type #

Methods

from :: Item -> Rep Item x #

to :: Rep Item x -> Item #

NFData Item Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Item

Methods

rnf :: Item -> () #

Hashable Item Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Item

Methods

hashWithSalt :: Int -> Item -> Int #

hash :: Item -> Int #

ToJSON Item Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Item

type Rep Item Source # 
Instance details

Defined in Amazonka.PersonalizeEvents.Types.Item

type Rep Item = D1 ('MetaData "Item" "Amazonka.PersonalizeEvents.Types.Item" "libZSservicesZSamazonka-personalize-eventsZSamazonka-personalize-events" 'False) (C1 ('MetaCons "Item'" 'PrefixI 'True) (S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "itemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newItem Source #

Arguments

:: Text

$sel:itemId:Item'

-> Item 

Create a value of Item 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:properties:Item', item_properties - A string map of item-specific metadata. Each element in the map consists of a key-value pair. For example, {"numberOfRatings": "12"}.

The keys use camel case names that match the fields in the schema for the Items dataset. In the previous example, the numberOfRatings matches the 'NUMBER_OF_RATINGS' field defined in the Items schema. For categorical string data, to include multiple categories for a single item, separate each category with a pipe separator (|). For example, \"Horror|Action\".

$sel:itemId:Item', item_itemId - The ID associated with the item.

item_properties :: Lens' Item (Maybe Text) Source #

A string map of item-specific metadata. Each element in the map consists of a key-value pair. For example, {"numberOfRatings": "12"}.

The keys use camel case names that match the fields in the schema for the Items dataset. In the previous example, the numberOfRatings matches the 'NUMBER_OF_RATINGS' field defined in the Items schema. For categorical string data, to include multiple categories for a single item, separate each category with a pipe separator (|). For example, \"Horror|Action\".

item_itemId :: Lens' Item Text Source #

The ID associated with the item.