@aws-sdk/client-personalize-events 3.451.0 → 3.458.0

package/dist-es/protocols/Aws_restJson1.js

@@ -2,6 +2,48 @@ import { HttpRequest as __HttpRequest } from "@smithy/protocol-http";
 import { _json, collectBody, decorateServiceException as __decorateServiceException, expectString as __expectString, LazyJsonString as __LazyJsonString, map, serializeFloat as __serializeFloat, take, withBaseException, } from "@smithy/smithy-client";
 import { InvalidInputException, ResourceInUseException, ResourceNotFoundException, } from "../models/models_0";
 import { PersonalizeEventsServiceException as __BaseException } from "../models/PersonalizeEventsServiceException";
+export const se_PutActionInteractionsCommand = async (input, context) => {
+    const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
+    const headers = {
+        "content-type": "application/json",
+    };
+    const resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/action-interactions";
+    let body;
+    body = JSON.stringify(take(input, {
+        actionInteractions: (_) => se_ActionInteractionsList(_, context),
+        trackingId: [],
+    }));
+    return new __HttpRequest({
+        protocol,
+        hostname,
+        port,
+        method: "POST",
+        headers,
+        path: resolvedPath,
+        body,
+    });
+};
+export const se_PutActionsCommand = async (input, context) => {
+    const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
+    const headers = {
+        "content-type": "application/json",
+    };
+    const resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/actions";
+    let body;
+    body = JSON.stringify(take(input, {
+        actions: (_) => se_ActionList(_, context),
+        datasetArn: [],
+    }));
+    return new __HttpRequest({
+        protocol,
+        hostname,
+        port,
+        method: "POST",
+        headers,
+        path: resolvedPath,
+        body,
+    });
+};
 export const se_PutEventsCommand = async (input, context) => {
     const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
     const headers = {
@@ -67,6 +109,76 @@ export const se_PutUsersCommand = async (input, context) => {
         body,
     });
 };
+export const de_PutActionInteractionsCommand = async (output, context) => {
+    if (output.statusCode !== 200 && output.statusCode >= 300) {
+        return de_PutActionInteractionsCommandError(output, context);
+    }
+    const contents = map({
+        $metadata: deserializeMetadata(output),
+    });
+    await collectBody(output.body, context);
+    return contents;
+};
+const de_PutActionInteractionsCommandError = async (output, context) => {
+    const parsedOutput = {
+        ...output,
+        body: await parseErrorBody(output.body, context),
+    };
+    const errorCode = loadRestJsonErrorCode(output, parsedOutput.body);
+    switch (errorCode) {
+        case "InvalidInputException":
+        case "com.amazonaws.personalizeevents#InvalidInputException":
+            throw await de_InvalidInputExceptionRes(parsedOutput, context);
+        case "ResourceInUseException":
+        case "com.amazonaws.personalizeevents#ResourceInUseException":
+            throw await de_ResourceInUseExceptionRes(parsedOutput, context);
+        case "ResourceNotFoundException":
+        case "com.amazonaws.personalizeevents#ResourceNotFoundException":
+            throw await de_ResourceNotFoundExceptionRes(parsedOutput, context);
+        default:
+            const parsedBody = parsedOutput.body;
+            return throwDefaultError({
+                output,
+                parsedBody,
+                errorCode,
+            });
+    }
+};
+export const de_PutActionsCommand = async (output, context) => {
+    if (output.statusCode !== 200 && output.statusCode >= 300) {
+        return de_PutActionsCommandError(output, context);
+    }
+    const contents = map({
+        $metadata: deserializeMetadata(output),
+    });
+    await collectBody(output.body, context);
+    return contents;
+};
+const de_PutActionsCommandError = async (output, context) => {
+    const parsedOutput = {
+        ...output,
+        body: await parseErrorBody(output.body, context),
+    };
+    const errorCode = loadRestJsonErrorCode(output, parsedOutput.body);
+    switch (errorCode) {
+        case "InvalidInputException":
+        case "com.amazonaws.personalizeevents#InvalidInputException":
+            throw await de_InvalidInputExceptionRes(parsedOutput, context);
+        case "ResourceInUseException":
+        case "com.amazonaws.personalizeevents#ResourceInUseException":
+            throw await de_ResourceInUseExceptionRes(parsedOutput, context);
+        case "ResourceNotFoundException":
+        case "com.amazonaws.personalizeevents#ResourceNotFoundException":
+            throw await de_ResourceNotFoundExceptionRes(parsedOutput, context);
+        default:
+            const parsedBody = parsedOutput.body;
+            return throwDefaultError({
+                output,
+                parsedBody,
+                errorCode,
+            });
+    }
+};
 export const de_PutEventsCommand = async (output, context) => {
     if (output.statusCode !== 200 && output.statusCode >= 300) {
         return de_PutEventsCommandError(output, context);
@@ -206,6 +318,39 @@ const de_ResourceNotFoundExceptionRes = async (parsedOutput, context) => {
     });
     return __decorateServiceException(exception, parsedOutput.body);
 };
