Serialized Form

Package com.amazonaws.services.personalizeevents.model

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

Serialized Fields

actionId

String actionId

The ID associated with the action.

properties

String properties

A string map of action-specific metadata. Each element in the map consists of a key-value pair. For example, {"value": "100"}.

The keys use camel case names that match the fields in the schema for the Actions dataset. In the previous example, the value matches the 'VALUE' field defined in the Actions schema. For categorical string data, to include multiple categories for a single action, separate each category with a pipe separator ( |). For example, \"Deluxe|Premium\".

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

Serialized Fields

actionId

String actionId

The ID of the action the user interacted with. This corresponds to the ACTION_ID field of the Action interaction schema.

userId

String userId

The ID of the user who interacted with the action. This corresponds to the USER_ID field of the Action interaction schema.

sessionId

String sessionId

The ID associated with the user's visit. Your application generates a unique sessionId when a user first visits your website or uses your application.

timestamp

Date timestamp

The timestamp for when the action interaction event occurred. Timestamps must be in Unix epoch time format, in seconds.

eventType

String eventType

The type of action interaction event. You can specify Viewed, Taken, and Not Taken event types. For more information about action interaction event type data, see Event type data.

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 distinguish unique events. Any subsequent events after the first with the same event ID are not used in model training.

recommendationId

String recommendationId

The ID of the list of recommendations that contains the action the user interacted with.

impression

List<E> impression

A list of action IDs that represents the sequence of actions you have shown the user. For example, ["actionId1", "actionId2", "actionId3"]. Amazon Personalize doesn't use impressions data from action interaction events. Instead, record multiple events for each action and use the Viewed event type.

properties

String properties

A string map of event-specific data that you might choose to record. For example, if a user takes an action, other than the action ID, you might also send the number of actions taken by the user.

Each item in the map consists of a key-value pair. For example,

{"numberOfActions": "12"}

The keys use camel case names that match the fields in the Action interactions schema. In the above example, the numberOfActions would match the 'NUMBER_OF_ACTIONS' field defined in the Action interactions schema.

The following can't be included as a keyword for properties (case insensitive).

• userId

• sessionId

• eventType

• timestamp

• recommendationId

• impression

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 distinguish 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 Item interactions dataset's 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 Item interactions schema.

itemId

String itemId

The item ID key that corresponds to the ITEM_ID field of the Item interactions dataset's 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 Item interactions dataset's schema. In the above example, the numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Item interactions dataset's schema.

The following can't be included as a keyword for properties (case insensitive).

• userId

• sessionId

• eventType

• timestamp

• recommendationId

• impression

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.PutActionInteractionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

trackingId

String trackingId

The ID of your action interaction event tracker. When you create an Action interactions dataset, Amazon Personalize creates an action interaction event tracker for you. For more information, see Action interaction event tracker ID.

actionInteractions

List<E> actionInteractions

A list of action interaction events from the session.

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

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

Serialized Fields

datasetArn

String datasetArn

The Amazon Resource Name (ARN) of the Actions dataset you are adding the action or actions to.

actions

List<E> actions

A list of action data.

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

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