Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.PersonalizeEvents.PutEvents

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Records user interaction event data. For more information see Recording Events.

Synopsis

data PutEvents = PutEvents' {
- userId :: Maybe (Sensitive Text)
- trackingId :: Text
- sessionId :: Text
- eventList :: NonEmpty (Sensitive Event)
}
newPutEvents :: Text -> Text -> NonEmpty Event -> PutEvents
putEvents_userId :: Lens' PutEvents (Maybe Text)
putEvents_trackingId :: Lens' PutEvents Text
putEvents_sessionId :: Lens' PutEvents Text
putEvents_eventList :: Lens' PutEvents (NonEmpty Event)
data PutEventsResponse = PutEventsResponse' {
}
newPutEventsResponse :: PutEventsResponse

Creating a Request

data PutEvents Source #

See: newPutEvents smart constructor.

Constructors

PutEvents'

Fields

userId :: Maybe (Sensitive Text)
The user associated with the event.
trackingId :: Text
The tracking ID for the event. The ID is generated by a call to the CreateEventTracker API.
sessionId :: Text
The session ID associated with the user's visit. Your application generates the sessionId when a user first visits your website or uses your application. Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information, see Recording Events.
eventList :: NonEmpty (Sensitive Event)
A list of event data from the session.

Instances

Instances details

ToJSON PutEvents Source #
Instance details Defined in Amazonka.PersonalizeEvents.PutEvents Methods toJSON :: PutEvents -> Value # toEncoding :: PutEvents -> Encoding # toJSONList :: [PutEvents] -> Value # toEncodingList :: [PutEvents] -> Encoding #
ToHeaders PutEvents Source #
Instance details Defined in Amazonka.PersonalizeEvents.PutEvents Methods toHeaders :: PutEvents -> [Header] #
ToPath PutEvents Source #
Instance details Defined in Amazonka.PersonalizeEvents.PutEvents Methods toPath :: PutEvents -> ByteString #
ToQuery PutEvents Source #
Instance details Defined in Amazonka.PersonalizeEvents.PutEvents Methods toQuery :: PutEvents -> QueryString #
AWSRequest PutEvents Source #
Instance details Defined in Amazonka.PersonalizeEvents.PutEvents Associated Types type AWSResponse PutEvents # Methods request :: (Service -> Service) -> PutEvents -> Request PutEvents # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutEvents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutEvents))) #
Generic PutEvents Source #
Instance details Defined in Amazonka.PersonalizeEvents.PutEvents Associated Types type Rep PutEvents :: Type -> Type # Methods from :: PutEvents -> Rep PutEvents x # to :: Rep PutEvents x -> PutEvents #
Show PutEvents Source #
Instance details Defined in Amazonka.PersonalizeEvents.PutEvents Methods showsPrec :: Int -> PutEvents -> ShowS # show :: PutEvents -> String # showList :: [PutEvents] -> ShowS #
NFData PutEvents Source #
Instance details Defined in Amazonka.PersonalizeEvents.PutEvents Methods rnf :: PutEvents -> () #
Eq PutEvents Source #
Instance details Defined in Amazonka.PersonalizeEvents.PutEvents Methods (==) :: PutEvents -> PutEvents -> Bool # (/=) :: PutEvents -> PutEvents -> Bool #
Hashable PutEvents Source #
Instance details Defined in Amazonka.PersonalizeEvents.PutEvents Methods hashWithSalt :: Int -> PutEvents -> Int # hash :: PutEvents -> Int #
type AWSResponse PutEvents Source #
Instance details Defined in Amazonka.PersonalizeEvents.PutEvents type AWSResponse PutEvents = PutEventsResponse
type Rep PutEvents Source #
Instance details Defined in Amazonka.PersonalizeEvents.PutEvents type Rep PutEvents = D1 ('MetaData "PutEvents" "Amazonka.PersonalizeEvents.PutEvents" "amazonka-personalize-events-2.0-Fi47jZEjr1NizLD1LiiPl" 'False) (C1 ('MetaCons "PutEvents'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "trackingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "eventList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty (Sensitive Event))))))

newPutEvents Source #

Arguments

:: Text	`$sel:trackingId:PutEvents'`
-> Text	`$sel:sessionId:PutEvents'`
-> NonEmpty Event	`$sel:eventList:PutEvents'`
-> PutEvents

Create a value of PutEvents 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:

PutEvents, putEvents_userId - The user associated with the event.

$sel:trackingId:PutEvents', putEvents_trackingId - The tracking ID for the event. The ID is generated by a call to the CreateEventTracker API.

$sel:sessionId:PutEvents', putEvents_sessionId - The session ID associated with the user's visit. Your application generates the sessionId when a user first visits your website or uses your application. Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information, see Recording Events.

$sel:eventList:PutEvents', putEvents_eventList - A list of event data from the session.

Request Lenses

putEvents_userId :: Lens' PutEvents (Maybe Text) Source #

The user associated with the event.

putEvents_trackingId :: Lens' PutEvents Text Source #

The tracking ID for the event. The ID is generated by a call to the CreateEventTracker API.

putEvents_sessionId :: Lens' PutEvents Text Source #

The session ID associated with the user's visit. Your application generates the sessionId when a user first visits your website or uses your application. Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information, see Recording Events.

putEvents_eventList :: Lens' PutEvents (NonEmpty Event) Source #

A list of event data from the session.

Destructuring the Response

data PutEventsResponse Source #

See: newPutEventsResponse smart constructor.

Constructors

PutEventsResponse'

Instances

Instances details

Generic PutEventsResponse Source #
Instance details Defined in Amazonka.PersonalizeEvents.PutEvents Associated Types type Rep PutEventsResponse :: Type -> Type # Methods from :: PutEventsResponse -> Rep PutEventsResponse x # to :: Rep PutEventsResponse x -> PutEventsResponse #
Read PutEventsResponse Source #
Instance details Defined in Amazonka.PersonalizeEvents.PutEvents Methods readsPrec :: Int -> ReadS PutEventsResponse # readList :: ReadS [PutEventsResponse] # readPrec :: ReadPrec PutEventsResponse # readListPrec :: ReadPrec [PutEventsResponse] #
Show PutEventsResponse Source #
Instance details Defined in Amazonka.PersonalizeEvents.PutEvents Methods showsPrec :: Int -> PutEventsResponse -> ShowS # show :: PutEventsResponse -> String # showList :: [PutEventsResponse] -> ShowS #
NFData PutEventsResponse Source #
Instance details Defined in Amazonka.PersonalizeEvents.PutEvents Methods rnf :: PutEventsResponse -> () #
Eq PutEventsResponse Source #
Instance details Defined in Amazonka.PersonalizeEvents.PutEvents Methods (==) :: PutEventsResponse -> PutEventsResponse -> Bool # (/=) :: PutEventsResponse -> PutEventsResponse -> Bool #
type Rep PutEventsResponse Source #
Instance details Defined in Amazonka.PersonalizeEvents.PutEvents type Rep PutEventsResponse = D1 ('MetaData "PutEventsResponse" "Amazonka.PersonalizeEvents.PutEvents" "amazonka-personalize-events-2.0-Fi47jZEjr1NizLD1LiiPl" 'False) (C1 ('MetaCons "PutEventsResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutEventsResponse :: PutEventsResponse Source #

Create a value of PutEventsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.