@aws-sdk/client-personalize-events 3.33.0 → 3.36.1

package/dist/types/ts3.4/models/models_0.d.ts

@@ -1,216 +0,0 @@
-import { LazyJsonString as __LazyJsonString } from "@aws-sdk/smithy-client";
-import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
-/**
- * <p>Provide a valid value for the field or parameter.</p>
- */
-export interface InvalidInputException extends __SmithyException, $MetadataBearer {
-    name: "InvalidInputException";
-    $fault: "client";
-    message?: string;
-}
-export declare namespace InvalidInputException {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: InvalidInputException) => any;
-}
-/**
- * <p>Represents user interaction event information sent using the
- *       <code>PutEvents</code> API.</p>
- */
-export interface Event {
-    /**
-     * <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
-     *       same event ID are not used in model training.</p>
-     */
-    eventId?: string;
-    /**
-     * <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;
-    /**
-     * <p>The event value that corresponds to the <code>EVENT_VALUE</code> field of the Interactions schema.</p>
-     */
-    eventValue?: number;
-    /**
-     * <p>The item ID key that corresponds to the <code>ITEM_ID</code> field of the Interactions schema.</p>
-     */
-    itemId?: string;
-    /**
-     * <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>
-     *          <p>Each item in the map consists of a key-value pair. For example,</p>
-     *
-     *          <p>
-     *             <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
-     *       'NUMBER_OF_RATINGS' field defined in the Interactions schema.</p>
-     */
-    properties?: __LazyJsonString | string;
-    /**
-     * <p>The timestamp (in Unix time) on the client side when the event occurred.</p>
-     */
-    sentAt: Date | undefined;
-    /**
-     * <p>The ID of the recommendation.</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>
-     */
-    impression?: string[];
-}
-export declare namespace Event {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: Event) => any;
-}
-export interface PutEventsRequest {
-    /**
-     * <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;
-    /**
-     * <p>The user associated with the event.</p>
-     */
-    userId?: string;
-    /**
-     * <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;
-    /**
-     * <p>A list of event data from the session.</p>
-     */
-    eventList: Event[] | undefined;
-}
-export declare namespace PutEventsRequest {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: PutEventsRequest) => any;
-}
-/**
- * <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>.
- *     </p>
- */
-export interface Item {
-    /**
-     * <p>The ID associated with the item.</p>
-     */
-    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>
-     *          <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,
-     *       separate each category with a pipe separator (<code>|</code>). For example, <code>\"Horror|Action\"</code>.</p>
-     */
-    properties?: __LazyJsonString | string;
-}
-export declare namespace Item {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: Item) => any;
-}
-export interface PutItemsRequest {
-    /**
-     * <p>The Amazon Resource Name (ARN) of the Items dataset you are adding the item or items to.</p>
-     */
-    datasetArn: string | undefined;
-    /**
-     * <p>A list of item data.</p>
-     */
-    items: Item[] | undefined;
-}
-export declare namespace PutItemsRequest {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: PutItemsRequest) => any;
-}
-/**
- * <p>The specified resource is in use.</p>
- */
-export interface ResourceInUseException extends __SmithyException, $MetadataBearer {
-    name: "ResourceInUseException";
-    $fault: "client";
-    message?: string;
-}
-export declare namespace ResourceInUseException {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ResourceInUseException) => any;
-}
-/**
- * <p>Could not find the specified resource.</p>
- */
-export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
-    name: "ResourceNotFoundException";
-    $fault: "client";
-    message?: string;
-}
-export declare namespace ResourceNotFoundException {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
-}
-/**
- * <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>
- */
-export interface User {
-    /**
-     * <p>The ID associated with the user.</p>
-     */
-    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>
-     *          <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,
-     *       to include multiple categories for a single user, separate each category with a pipe separator (<code>|</code>).
-     *       For example, <code>\"Member|Frequent shopper\"</code>.</p>
-     */
-    properties?: __LazyJsonString | string;
-}
-export declare namespace User {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: User) => any;
-}
-export interface PutUsersRequest {
-    /**
-     * <p>The Amazon Resource Name (ARN) of the Users dataset you are adding the user or users to.</p>
-     */
-    datasetArn: string | undefined;
-    /**
-     * <p>A list of user data.</p>
-     */
-    users: User[] | undefined;
-}
-export declare namespace PutUsersRequest {
-    /**
-     * @internal
-     */
-    const filterSensitiveLog: (obj: PutUsersRequest) => any;
-}

package/endpoints.ts

@@ -1,57 +0,0 @@
-import { PartitionHash, RegionHash, getRegionInfo } from "@aws-sdk/config-resolver";
-import { RegionInfoProvider } from "@aws-sdk/types";
-
-const regionHash: RegionHash = {};
-
-const partitionHash: PartitionHash = {
-  aws: {
-    regions: [
-      "af-south-1",
-      "ap-east-1",
-      "ap-northeast-1",
-      "ap-northeast-2",
-      "ap-northeast-3",
-      "ap-south-1",
-      "ap-southeast-1",
-      "ap-southeast-2",
-      "ca-central-1",
-      "eu-central-1",
-      "eu-north-1",
-      "eu-south-1",
-      "eu-west-1",
-      "eu-west-2",
-      "eu-west-3",
-      "me-south-1",
-      "sa-east-1",
-      "us-east-1",
-      "us-east-2",
-      "us-west-1",
-      "us-west-2",
-    ],
-    hostname: "personalize-events.{region}.amazonaws.com",
-  },
-  "aws-cn": {
-    regions: ["cn-north-1", "cn-northwest-1"],
-    hostname: "personalize-events.{region}.amazonaws.com.cn",
-  },
-  "aws-iso": {
-    regions: ["us-iso-east-1"],
-    hostname: "personalize-events.{region}.c2s.ic.gov",
-  },
-  "aws-iso-b": {
-    regions: ["us-isob-east-1"],
-    hostname: "personalize-events.{region}.sc2s.sgov.gov",
-  },
-  "aws-us-gov": {
-    regions: ["us-gov-east-1", "us-gov-west-1"],
-    hostname: "personalize-events.{region}.amazonaws.com",
-  },
-};
-
-export const defaultRegionInfoProvider: RegionInfoProvider = async (region: string, options?: any) =>
-  getRegionInfo(region, {
-    ...options,
-    signingService: "personalize",
-    regionHash,
-    partitionHash,
-  });

