@aws-sdk/client-personalize-events

What is @aws-sdk/client-personalize-events?

@aws-sdk/client-personalize-events is an AWS SDK client for Amazon Personalize Events. It allows developers to record events that are used to train and update machine learning models for personalized recommendations.

What are @aws-sdk/client-personalize-events's main functionalities?

PutEvents

The PutEvents feature allows you to record events such as user interactions with items. These events are used to train and update machine learning models for personalized recommendations.

const { PersonalizeEventsClient, PutEventsCommand } = require('@aws-sdk/client-personalize-events');

const client = new PersonalizeEventsClient({ region: 'us-west-2' });

const params = {
  sessionId: 'exampleSessionId',
  trackingId: 'exampleTrackingId',
  userId: 'exampleUserId',
  eventList: [
    {
      eventType: 'exampleEventType',
      sentAt: new Date(),
      properties: JSON.stringify({
        itemId: 'exampleItemId'
      })
    }
  ]
};

const command = new PutEventsCommand(params);

client.send(command).then(
  (data) => console.log(data),
  (error) => console.error(error)
);

Other packages similar to @aws-sdk/client-personalize-events

segment

Segment is a customer data platform that collects, stores, and routes user data to various analytics and marketing tools. Unlike @aws-sdk/client-personalize-events, which is specific to AWS Personalize, Segment provides a more general solution for data collection and integration with multiple services.

mixpanel

Mixpanel is an advanced analytics platform that helps businesses understand how users interact with their products. It offers event tracking, user segmentation, and funnel analysis. While @aws-sdk/client-personalize-events focuses on recording events for personalized recommendations, Mixpanel provides a broader range of analytics features.

amplitude

Amplitude is a product analytics platform that tracks user behavior and provides insights to help improve user engagement and retention. It offers features like event tracking, user segmentation, and cohort analysis. Compared to @aws-sdk/client-personalize-events, Amplitude provides a more comprehensive set of analytics tools.

README

@aws-sdk/client-personalize-events

Description

AWS SDK for JavaScript PersonalizeEvents Client for Node.js, Browser and React Native.

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 item interaction events.

Installing

To install the this package, simply type add or install @aws-sdk/client-personalize-events using your favorite package manager:

• npm install @aws-sdk/client-personalize-events
• yarn add @aws-sdk/client-personalize-events
• pnpm add @aws-sdk/client-personalize-events

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the PersonalizeEventsClient and the commands you need, for example PutActionsCommand:

// ES5 example
const { PersonalizeEventsClient, PutActionsCommand } = require("@aws-sdk/client-personalize-events");

// ES6+ example
import { PersonalizeEventsClient, PutActionsCommand } from "@aws-sdk/client-personalize-events";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region).
• Initiate command with input parameters.
• Call send operation on client with command object as input.
• If you are using a custom http handler, you may call destroy() to close open connections.

// a client can be shared by different commands.
const client = new PersonalizeEventsClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new PutActionsCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // process err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-personalize-events";
const client = new AWS.PersonalizeEvents({ region: "REGION" });

// async/await.
try {
  const data = await client.putActions(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .putActions(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.putActions(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

• Visit Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-personalize-events package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

PutActionInteractions

Command API Reference / Input / Output

PutActions

Command API Reference / Input / Output

PutEvents

Command API Reference / Input / Output

PutItems

Command API Reference / Input / Output

PutUsers

Command API Reference / Input / Output

Changelog

3.600.0 (2024-06-18)

Features

• client-bedrock-runtime: This release adds support for using Guardrails with the Converse and ConverseStream APIs. (2bdad15)
• client-cloudtrail: Add v2 smoke tests and smithy smokeTests trait for SDK testing. (96b429f)
• client-config-service: Add v2 smoke tests and smithy smokeTests trait for SDK testing. (472d873)
• client-eks: This release adds support to surface async fargate customer errors from async path to customer through describe-fargate-profile API response. (34e2d61)
• client-lightsail: Add v2 smoke tests and smithy smokeTests trait for SDK testing. (9a35ffe)
• client-polly: Add v2 smoke tests and smithy smokeTests trait for SDK testing. (141cb0b)
• client-rekognition: Add v2 smoke tests and smithy smokeTests trait for SDK testing. (fd9be05)
• client-sagemaker: Launched a new feature in SageMaker to provide managed MLflow Tracking Servers for customers to track ML experiments. This release also adds a new capability of attaching additional storage to SageMaker HyperPod cluster instances. (92df932)
• client-shield: Add v2 smoke tests and smithy smokeTests trait for SDK testing. (db1da4c)
• client-snowball: Add v2 smoke tests and smithy smokeTests trait for SDK testing. (aaf2ab7)
• clients: update command documentation examples as of 2024-06-18 (861d056)