@aws-sdk/client-personalize-events 3.379.1 → 3.385.0

package/dist-types/models/models_0.d.ts

@@ -18,6 +18,7 @@ export declare class InvalidInputException extends __BaseException {
  */
 export interface MetricAttribution {
     /**
+     * @public
      * <p>The source of the event, such as a third party.</p>
      */
     eventAttributionSource: string | undefined;
@@ -29,6 +30,7 @@ export interface MetricAttribution {
  */
 export interface Event {
     /**
+     * @public
      * <p>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
@@ -36,19 +38,23 @@ export interface Event {
      */
     eventId?: string;
     /**
+     * @public
      * <p>The type of event, such as click or download. This property corresponds to the <code>EVENT_TYPE</code>
      *       field of your Interactions schema and depends on the types of events you are tracking.</p>
      */
     eventType: string | undefined;
     /**
+     * @public
      * <p>The event value that corresponds to the <code>EVENT_VALUE</code> field of the Interactions schema.</p>
      */
     eventValue?: number;
     /**
+     * @public
      * <p>The item ID key that corresponds to the <code>ITEM_ID</code> field of the Interactions schema.</p>
      */
     itemId?: string;
     /**
+     * @public
      * <p>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 (<code>itemId</code>) and rating (<code>eventValue</code>)
      *       , you might also send the number of movie ratings made by the user.</p>
@@ -63,10 +69,12 @@ export interface Event {
      */
     properties?: __LazyJsonString | string;
     /**
+     * @public
      * <p>The timestamp (in Unix time) on the client side when the event occurred.</p>
      */
     sentAt: Date | undefined;
     /**
+     * @public
      * <p>The ID of the list of recommendations that contains the item the user interacted with. Provide a <code>recommendationId</code> to have Amazon Personalize implicitly record the
      *       recommendations you show your user as impressions data. Or provide a <code>recommendationId</code> if you use a metric attribution to measure the impact of recommendations.
      *     </p>
@@ -77,12 +85,14 @@ export interface Event {
      */
     recommendationId?: string;
     /**
+     * @public
      * <p>A list of item IDs that represents the sequence of items you have shown the user. For example, <code>["itemId1", "itemId2", "itemId3"]</code>. Provide a list of
      *       items to manually record impressions data for an event. For more information on recording impressions data,
      *       see <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data">Recording impressions data</a>. </p>
      */
     impression?: string[];
     /**
+     * @public
      * <p>Contains information about the metric attribution associated with an event. For more information about metric attributions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html">Measuring impact of recommendations</a>.</p>
      */
     metricAttribution?: MetricAttribution;
@@ -92,22 +102,26 @@ export interface Event {
  */
 export interface PutEventsRequest {
     /**
+     * @public
      * <p>The tracking ID for the event.
      *       The ID is generated by a call to the
      *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a> API.</p>
      */
     trackingId: string | undefined;
     /**
+     * @public
      * <p>The user associated with the event.</p>
      */
     userId?: string;
     /**
+     * @public
      * <p>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
      *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html">Recording Events</a>.</p>
      */
     sessionId: string | undefined;
     /**
+     * @public
      * <p>A list of event data from the session.</p>
      */
     eventList: Event[] | undefined;
@@ -121,10 +135,12 @@ export interface PutEventsRequest {
  */
 export interface Item {
     /**
+     * @public
      * <p>The ID associated with the item.</p>
      */
     itemId: string | undefined;
     /**
+     * @public
      * <p>A string map of item-specific metadata. Each element in the map consists of a key-value pair.
      *       For example, <code>\{"numberOfRatings": "12"\}</code>.</p>
      *          <p>The keys use camel case names that match the fields in the schema for the Items
@@ -139,10 +155,12 @@ export interface Item {
  */
 export interface PutItemsRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the Items dataset you are adding the item or items to.</p>
      */
     datasetArn: string | undefined;
     /**
+     * @public
      * <p>A list of item data.</p>
      */
     items: Item[] | undefined;
@@ -179,10 +197,12 @@ export declare class ResourceNotFoundException extends __BaseException {
  */
 export interface User {
     /**
+     * @public
      * <p>The ID associated with the user.</p>
      */
     userId: string | undefined;
     /**
+     * @public
      * <p>A string map of user-specific metadata. Each element in the map consists of a key-value pair.
      *       For example, <code>\{"numberOfVideosWatched": "45"\}</code>.</p>
      *          <p>The keys use camel case names that match the fields in the schema for the Users
@@ -198,10 +218,12 @@ export interface User {
  */
 export interface PutUsersRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the Users dataset you are adding the user or users to.</p>
      */
     datasetArn: string | undefined;
     /**
+     * @public
      * <p>A list of user data.</p>
      */
     users: User[] | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-personalize-events",
   "description": "AWS SDK for JavaScript Personalize Events Client for Node.js, Browser and React Native",
-  "version": "3.379.1",
+  "version": "3.385.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.385.0",
+    "@aws-sdk/credential-provider-node": "3.385.0",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",