Event

public struct Event : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let eventId: String?

  • The type of event. This property corresponds to the EVENT_TYPE field of the Interactions schema.

    Declaration

    Swift

    public let eventType: String

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

    Declaration

    Swift

    public let eventValue: Float?

  • A list of item IDs that represents the sequence of items you have shown the user. For example, [“itemId1”, “itemId2”, “itemId3”].

    Declaration

    Swift

    public let impression: [String]?

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

    Declaration

    Swift

    public let itemId: String?

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

    Declaration

    Swift

    public let properties: String?

  • The ID of the recommendation.

    Declaration

    Swift

    public let recommendationId: String?

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

    Declaration

    Swift

    public let sentAt: TimeStamp

  • Undocumented

    Declaration

    Swift

    public init(eventId: String? = nil, eventType: String, eventValue: Float? = nil, impression: [String]? = nil, itemId: String? = nil, properties: String? = nil, recommendationId: String? = nil, sentAt: TimeStamp)

  • Declaration

    Swift

    public func validate(name: String) throws