Amazon Personalize Events 2018-03-22
- Client: Aws\PersonalizeEvents\PersonalizeEventsClient
- Service ID: personalize-events
- Version: 2018-03-22
This page describes the parameters and results for the operations of the Amazon Personalize Events (2018-03-22), and shows how to use the Aws\PersonalizeEvents\PersonalizeEventsClient object to call the described operations. This documentation is specific to the 2018-03-22 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- PutEvents ( array $params = [] )
Records user interaction event data.
Operations
PutEvents
$result = $client->putEvents([/* ... */]); $promise = $client->putEventsAsync([/* ... */]);
Records user interaction event data.
Parameter Syntax
$result = $client->putEvents([
'eventList' => [ // REQUIRED
[
'eventId' => '<string>',
'eventType' => '<string>', // REQUIRED
'properties' => '<string>', // REQUIRED
'sentAt' => <integer || string || DateTime>, // REQUIRED
],
// ...
],
'sessionId' => '<string>', // REQUIRED
'trackingId' => '<string>', // REQUIRED
'userId' => '<string>',
]);
Parameter Details
Members
- eventList
-
- Required: Yes
- Type: Array of Event structures
A list of event data from the session.
- sessionId
-
- Required: Yes
- Type: string
The session ID associated with the user's visit.
- trackingId
-
- Required: Yes
- Type: string
The tracking ID for the event. The ID is generated by a call to the CreateEventTracker API.
- userId
-
- Type: string
The user associated with the event.
Result Syntax
[]
Result Details
Errors
-
Provide a valid value for the field or parameter.
Shapes
Event
Description
Represents user interaction event information sent using the PutEvents API.
Members
- eventId
-
- Type: string
An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinquish unique events. Any subsequent events after the first with the same event ID are not used in model training.
- eventType
-
- Required: Yes
- Type: string
The type of event. This property corresponds to the
EVENT_TYPEfield of the Interactions schema. - properties
-
- Required: Yes
- Type: string (string|number|array|map or anything parsable by json_encode)
A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, you might send the movie ID and rating, and the number of movie ratings made by the user.
Each item in the map consists of a key-value pair. For example,
{"itemId": "movie1"}{"itemId": "movie2", "eventValue": "4.5"}{"itemId": "movie3", "eventValue": "3", "numberOfRatings": "12"}The keys use camel case names that match the fields in the Interactions schema. The
itemIdandeventValuekeys correspond to theITEM_IDandEVENT_VALUEfields. In the above example, theeventTypemight be 'MovieRating' witheventValuebeing the rating. ThenumberOfRatingswould match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema. - sentAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp on the client side when the event occurred.
