Class: Aws::PersonalizeEvents::Types::Item

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb

Overview

Note:

When making an API call, you may pass Item data as a hash:

{
  item_id: "StringType", # required
  properties: "ItemProperties",
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#item_idString

The ID associated with the item.

Returns:

  • (String)


147
148
149
150
151
152
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 147

class Item < Struct.new(
  :item_id,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end

#propertiesString

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".

Returns:

  • (String)


147
148
149
150
151
152
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 147

class Item < Struct.new(
  :item_id,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end