Amazonka.PersonalizeEvents.Types.Item

Documentation

data Item

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 (Sensitive 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

ToJSON Item

Defined in Amazonka.PersonalizeEvents.Types.Item

Methods

toJSON :: Item -> Value

toEncoding :: Item -> Encoding

toJSONList :: [Item] -> Value

toEncodingList :: [Item] -> Encoding

Generic Item

Defined in Amazonka.PersonalizeEvents.Types.Item

Associated Types

type Rep Item :: Type -> Type

Methods

from :: Item -> Rep Item x

to :: Rep Item x -> Item

Show Item

Defined in Amazonka.PersonalizeEvents.Types.Item

Methods

showsPrec :: Int -> Item -> ShowS

show :: Item -> String

showList :: [Item] -> ShowS

NFData Item

Defined in Amazonka.PersonalizeEvents.Types.Item

Methods

rnf :: Item -> ()

Eq Item

Defined in Amazonka.PersonalizeEvents.Types.Item

Methods

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

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

Hashable Item

Defined in Amazonka.PersonalizeEvents.Types.Item

Methods

hashWithSalt :: Int -> Item -> Int

hash :: Item -> Int

type Rep Item

Defined in Amazonka.PersonalizeEvents.Types.Item

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

newItem

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)

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

The ID associated with the item.