Class: Aws::PersonalizeEvents::Types::User

Inherits:

Struct

Object
Struct
Aws::PersonalizeEvents::Types::User

show all

Defined in:: gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb

Overview

Note:

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

{
  user_id: "StringType", # required
  properties: "UserProperties",
}

Represents user metadata added to a Users dataset using the PutUsers API. For more information see Importing Users Incrementally.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#properties ⇒ String
A string map of user-specific metadata.
#user_id ⇒ String
The ID associated with the user.

Instance Attribute Details

#properties ⇒ `String`

A string map of user-specific metadata. Each element in the map consists of a key-value pair. For example, \{"numberOfVideosWatched": "45"\}.

The keys use camel case names that match the fields in the schema for the Users dataset. In the previous example, the numberOfVideosWatched matches the 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema. For categorical string data, to include multiple categories for a single user, separate each category with a pipe separator (|). For example, "Member|Frequent shopper".

Returns:

(String)

# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 338

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

#user_id ⇒ `String`

The ID associated with the user.