+const se_Action = (input, context) => {
+    return take(input, {
+        actionId: [],
+        properties: __LazyJsonString.fromObject,
+    });
+};
+const se_ActionInteraction = (input, context) => {
+    return take(input, {
+        actionId: [],
+        eventId: [],
+        eventType: [],
+        impression: _json,
+        properties: __LazyJsonString.fromObject,
+        recommendationId: [],
+        sessionId: [],
+        timestamp: (_) => Math.round(_.getTime() / 1000),
+        userId: [],
+    });
+};
+const se_ActionInteractionsList = (input, context) => {
+    return input
+        .filter((e) => e != null)
+        .map((entry) => {
+        return se_ActionInteraction(entry, context);
+    });
+};
+const se_ActionList = (input, context) => {
+    return input
+        .filter((e) => e != null)
+        .map((entry) => {
+        return se_Action(entry, context);
+    });
+};
 const se_Event = (input, context) => {
     return take(input, {
         eventId: [],

package/dist-types/PersonalizeEvents.d.ts

@@ -1,9 +1,23 @@
 import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
+import { PutActionInteractionsCommandInput, PutActionInteractionsCommandOutput } from "./commands/PutActionInteractionsCommand";
+import { PutActionsCommandInput, PutActionsCommandOutput } from "./commands/PutActionsCommand";
 import { PutEventsCommandInput, PutEventsCommandOutput } from "./commands/PutEventsCommand";
 import { PutItemsCommandInput, PutItemsCommandOutput } from "./commands/PutItemsCommand";
 import { PutUsersCommandInput, PutUsersCommandOutput } from "./commands/PutUsersCommand";
 import { PersonalizeEventsClient } from "./PersonalizeEventsClient";
 export interface PersonalizeEvents {
+    /**
+     * @see {@link PutActionInteractionsCommand}
+     */
+    putActionInteractions(args: PutActionInteractionsCommandInput, options?: __HttpHandlerOptions): Promise<PutActionInteractionsCommandOutput>;
+    putActionInteractions(args: PutActionInteractionsCommandInput, cb: (err: any, data?: PutActionInteractionsCommandOutput) => void): void;
+    putActionInteractions(args: PutActionInteractionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutActionInteractionsCommandOutput) => void): void;
+    /**
+     * @see {@link PutActionsCommand}
+     */
+    putActions(args: PutActionsCommandInput, options?: __HttpHandlerOptions): Promise<PutActionsCommandOutput>;
+    putActions(args: PutActionsCommandInput, cb: (err: any, data?: PutActionsCommandOutput) => void): void;
+    putActions(args: PutActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutActionsCommandOutput) => void): void;
     /**
      * @see {@link PutEventsCommand}
      */
@@ -27,7 +41,7 @@ export interface PersonalizeEvents {
  * @public
  * <p>Amazon Personalize can consume real-time user event data, such as <i>stream</i> or <i>click</i> data, and use
  *       it for model training either alone or combined with historical data. For more information see
- *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html">Recording Events</a>.</p>
+ *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html">Recording item interaction events</a>.</p>
  */
 export declare class PersonalizeEvents extends PersonalizeEventsClient implements PersonalizeEvents {
 }

package/dist-types/PersonalizeEventsClient.d.ts

@@ -8,6 +8,8 @@ import { RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry"
 import { HttpHandler as __HttpHandler } from "@smithy/protocol-http";
 import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
 import { BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
+import { PutActionInteractionsCommandInput, PutActionInteractionsCommandOutput } from "./commands/PutActionInteractionsCommand";
+import { PutActionsCommandInput, PutActionsCommandOutput } from "./commands/PutActionsCommand";
 import { PutEventsCommandInput, PutEventsCommandOutput } from "./commands/PutEventsCommand";
 import { PutItemsCommandInput, PutItemsCommandOutput } from "./commands/PutItemsCommand";
 import { PutUsersCommandInput, PutUsersCommandOutput } from "./commands/PutUsersCommand";
@@ -17,11 +19,11 @@ export { __Client };
 /**
  * @public
  */
-export type ServiceInputTypes = PutEventsCommandInput | PutItemsCommandInput | PutUsersCommandInput;
+export type ServiceInputTypes = PutActionInteractionsCommandInput | PutActionsCommandInput | PutEventsCommandInput | PutItemsCommandInput | PutUsersCommandInput;
 /**
  * @public
  */
-export type ServiceOutputTypes = PutEventsCommandOutput | PutItemsCommandOutput | PutUsersCommandOutput;
+export type ServiceOutputTypes = PutActionInteractionsCommandOutput | PutActionsCommandOutput | PutEventsCommandOutput | PutItemsCommandOutput | PutUsersCommandOutput;
 /**
  * @public
  */
@@ -157,7 +159,7 @@ export interface PersonalizeEventsClientResolvedConfig extends PersonalizeEvents
  * @public
  * <p>Amazon Personalize can consume real-time user event data, such as <i>stream</i> or <i>click</i> data, and use
  *       it for model training either alone or combined with historical data. For more information see
- *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html">Recording Events</a>.</p>
+ *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html">Recording item interaction events</a>.</p>
  */
 export declare class PersonalizeEventsClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, PersonalizeEventsClientResolvedConfig> {
     /**

package/dist-types/commands/PutActionInteractionsCommand.d.ts

@@ -0,0 +1,99 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { PutActionInteractionsRequest } from "../models/models_0";
+import { PersonalizeEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeEventsClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link PutActionInteractionsCommand}.
+ */
+export interface PutActionInteractionsCommandInput extends PutActionInteractionsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link PutActionInteractionsCommand}.
+ */
+export interface PutActionInteractionsCommandOutput extends __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Records action interaction event data. An <i>action interaction</i> event is an interaction between a user and an <i>action</i>.
+ *       For example, a user taking an action, such a enrolling in a membership program or downloading your app.</p>
+ *          <p>
+ *       For more information about recording action interactions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-action-interaction-events.html">Recording action interaction events</a>.
+ *       For more information about actions in an Actions dataset, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/actions-datasets.html">Actions dataset</a>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PersonalizeEventsClient, PutActionInteractionsCommand } from "@aws-sdk/client-personalize-events"; // ES Modules import
+ * // const { PersonalizeEventsClient, PutActionInteractionsCommand } = require("@aws-sdk/client-personalize-events"); // CommonJS import
+ * const client = new PersonalizeEventsClient(config);
+ * const input = { // PutActionInteractionsRequest
+ *   trackingId: "STRING_VALUE", // required
+ *   actionInteractions: [ // ActionInteractionsList // required
+ *     { // ActionInteraction
+ *       actionId: "STRING_VALUE", // required
+ *       userId: "STRING_VALUE",
+ *       sessionId: "STRING_VALUE", // required
+ *       timestamp: new Date("TIMESTAMP"), // required
+ *       eventType: "STRING_VALUE", // required
+ *       eventId: "STRING_VALUE",
+ *       recommendationId: "STRING_VALUE",
+ *       impression: [ // ActionImpression
+ *         "STRING_VALUE",
+ *       ],
+ *       properties: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
+ * const command = new PutActionInteractionsCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param PutActionInteractionsCommandInput - {@link PutActionInteractionsCommandInput}
+ * @returns {@link PutActionInteractionsCommandOutput}
+ * @see {@link PutActionInteractionsCommandInput} for command's `input` shape.
+ * @see {@link PutActionInteractionsCommandOutput} for command's `response` shape.
+ * @see {@link PersonalizeEventsClientResolvedConfig | config} for PersonalizeEventsClient's `config` shape.
+ *
+ * @throws {@link InvalidInputException} (client fault)
+ *  <p>Provide a valid value for the field or parameter.</p>
+ *
+ * @throws {@link ResourceInUseException} (client fault)
+ *  <p>The specified resource is in use.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Could not find the specified resource.</p>
+ *
+ * @throws {@link PersonalizeEventsServiceException}
+ * <p>Base exception class for all service exceptions from PersonalizeEvents service.</p>
+ *
+ */
+export declare class PutActionInteractionsCommand extends $Command<PutActionInteractionsCommandInput, PutActionInteractionsCommandOutput, PersonalizeEventsClientResolvedConfig> {
+    readonly input: PutActionInteractionsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: PutActionInteractionsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutActionInteractionsCommandInput, PutActionInteractionsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/PutActionsCommand.d.ts

@@ -0,0 +1,88 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { PutActionsRequest } from "../models/models_0";
+import { PersonalizeEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeEventsClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link PutActionsCommand}.
+ */
+export interface PutActionsCommandInput extends PutActionsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link PutActionsCommand}.
+ */
+export interface PutActionsCommandOutput extends __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Adds one or more actions to an Actions dataset. For more information see
+ *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-actions.html">Importing actions individually</a>.
+ *     </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PersonalizeEventsClient, PutActionsCommand } from "@aws-sdk/client-personalize-events"; // ES Modules import
+ * // const { PersonalizeEventsClient, PutActionsCommand } = require("@aws-sdk/client-personalize-events"); // CommonJS import
+ * const client = new PersonalizeEventsClient(config);
+ * const input = { // PutActionsRequest
+ *   datasetArn: "STRING_VALUE", // required
+ *   actions: [ // ActionList // required
+ *     { // Action
+ *       actionId: "STRING_VALUE", // required
+ *       properties: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
+ * const command = new PutActionsCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param PutActionsCommandInput - {@link PutActionsCommandInput}
+ * @returns {@link PutActionsCommandOutput}
+ * @see {@link PutActionsCommandInput} for command's `input` shape.
+ * @see {@link PutActionsCommandOutput} for command's `response` shape.
+ * @see {@link PersonalizeEventsClientResolvedConfig | config} for PersonalizeEventsClient's `config` shape.
+ *
+ * @throws {@link InvalidInputException} (client fault)
+ *  <p>Provide a valid value for the field or parameter.</p>
+ *
+ * @throws {@link ResourceInUseException} (client fault)
+ *  <p>The specified resource is in use.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Could not find the specified resource.</p>
+ *
+ * @throws {@link PersonalizeEventsServiceException}
+ * <p>Base exception class for all service exceptions from PersonalizeEvents service.</p>
+ *
+ */
+export declare class PutActionsCommand extends $Command<PutActionsCommandInput, PutActionsCommandOutput, PersonalizeEventsClientResolvedConfig> {
+    readonly input: PutActionsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: PutActionsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutActionsCommandInput, PutActionsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/PutEventsCommand.d.ts

@@ -23,8 +23,8 @@ export interface PutEventsCommandOutput extends __MetadataBearer {
 }
 /**
  * @public
- * <p>Records user interaction event data. For more information see
- *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html">Recording Events</a>.</p>
+ * <p>Records item interaction event data. For more information see
+ *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html">Recording item interaction events</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/PutItemsCommand.d.ts

@@ -24,7 +24,7 @@ export interface PutItemsCommandOutput extends __MetadataBearer {
 /**
  * @public
  * <p>Adds one or more items to an Items dataset. For more information see
- *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html">Importing Items Incrementally</a>.
+ *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html">Importing items individually</a>.
  *      </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/PutUsersCommand.d.ts

@@ -24,7 +24,7 @@ export interface PutUsersCommandOutput extends __MetadataBearer {
 /**
  * @public
  * <p>Adds one or more users to a Users dataset. For more information see
- *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html">Importing Users Incrementally</a>.</p>
+ *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html">Importing users individually</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/index.d.ts

@@ -1,3 +1,5 @@
+export * from "./PutActionInteractionsCommand";
+export * from "./PutActionsCommand";
 export * from "./PutEventsCommand";
 export * from "./PutItemsCommand";
 export * from "./PutUsersCommand";

package/dist-types/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * <p>Amazon Personalize can consume real-time user event data, such as <i>stream</i> or <i>click</i> data, and use
  *       it for model training either alone or combined with historical data. For more information see
- *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html">Recording Events</a>.</p>
+ *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html">Recording item interaction events</a>.</p>
  *
  * @packageDocumentation
  */