package/jest.config.js

@@ -1,4 +0,0 @@
-module.exports = {
-  preset: "ts-jest",
-  testMatch: ["**/*.spec.ts", "!**/*.browser.spec.ts", "!**/*.integ.spec.ts"],
-};

package/models/models_0.ts

@@ -1,266 +0,0 @@
-import { LazyJsonString as __LazyJsonString } from "@aws-sdk/smithy-client";
-import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
-
-/**
- * <p>Provide a valid value for the field or parameter.</p>
- */
-export interface InvalidInputException extends __SmithyException, $MetadataBearer {
-  name: "InvalidInputException";
-  $fault: "client";
-  message?: string;
-}
-
-export namespace InvalidInputException {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: InvalidInputException): any => ({
-    ...obj,
-  });
-}
-
-/**
- * <p>Represents user interaction event information sent using the
- *       <code>PutEvents</code> API.</p>
- */
-export interface Event {
-  /**
-   * <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
-   *       same event ID are not used in model training.</p>
-   */
-  eventId?: string;
-
-  /**
-   * <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;
-
-  /**
-   * <p>The event value that corresponds to the <code>EVENT_VALUE</code> field of the Interactions schema.</p>
-   */
-  eventValue?: number;
-
-  /**
-   * <p>The item ID key that corresponds to the <code>ITEM_ID</code> field of the Interactions schema.</p>
-   */
-  itemId?: string;
-
-  /**
-   * <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>
-   *          <p>Each item in the map consists of a key-value pair. For example,</p>
-   *
-   *          <p>
-   *             <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
-   *       'NUMBER_OF_RATINGS' field defined in the Interactions schema.</p>
-   */
-  properties?: __LazyJsonString | string;
-
-  /**
-   * <p>The timestamp (in Unix time) on the client side when the event occurred.</p>
-   */
-  sentAt: Date | undefined;
-
-  /**
-   * <p>The ID of the recommendation.</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>
-   */
-  impression?: string[];
-}
-
-export namespace Event {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: Event): any => ({
-    ...obj,
-  });
-}
-
-export interface PutEventsRequest {
-  /**
-   * <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;
-
-  /**
-   * <p>The user associated with the event.</p>
-   */
-  userId?: string;
-
-  /**
-   * <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;
-
-  /**
-   * <p>A list of event data from the session.</p>
-   */
-  eventList: Event[] | undefined;
-}
-
-export namespace PutEventsRequest {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: PutEventsRequest): any => ({
-    ...obj,
-  });
-}
-
-/**
- * <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>.
- *     </p>
- */
-export interface Item {
-  /**
-   * <p>The ID associated with the item.</p>
-   */
-  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>
-   *          <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,
-   *       separate each category with a pipe separator (<code>|</code>). For example, <code>\"Horror|Action\"</code>.</p>
-   */
-  properties?: __LazyJsonString | string;
-}
-
-export namespace Item {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: Item): any => ({
-    ...obj,
-  });
-}
-
-export interface PutItemsRequest {
-  /**
-   * <p>The Amazon Resource Name (ARN) of the Items dataset you are adding the item or items to.</p>
-   */
-  datasetArn: string | undefined;
-
-  /**
-   * <p>A list of item data.</p>
-   */
-  items: Item[] | undefined;
-}
-
-export namespace PutItemsRequest {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: PutItemsRequest): any => ({
-    ...obj,
-  });
-}
-
-/**
- * <p>The specified resource is in use.</p>
- */
-export interface ResourceInUseException extends __SmithyException, $MetadataBearer {
-  name: "ResourceInUseException";
-  $fault: "client";
-  message?: string;
-}
-
-export namespace ResourceInUseException {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: ResourceInUseException): any => ({
-    ...obj,
-  });
-}
-
-/**
- * <p>Could not find the specified resource.</p>
- */
-export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
-  name: "ResourceNotFoundException";
-  $fault: "client";
-  message?: string;
-}
-
-export namespace ResourceNotFoundException {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({
-    ...obj,
-  });
-}
-
-/**
- * <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>
- */
-export interface User {
-  /**
-   * <p>The ID associated with the user.</p>
-   */
-  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>
-   *          <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,
-   *       to include multiple categories for a single user, separate each category with a pipe separator (<code>|</code>).
-   *       For example, <code>\"Member|Frequent shopper\"</code>.</p>
-   */
-  properties?: __LazyJsonString | string;
-}
-
-export namespace User {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: User): any => ({
-    ...obj,
-  });
-}
-
-export interface PutUsersRequest {
-  /**
-   * <p>The Amazon Resource Name (ARN) of the Users dataset you are adding the user or users to.</p>
-   */
-  datasetArn: string | undefined;
-
-  /**
-   * <p>A list of user data.</p>
-   */
-  users: User[] | undefined;
-}
-
-export namespace PutUsersRequest {
-  /**
-   * @internal
-   */
-  export const filterSensitiveLog = (obj: PutUsersRequest): any => ({
-    ...obj,
-  });
-}