Serialized Form

Package com.amazonaws.services.personalizeevents.model

Class com.amazonaws.services.personalizeevents.model.AmazonPersonalizeEventsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.personalizeevents.model.Event extends Object implements Serializable

Serialized Fields

eventId

String eventId

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

String eventType

The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of your Interactions schema and depends on the types of events you are tracking.

eventValue

Float eventValue

The event value that corresponds to the EVENT_VALUE field of the Interactions schema.

itemId

String itemId

The item ID key that corresponds to the ITEM_ID field of the Interactions schema.

properties

String properties

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 numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema.

sentAt

Date sentAt

The timestamp (in Unix time) on the client side when the event occurred.

recommendationId

String recommendationId

The ID of the list of recommendations that contains the item the user interacted with. Provide a recommendationId to have Amazon Personalize implicitly record the recommendations you show your user as impressions data. Or provide a recommendationId if 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.

impression

List<E> impression

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.

metricAttribution

MetricAttribution metricAttribution

Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.

Class com.amazonaws.services.personalizeevents.model.InvalidInputException extends AmazonPersonalizeEventsException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.personalizeevents.model.Item extends Object implements Serializable

Serialized Fields

itemId

String itemId

The ID associated with the item.

properties

String properties

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

Class com.amazonaws.services.personalizeevents.model.MetricAttribution extends Object implements Serializable

Serialized Fields

eventAttributionSource

String eventAttributionSource

The source of the event, such as a third party.

Class com.amazonaws.services.personalizeevents.model.PutEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

trackingId

String trackingId

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

userId

String userId

The user associated with the event.

sessionId

String 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.

eventList

List<E> eventList

A list of event data from the session.

Class com.amazonaws.services.personalizeevents.model.PutEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.personalizeevents.model.PutItemsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

datasetArn

String datasetArn

The Amazon Resource Name (ARN) of the Items dataset you are adding the item or items to.

items

List<E> items

A list of item data.

Class com.amazonaws.services.personalizeevents.model.PutItemsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.personalizeevents.model.PutUsersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

datasetArn

String datasetArn

The Amazon Resource Name (ARN) of the Users dataset you are adding the user or users to.

users

List<E> users

A list of user data.

Class com.amazonaws.services.personalizeevents.model.PutUsersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.personalizeevents.model.ResourceInUseException extends AmazonPersonalizeEventsException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.personalizeevents.model.ResourceNotFoundException extends AmazonPersonalizeEventsException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.personalizeevents.model.User extends Object implements Serializable

Serialized Fields

userId

String userId

The ID associated with the user.

properties

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