feat(client-personalize-events): This release provides support for creation and use of metric attributions in AWS Personalize

Author: awstools

clients/client-personalize-events/src/models/models_0.ts

@@ -2,6 +2,7 @@
 import {
   ExceptionOptionType as __ExceptionOptionType,
   LazyJsonString as __LazyJsonString,
+  SENSITIVE_STRING,
 } from "@aws-sdk/smithy-client";
 
 import { PersonalizeEventsServiceException as __BaseException } from "./PersonalizeEventsServiceException";
@@ -25,6 +26,16 @@ export class InvalidInputException extends __BaseException {
   }
 }
 
+/**
+ * <p>Contains information about a 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>
+ */
+export interface MetricAttribution {
+  /**
+   * <p>The source of the event, such as a third party.</p>
+   */
+  eventAttributionSource: string | undefined;
+}
+
 /**
  * <p>Represents user interaction event information sent using the
  *       <code>PutEvents</code> API.</p>
@@ -75,14 +86,27 @@ export interface Event {
   sentAt: Date | undefined;
 
   /**
-   * <p>The ID of the recommendation.</p>
+   * <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>
+   *          <p>
+   *       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>.
+   *       For more information on creating a metric attribution see <a href="https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html">Measuring impact of recommendations</a>.
+   *     </p>
    */
   recommendationId?: string;
 
   /**
-   * <p>A list of item IDs that represents the sequence of items you have shown the user. For example, <code>["itemId1", "itemId2", "itemId3"]</code>.</p>
+   * <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[];
+
+  /**
+   * <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;
 }
 
 export interface PutEventsRequest {
@@ -219,44 +243,60 @@ export interface PutUsersRequest {
   users: User[] | undefined;
 }
 
+/**
+ * @internal
+ */
+export const MetricAttributionFilterSensitiveLog = (obj: MetricAttribution): any => ({
+  ...obj,
+});
+
 /**
  * @internal
  */
 export const EventFilterSensitiveLog = (obj: Event): any => ({
   ...obj,
+  ...(obj.itemId && { itemId: SENSITIVE_STRING }),
+  ...(obj.properties && { properties: SENSITIVE_STRING }),
+  ...(obj.impression && { impression: SENSITIVE_STRING }),
 });
 
 /**
  * @internal
  */
 export const PutEventsRequestFilterSensitiveLog = (obj: PutEventsRequest): any => ({
   ...obj,
+  ...(obj.userId && { userId: SENSITIVE_STRING }),
+  ...(obj.eventList && { eventList: SENSITIVE_STRING }),
 });
 
 /**
  * @internal
  */
 export const ItemFilterSensitiveLog = (obj: Item): any => ({
   ...obj,
+  ...(obj.properties && { properties: SENSITIVE_STRING }),
 });
 
 /**
  * @internal
  */
 export const PutItemsRequestFilterSensitiveLog = (obj: PutItemsRequest): any => ({
   ...obj,
+  ...(obj.items && { items: obj.items.map((item) => ItemFilterSensitiveLog(item)) }),
 });
 
 /**
  * @internal
  */
 export const UserFilterSensitiveLog = (obj: User): any => ({
   ...obj,
+  ...(obj.properties && { properties: SENSITIVE_STRING }),
 });
 
 /**
  * @internal
  */
 export const PutUsersRequestFilterSensitiveLog = (obj: PutUsersRequest): any => ({
   ...obj,
+  ...(obj.users && { users: obj.users.map((item) => UserFilterSensitiveLog(item)) }),
 });

clients/client-personalize-events/src/protocols/Aws_restJson1.ts

@@ -21,6 +21,7 @@ import {
   Event,
   InvalidInputException,
   Item,
+  MetricAttribution,
   ResourceInUseException,
   ResourceNotFoundException,
   User,
@@ -286,6 +287,9 @@ const serializeAws_restJson1Event = (input: Event, context: __SerdeContext): any
     ...(input.eventValue != null && { eventValue: __serializeFloat(input.eventValue) }),
     ...(input.impression != null && { impression: serializeAws_restJson1Impression(input.impression, context) }),
     ...(input.itemId != null && { itemId: input.itemId }),
+    ...(input.metricAttribution != null && {
+      metricAttribution: serializeAws_restJson1MetricAttribution(input.metricAttribution, context),
+    }),
     ...(input.properties != null && { properties: __LazyJsonString.fromObject(input.properties) }),
     ...(input.recommendationId != null && { recommendationId: input.recommendationId }),
     ...(input.sentAt != null && { sentAt: Math.round(input.sentAt.getTime() / 1000) }),
@@ -323,6 +327,12 @@ const serializeAws_restJson1ItemList = (input: Item[], context: __SerdeContext):
     });
 };
 
+const serializeAws_restJson1MetricAttribution = (input: MetricAttribution, context: __SerdeContext): any => {
+  return {
+    ...(input.eventAttributionSource != null && { eventAttributionSource: input.eventAttributionSource }),
+  };
+};
+
 const serializeAws_restJson1User = (input: User, context: __SerdeContext): any => {
   return {
     ...(input.properties != null && { properties: __LazyJsonString.fromObject(input.properties) }),