Amazonka.PersonalizeEvents.Types.User

Documentation

data User

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

See: newUser smart constructor.

Constructors

User'

Fields

• properties :: Maybe (Sensitive Text)

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

• userId :: Text

  The ID associated with the user.

Instances

ToJSON User

Defined in Amazonka.PersonalizeEvents.Types.User

Methods

toJSON :: User -> Value

toEncoding :: User -> Encoding

toJSONList :: [User] -> Value

toEncodingList :: [User] -> Encoding

Generic User

Defined in Amazonka.PersonalizeEvents.Types.User

Associated Types

type Rep User :: Type -> Type

Methods

from :: User -> Rep User x

to :: Rep User x -> User

Show User

Defined in Amazonka.PersonalizeEvents.Types.User

Methods

showsPrec :: Int -> User -> ShowS

show :: User -> String

showList :: [User] -> ShowS

NFData User

Defined in Amazonka.PersonalizeEvents.Types.User

Methods

rnf :: User -> ()

Eq User

Defined in Amazonka.PersonalizeEvents.Types.User

Methods

(==) :: User -> User -> Bool

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

Hashable User

Defined in Amazonka.PersonalizeEvents.Types.User

Methods

hashWithSalt :: Int -> User -> Int

hash :: User -> Int

type Rep User

Defined in Amazonka.PersonalizeEvents.Types.User

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

newUser

Arguments

:: Text

$sel:userId:User'

-> User

Create a value of User 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:User', user_properties - 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\".

$sel:userId:User', user_userId - The ID associated with the user.

user_properties :: Lens' User (Maybe Text)

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

user_userId :: Lens' User Text

The ID associated with the user.