@aws-sdk/client-personalize-events 3.296.0 → 3.297.0

package/dist-types/PersonalizeEvents.d.ts

@@ -4,12 +4,14 @@ import { PutItemsCommandInput, PutItemsCommandOutput } from "./commands/PutItems
 import { PutUsersCommandInput, PutUsersCommandOutput } from "./commands/PutUsersCommand";
 import { PersonalizeEventsClient } from "./PersonalizeEventsClient";
 /**
+ * @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>
  */
 export declare class PersonalizeEvents extends PersonalizeEventsClient {
     /**
+     * @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>
      */
@@ -17,6 +19,7 @@ export declare class PersonalizeEvents extends PersonalizeEventsClient {
     putEvents(args: PutEventsCommandInput, cb: (err: any, data?: PutEventsCommandOutput) => void): void;
     putEvents(args: PutEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEventsCommandOutput) => void): void;
     /**
+     * @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>.
      *      </p>
@@ -25,6 +28,7 @@ export declare class PersonalizeEvents extends PersonalizeEventsClient {
     putItems(args: PutItemsCommandInput, cb: (err: any, data?: PutItemsCommandOutput) => void): void;
     putItems(args: PutItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutItemsCommandOutput) => void): void;
     /**
+     * @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>
      */

package/dist-types/PersonalizeEventsClient.d.ts

@@ -11,15 +11,24 @@ import { PutEventsCommandInput, PutEventsCommandOutput } from "./commands/PutEve
 import { PutItemsCommandInput, PutItemsCommandOutput } from "./commands/PutItemsCommand";
 import { PutUsersCommandInput, PutUsersCommandOutput } from "./commands/PutUsersCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = PutEventsCommandInput | PutItemsCommandInput | PutUsersCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = PutEventsCommandOutput | PutItemsCommandOutput | PutUsersCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -109,23 +118,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type PersonalizeEventsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of PersonalizeEventsClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of PersonalizeEventsClient class constructor that set the region, credentials and other options.
  */
 export interface PersonalizeEventsClientConfig extends PersonalizeEventsClientConfigType {
 }
+/**
+ * @public
+ */
 type PersonalizeEventsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of PersonalizeEventsClient class. This is resolved and normalized from the {@link PersonalizeEventsClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of PersonalizeEventsClient class. This is resolved and normalized from the {@link PersonalizeEventsClientConfig | constructor configuration interface}.
  */
 export interface PersonalizeEventsClientResolvedConfig extends PersonalizeEventsClientResolvedConfigType {
 }
 /**
+ * @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>

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { PutEventsRequest } from "../models/models_0";
 import { PersonalizeEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeEventsClient";
 /**
+ * @public
+ *
  * The input for {@link PutEventsCommand}.
  */
 export interface PutEventsCommandInput extends PutEventsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutEventsCommand}.
  */
 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>
  * @example
@@ -26,6 +31,8 @@ export interface PutEventsCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param PutEventsCommandInput - {@link PutEventsCommandInput}
+ * @returns {@link PutEventsCommandOutput}
  * @see {@link PutEventsCommandInput} for command's `input` shape.
  * @see {@link PutEventsCommandOutput} for command's `response` shape.
  * @see {@link PersonalizeEventsClientResolvedConfig | config} for PersonalizeEventsClient's `config` shape.
@@ -38,11 +45,20 @@ export interface PutEventsCommandOutput extends __MetadataBearer {
 export declare class PutEventsCommand extends $Command<PutEventsCommandInput, PutEventsCommandOutput, PersonalizeEventsClientResolvedConfig> {
     readonly input: PutEventsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutEventsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutEventsCommandInput, PutEventsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { PutItemsRequest } from "../models/models_0";
 import { PersonalizeEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeEventsClient";
 /**
+ * @public
+ *
  * The input for {@link PutItemsCommand}.
  */
 export interface PutItemsCommandInput extends PutItemsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutItemsCommand}.
  */
 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>.
  *      </p>
@@ -27,6 +32,8 @@ export interface PutItemsCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param PutItemsCommandInput - {@link PutItemsCommandInput}
+ * @returns {@link PutItemsCommandOutput}
  * @see {@link PutItemsCommandInput} for command's `input` shape.
  * @see {@link PutItemsCommandOutput} for command's `response` shape.
  * @see {@link PersonalizeEventsClientResolvedConfig | config} for PersonalizeEventsClient's `config` shape.
@@ -45,11 +52,20 @@ export interface PutItemsCommandOutput extends __MetadataBearer {
 export declare class PutItemsCommand extends $Command<PutItemsCommandInput, PutItemsCommandOutput, PersonalizeEventsClientResolvedConfig> {
     readonly input: PutItemsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutItemsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutItemsCommandInput, PutItemsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { PutUsersRequest } from "../models/models_0";
 import { PersonalizeEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeEventsClient";
 /**
+ * @public
+ *
  * The input for {@link PutUsersCommand}.
  */
 export interface PutUsersCommandInput extends PutUsersRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutUsersCommand}.
  */
 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>
  * @example
@@ -26,6 +31,8 @@ export interface PutUsersCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param PutUsersCommandInput - {@link PutUsersCommandInput}
+ * @returns {@link PutUsersCommandOutput}
  * @see {@link PutUsersCommandInput} for command's `input` shape.
  * @see {@link PutUsersCommandOutput} for command's `response` shape.
  * @see {@link PersonalizeEventsClientResolvedConfig | config} for PersonalizeEventsClient's `config` shape.
@@ -44,11 +51,20 @@ export interface PutUsersCommandOutput extends __MetadataBearer {
 export declare class PutUsersCommand extends $Command<PutUsersCommandInput, PutUsersCommandOutput, PersonalizeEventsClientResolvedConfig> {
     readonly input: PutUsersCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutUsersCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeEventsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutUsersCommandInput, PutUsersCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from PersonalizeEvents service.
  */
 export declare class PersonalizeEventsServiceException extends __ServiceException {

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

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@aws-sdk/smithy-client";
 import { PersonalizeEventsServiceException as __BaseException } from "./PersonalizeEventsServiceException";
 /**
+ * @public
  * <p>Provide a valid value for the field or parameter.</p>
  */
 export declare class InvalidInputException extends __BaseException {
@@ -12,6 +13,7 @@ export declare class InvalidInputException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidInputException, __BaseException>);
 }
 /**
+ * @public
  * <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 {
@@ -21,6 +23,7 @@ export interface MetricAttribution {
     eventAttributionSource: string | undefined;
 }
 /**
+ * @public
  * <p>Represents user interaction event information sent using the
  *       <code>PutEvents</code> API.</p>
  */
@@ -52,7 +55,7 @@ export interface Event {
      *          <p>Each item in the map consists of a key-value pair. For example,</p>
      *
      *          <p>
-     *             <code>{"numberOfRatings": "12"}</code>
+     *             <code>\{"numberOfRatings": "12"\}</code>
      *          </p>
      *          <p>The keys use camel case names that match the fields in the Interactions
      *       schema. In the above example, the <code>numberOfRatings</code> would match the
@@ -84,6 +87,9 @@ export interface Event {
      */
     metricAttribution?: MetricAttribution;
 }
+/**
+ * @public
+ */
 export interface PutEventsRequest {
     /**
      * <p>The tracking ID for the event.
@@ -107,6 +113,7 @@ export interface PutEventsRequest {
     eventList: Event[] | undefined;
 }
 /**
+ * @public
  * <p>Represents item metadata added to an Items dataset using the
  *       <code>PutItems</code> API. For more information see
  *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html">Importing Items Incrementally</a>.
@@ -119,7 +126,7 @@ export interface Item {
     itemId: string | undefined;
     /**
      * <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>
+     *       For example, <code>\{"numberOfRatings": "12"\}</code>.</p>
      *          <p>The keys use camel case names that match the fields in the schema for the Items
      *       dataset. In the previous example, the <code>numberOfRatings</code> matches the
      *       'NUMBER_OF_RATINGS' field defined in the Items schema. For categorical string data, to include multiple categories for a single item,
@@ -127,6 +134,9 @@ export interface Item {
      */
     properties?: __LazyJsonString | string;
 }
+/**
+ * @public
+ */
 export interface PutItemsRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the Items dataset you are adding the item or items to.</p>
@@ -138,6 +148,7 @@ export interface PutItemsRequest {
     items: Item[] | undefined;
 }
 /**
+ * @public
  * <p>The specified resource is in use.</p>
  */
 export declare class ResourceInUseException extends __BaseException {
@@ -149,6 +160,7 @@ export declare class ResourceInUseException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
 }
 /**
+ * @public
  * <p>Could not find the specified resource.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -160,6 +172,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>Represents user metadata added to a Users dataset using the
  *       <code>PutUsers</code> API. For more information see
  *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html">Importing Users Incrementally</a>.</p>
@@ -171,7 +184,7 @@ export interface User {
     userId: string | undefined;
     /**
      * <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>
+     *       For example, <code>\{"numberOfVideosWatched": "45"\}</code>.</p>
      *          <p>The keys use camel case names that match the fields in the schema for the Users
      *       dataset. In the previous example, the <code>numberOfVideosWatched</code> matches the
      *       'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema. For categorical string data,
@@ -180,6 +193,9 @@ export interface User {
      */
     properties?: __LazyJsonString | string;
 }
+/**
+ * @public
+ */
 export interface PutUsersRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the Users dataset you are adding the user or users to.</p>

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.296.0",
+  "version": "3.297.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,9 +20,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.296.0",
+    "@aws-sdk/client-sts": "3.297.0",
     "@aws-sdk/config-resolver": "3.296.0",
-    "@aws-sdk/credential-provider-node": "3.296.0",
+    "@aws-sdk/credential-provider-node": "3.297.0",
     "@aws-sdk/fetch-http-handler": "3.296.0",
     "@aws-sdk/hash-node": "3.296.0",
     "@aws-sdk/invalid-dependency": "3.296.0",