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.
- PutItems ( array $params = [] )
Adds one or more items to an Items dataset.
- PutUsers ( array $params = [] )
Adds one or more users to a Users dataset.
Operations
PutEvents
$result = $client->putEvents([/* ... */]); $promise = $client->putEventsAsync([/* ... */]);
Records user interaction event data. For more information see Recording Events.
Parameter Syntax
$result = $client->putEvents([
'eventList' => [ // REQUIRED
[
'eventId' => '<string>',
'eventType' => '<string>', // REQUIRED
'eventValue' => <float>,
'impression' => ['<string>', ...],
'itemId' => '<string>',
'metricAttribution' => [
'eventAttributionSource' => '<string>', // REQUIRED
],
'properties' => '<string>',
'recommendationId' => '<string>',
'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. 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.
- 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.
PutItems
$result = $client->putItems([/* ... */]); $promise = $client->putItemsAsync([/* ... */]);
Adds one or more items to an Items dataset. For more information see Importing Items Incrementally.
Parameter Syntax
$result = $client->putItems([
'datasetArn' => '<string>', // REQUIRED
'items' => [ // REQUIRED
[
'itemId' => '<string>', // REQUIRED
'properties' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- datasetArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Items dataset you are adding the item or items to.
- items
-
- Required: Yes
- Type: Array of Item structures
A list of item data.
Result Syntax
[]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The specified resource is in use.
PutUsers
$result = $client->putUsers([/* ... */]); $promise = $client->putUsersAsync([/* ... */]);
Adds one or more users to a Users dataset. For more information see Importing Users Incrementally.
Parameter Syntax
$result = $client->putUsers([
'datasetArn' => '<string>', // REQUIRED
'users' => [ // REQUIRED
[
'properties' => '<string>',
'userId' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- datasetArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Users dataset you are adding the user or users to.
- users
-
- Required: Yes
- Type: Array of User structures
A list of user data.
Result Syntax
[]
Result Details
Errors
-
Provide a valid value for the field or parameter.
-
Could not find the specified resource.
-
The specified resource is in use.
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, such as click or download. This property corresponds to the
EVENT_TYPEfield of your Interactions schema and depends on the types of events you are tracking. - eventValue
-
- Type: float
The event value that corresponds to the
EVENT_VALUEfield of the Interactions schema. - impression
-
- Type: Array of strings
A list of item IDs that represents the sequence of items you have shown the user. For example,
["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions data for an event. For more information on recording impressions data, see Recording impressions data. - itemId
-
- Type: string
The item ID key that corresponds to the
ITEM_IDfield of the Interactions schema. - metricAttribution
-
- Type: MetricAttribution structure
Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.
- properties
-
- 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, other than movie ID (
itemId) and rating (eventValue) , you might also send the number of movie ratings made by the user.Each item 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 Interactions schema. In the above example, the
numberOfRatingswould match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema. - recommendationId
-
- Type: string
The ID of the list of recommendations that contains the item the user interacted with. Provide a
recommendationIdto have Amazon Personalize implicitly record the recommendations you show your user as impressions data. Or provide arecommendationIdif you use a metric attribution to measure the impact of recommendations.For more information on recording impressions data, see Recording impressions data. For more information on creating a metric attribution see Measuring impact of recommendations.
- sentAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp (in Unix time) on the client side when the event occurred.
InvalidInputException
Description
Provide a valid value for the field or parameter.
Members
- message
-
- Type: string
Item
Description
Represents item metadata added to an Items dataset using the PutItems API. For more information see Importing Items Incrementally.
Members
- itemId
-
- Required: Yes
- Type: string
The ID associated with the item.
- properties
-
- Type: string (string|number|array|map or anything parsable by json_encode)
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
numberOfRatingsmatches 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\".
MetricAttribution
Description
Contains information about a metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.
Members
- eventAttributionSource
-
- Required: Yes
- Type: string
The source of the event, such as a third party.
ResourceInUseException
Description
The specified resource is in use.
Members
- message
-
- Type: string
ResourceNotFoundException
Description
Could not find the specified resource.
Members
- message
-
- Type: string
User
Description
Represents user metadata added to a Users dataset using the PutUsers API. For more information see Importing Users Incrementally.
Members
- properties
-
- Type: string (string|number|array|map or anything parsable by json_encode)
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
numberOfVideosWatchedmatches 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
-
- Required: Yes
- Type: string
The ID associated with the user.