@datafire/amazonaws_personalize_events v5.0.0

@datafire/amazonaws_personalize_events

Client library for Amazon Personalize Events

Installation and Usage

npm install --save @datafire/amazonaws_personalize_events

let amazonaws_personalize_events = require('@datafire/amazonaws_personalize_events').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Amazon Personalize can consume real-time user event data, such as stream or click data, and use it for model training either alone or combined with historical data. For more information see recording-events.

Actions

PutEvents

amazonaws_personalize_events.PutEvents({
  "trackingId": "",
  "sessionId": "",
  "eventList": []
}, context)

Input

• input object
  • eventList required array: A list of event data from the session.
    • items Event
  • sessionId required 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 event-record-api.
  • trackingId required string: The tracking ID for the event. The ID is generated by a call to the CreateEventTracker API.
  • userId string: The user associated with the event.

Output

Output schema unknown

PutItems

amazonaws_personalize_events.PutItems({
  "datasetArn": "",
  "items": []
}, context)

Input

• input object
  • datasetArn required string: The Amazon Resource Number (ARN) of the Items dataset you are adding the item or items to.
  • items required array: A list of item data.
    • items Item

Output

Output schema unknown

PutUsers

amazonaws_personalize_events.PutUsers({
  "datasetArn": "",
  "users": []
}, context)

Input

• input object
  • datasetArn required string: The Amazon Resource Number (ARN) of the Users dataset you are adding the user or users to.
  • users required array: A list of user data.
    • items User

Output

Output schema unknown

Definitions

Arn

• Arn string

Date

• Date string

Event

• Event object: Represents user interaction event information sent using the PutEvents API.
  • eventId
  • eventType required
  • eventValue
  • impression
    • items ItemId
  • itemId
  • properties
  • recommendationId
  • sentAt required

EventList

• EventList array
  • items Event

EventPropertiesJSON

• EventPropertiesJSON string

FloatType

• FloatType number

Impression

• Impression array
  • items ItemId

InvalidInputException

Item

• Item object: Represents item metadata added to an Items dataset using the PutItems API.
  • itemId required
  • properties

ItemId

• ItemId string

ItemList

• ItemList array
  • items Item

ItemProperties

• ItemProperties string

PutEventsRequest

• PutEventsRequest object
  • eventList required
    • items Event
  • sessionId required
  • trackingId required
  • userId

PutItemsRequest

• PutItemsRequest object
  • datasetArn required
  • items required
    • items Item

PutUsersRequest

• PutUsersRequest object
  • datasetArn required
  • users required
    • items User

RecommendationId

• RecommendationId string

ResourceNotFoundException

StringType

• StringType string

User

• User object: Represents user metadata added to a Users dataset using the PutUsers API.
  • properties
  • userId required

UserId

• UserId string

UserList

• UserList array
  • items User

UserProperties

• UserProperties string