@aws-sdk/client-personalize-events 3.533.0 → 3.540.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/endpoint/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/PersonalizeEvents.d.ts +1 -1
- package/dist-types/PersonalizeEventsClient.d.ts +1 -1
- package/dist-types/commands/PutActionInteractionsCommand.d.ts +2 -1
- package/dist-types/commands/PutActionsCommand.d.ts +2 -1
- package/dist-types/commands/PutEventsCommand.d.ts +2 -1
- package/dist-types/commands/PutItemsCommand.d.ts +2 -1
- package/dist-types/commands/PutUsersCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +46 -46
- package/dist-types/ts3.4/commands/PutActionInteractionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutActionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutEventsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutItemsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutUsersCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +40 -40
|
@@ -1,12 +1,14 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.defaultEndpointResolver = void 0;
|
|
4
|
-
const util_endpoints_1 = require("@
|
|
4
|
+
const util_endpoints_1 = require("@aws-sdk/util-endpoints");
|
|
5
|
+
const util_endpoints_2 = require("@smithy/util-endpoints");
|
|
5
6
|
const ruleset_1 = require("./ruleset");
|
|
6
7
|
const defaultEndpointResolver = (endpointParams, context = {}) => {
|
|
7
|
-
return (0,
|
|
8
|
+
return (0, util_endpoints_2.resolveEndpoint)(ruleset_1.ruleSet, {
|
|
8
9
|
endpointParams: endpointParams,
|
|
9
10
|
logger: context.logger,
|
|
10
11
|
});
|
|
11
12
|
};
|
|
12
13
|
exports.defaultEndpointResolver = defaultEndpointResolver;
|
|
14
|
+
util_endpoints_2.customEndpointFunctions.aws = util_endpoints_1.awsEndpointFunctions;
|
package/dist-cjs/index.js
CHANGED
|
@@ -687,9 +687,6 @@ var _PersonalizeEvents = class _PersonalizeEvents extends PersonalizeEventsClien
|
|
|
687
687
|
__name(_PersonalizeEvents, "PersonalizeEvents");
|
|
688
688
|
var PersonalizeEvents = _PersonalizeEvents;
|
|
689
689
|
(0, import_smithy_client.createAggregatedClient)(commands, PersonalizeEvents);
|
|
690
|
-
|
|
691
|
-
// src/index.ts
|
|
692
|
-
var import_util_endpoints = require("@aws-sdk/util-endpoints");
|
|
693
690
|
// Annotate the CommonJS export names for ESM import in node:
|
|
694
691
|
|
|
695
692
|
0 && (module.exports = {
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { awsEndpointFunctions } from "@aws-sdk/util-endpoints";
|
|
2
|
+
import { customEndpointFunctions, resolveEndpoint } from "@smithy/util-endpoints";
|
|
2
3
|
import { ruleSet } from "./ruleset";
|
|
3
4
|
export const defaultEndpointResolver = (endpointParams, context = {}) => {
|
|
4
5
|
return resolveEndpoint(ruleSet, {
|
|
@@ -6,3 +7,4 @@ export const defaultEndpointResolver = (endpointParams, context = {}) => {
|
|
|
6
7
|
logger: context.logger,
|
|
7
8
|
});
|
|
8
9
|
};
|
|
10
|
+
customEndpointFunctions.aws = awsEndpointFunctions;
|
package/dist-es/index.js
CHANGED
|
@@ -38,10 +38,10 @@ export interface PersonalizeEvents {
|
|
|
38
38
|
putUsers(args: PutUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutUsersCommandOutput) => void): void;
|
|
39
39
|
}
|
|
40
40
|
/**
|
|
41
|
-
* @public
|
|
42
41
|
* <p>Amazon Personalize can consume real-time user event data, such as <i>stream</i> or <i>click</i> data, and use
|
|
43
42
|
* it for model training either alone or combined with historical data. For more information see
|
|
44
43
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html">Recording item interaction events</a>.</p>
|
|
44
|
+
* @public
|
|
45
45
|
*/
|
|
46
46
|
export declare class PersonalizeEvents extends PersonalizeEventsClient implements PersonalizeEvents {
|
|
47
47
|
}
|
|
@@ -156,10 +156,10 @@ export type PersonalizeEventsClientResolvedConfigType = __SmithyResolvedConfigur
|
|
|
156
156
|
export interface PersonalizeEventsClientResolvedConfig extends PersonalizeEventsClientResolvedConfigType {
|
|
157
157
|
}
|
|
158
158
|
/**
|
|
159
|
-
* @public
|
|
160
159
|
* <p>Amazon Personalize can consume real-time user event data, such as <i>stream</i> or <i>click</i> data, and use
|
|
161
160
|
* it for model training either alone or combined with historical data. For more information see
|
|
162
161
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html">Recording item interaction events</a>.</p>
|
|
162
|
+
* @public
|
|
163
163
|
*/
|
|
164
164
|
export declare class PersonalizeEventsClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, PersonalizeEventsClientResolvedConfig> {
|
|
165
165
|
/**
|
|
@@ -22,10 +22,10 @@ export interface PutActionInteractionsCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const PutActionInteractionsCommand_base: {
|
|
24
24
|
new (input: PutActionInteractionsCommandInput): import("@smithy/smithy-client").CommandImpl<PutActionInteractionsCommandInput, PutActionInteractionsCommandOutput, PersonalizeEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: PutActionInteractionsCommandInput): import("@smithy/smithy-client").CommandImpl<PutActionInteractionsCommandInput, PutActionInteractionsCommandOutput, PersonalizeEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Records action interaction event data. An <i>action interaction</i> event is an interaction between a user and an <i>action</i>.
|
|
30
30
|
* For example, a user taking an action, such a enrolling in a membership program or downloading your app.</p>
|
|
31
31
|
* <p>
|
|
@@ -79,6 +79,7 @@ declare const PutActionInteractionsCommand_base: {
|
|
|
79
79
|
* @throws {@link PersonalizeEventsServiceException}
|
|
80
80
|
* <p>Base exception class for all service exceptions from PersonalizeEvents service.</p>
|
|
81
81
|
*
|
|
82
|
+
* @public
|
|
82
83
|
*/
|
|
83
84
|
export declare class PutActionInteractionsCommand extends PutActionInteractionsCommand_base {
|
|
84
85
|
}
|
|
@@ -22,10 +22,10 @@ export interface PutActionsCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const PutActionsCommand_base: {
|
|
24
24
|
new (input: PutActionsCommandInput): import("@smithy/smithy-client").CommandImpl<PutActionsCommandInput, PutActionsCommandOutput, PersonalizeEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: PutActionsCommandInput): import("@smithy/smithy-client").CommandImpl<PutActionsCommandInput, PutActionsCommandOutput, PersonalizeEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Adds one or more actions to an Actions dataset. For more information see
|
|
30
30
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-actions.html">Importing actions individually</a>.
|
|
31
31
|
* </p>
|
|
@@ -68,6 +68,7 @@ declare const PutActionsCommand_base: {
|
|
|
68
68
|
* @throws {@link PersonalizeEventsServiceException}
|
|
69
69
|
* <p>Base exception class for all service exceptions from PersonalizeEvents service.</p>
|
|
70
70
|
*
|
|
71
|
+
* @public
|
|
71
72
|
*/
|
|
72
73
|
export declare class PutActionsCommand extends PutActionsCommand_base {
|
|
73
74
|
}
|
|
@@ -22,10 +22,10 @@ export interface PutEventsCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const PutEventsCommand_base: {
|
|
24
24
|
new (input: PutEventsCommandInput): import("@smithy/smithy-client").CommandImpl<PutEventsCommandInput, PutEventsCommandOutput, PersonalizeEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: PutEventsCommandInput): import("@smithy/smithy-client").CommandImpl<PutEventsCommandInput, PutEventsCommandOutput, PersonalizeEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Records item interaction event data. For more information see
|
|
30
30
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html">Recording item interaction events</a>.</p>
|
|
31
31
|
* @example
|
|
@@ -74,6 +74,7 @@ declare const PutEventsCommand_base: {
|
|
|
74
74
|
* @throws {@link PersonalizeEventsServiceException}
|
|
75
75
|
* <p>Base exception class for all service exceptions from PersonalizeEvents service.</p>
|
|
76
76
|
*
|
|
77
|
+
* @public
|
|
77
78
|
*/
|
|
78
79
|
export declare class PutEventsCommand extends PutEventsCommand_base {
|
|
79
80
|
}
|
|
@@ -22,10 +22,10 @@ export interface PutItemsCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const PutItemsCommand_base: {
|
|
24
24
|
new (input: PutItemsCommandInput): import("@smithy/smithy-client").CommandImpl<PutItemsCommandInput, PutItemsCommandOutput, PersonalizeEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: PutItemsCommandInput): import("@smithy/smithy-client").CommandImpl<PutItemsCommandInput, PutItemsCommandOutput, PersonalizeEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Adds one or more items to an Items dataset. For more information see
|
|
30
30
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html">Importing items individually</a>.
|
|
31
31
|
* </p>
|
|
@@ -68,6 +68,7 @@ declare const PutItemsCommand_base: {
|
|
|
68
68
|
* @throws {@link PersonalizeEventsServiceException}
|
|
69
69
|
* <p>Base exception class for all service exceptions from PersonalizeEvents service.</p>
|
|
70
70
|
*
|
|
71
|
+
* @public
|
|
71
72
|
*/
|
|
72
73
|
export declare class PutItemsCommand extends PutItemsCommand_base {
|
|
73
74
|
}
|
|
@@ -22,10 +22,10 @@ export interface PutUsersCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
}
|
|
23
23
|
declare const PutUsersCommand_base: {
|
|
24
24
|
new (input: PutUsersCommandInput): import("@smithy/smithy-client").CommandImpl<PutUsersCommandInput, PutUsersCommandOutput, PersonalizeEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: PutUsersCommandInput): import("@smithy/smithy-client").CommandImpl<PutUsersCommandInput, PutUsersCommandOutput, PersonalizeEventsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Adds one or more users to a Users dataset. For more information see
|
|
30
30
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html">Importing users individually</a>.</p>
|
|
31
31
|
* @example
|
|
@@ -67,6 +67,7 @@ declare const PutUsersCommand_base: {
|
|
|
67
67
|
* @throws {@link PersonalizeEventsServiceException}
|
|
68
68
|
* <p>Base exception class for all service exceptions from PersonalizeEvents service.</p>
|
|
69
69
|
*
|
|
70
|
+
* @public
|
|
70
71
|
*/
|
|
71
72
|
export declare class PutUsersCommand extends PutUsersCommand_base {
|
|
72
73
|
}
|
package/dist-types/index.d.ts
CHANGED
|
@@ -12,5 +12,4 @@ export { RuntimeExtension } from "./runtimeExtensions";
|
|
|
12
12
|
export { PersonalizeEventsExtensionConfiguration } from "./extensionConfiguration";
|
|
13
13
|
export * from "./commands";
|
|
14
14
|
export * from "./models";
|
|
15
|
-
import "@aws-sdk/util-endpoints";
|
|
16
15
|
export { PersonalizeEventsServiceException } from "./models/PersonalizeEventsServiceException";
|
|
@@ -1,86 +1,85 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@smithy/smithy-client";
|
|
2
2
|
import { PersonalizeEventsServiceException as __BaseException } from "./PersonalizeEventsServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>Represents action metadata added to an Action dataset using the
|
|
6
5
|
* <code>PutActions</code> API. For more information see
|
|
7
6
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-actions.html">Importing actions individually</a>.
|
|
8
7
|
* </p>
|
|
8
|
+
* @public
|
|
9
9
|
*/
|
|
10
10
|
export interface Action {
|
|
11
11
|
/**
|
|
12
|
-
* @public
|
|
13
12
|
* <p>The ID associated with the action.</p>
|
|
13
|
+
* @public
|
|
14
14
|
*/
|
|
15
15
|
actionId: string | undefined;
|
|
16
16
|
/**
|
|
17
|
-
* @public
|
|
18
17
|
* <p>A string map of action-specific metadata. Each element in the map consists of a key-value pair.
|
|
19
18
|
* For example, <code>\{"value": "100"\}</code>.</p>
|
|
20
19
|
* <p>The keys use camel case names that match the fields in the schema for the Actions
|
|
21
20
|
* dataset. In the previous example, the <code>value</code> matches the
|
|
22
21
|
* 'VALUE' field defined in the Actions schema. For categorical string data, to include multiple categories for a single action,
|
|
23
22
|
* separate each category with a pipe separator (<code>|</code>). For example, <code>\"Deluxe|Premium\"</code>.</p>
|
|
23
|
+
* @public
|
|
24
24
|
*/
|
|
25
25
|
properties?: __LazyJsonString | string;
|
|
26
26
|
}
|
|
27
27
|
/**
|
|
28
|
-
* @public
|
|
29
28
|
* <p>Represents an action interaction event sent using the
|
|
30
29
|
* <code>PutActionInteractions</code> API.</p>
|
|
30
|
+
* @public
|
|
31
31
|
*/
|
|
32
32
|
export interface ActionInteraction {
|
|
33
33
|
/**
|
|
34
|
-
* @public
|
|
35
34
|
* <p>The ID of the action the user interacted with. This corresponds to the <code>ACTION_ID</code>
|
|
36
35
|
* field of the Action interaction schema.</p>
|
|
36
|
+
* @public
|
|
37
37
|
*/
|
|
38
38
|
actionId: string | undefined;
|
|
39
39
|
/**
|
|
40
|
-
* @public
|
|
41
40
|
* <p>The ID of the user who interacted with the action. This corresponds to the <code>USER_ID</code>
|
|
42
41
|
* field of the Action interaction schema.</p>
|
|
42
|
+
* @public
|
|
43
43
|
*/
|
|
44
44
|
userId?: string;
|
|
45
45
|
/**
|
|
46
|
-
* @public
|
|
47
46
|
* <p>The ID associated with the user's visit.
|
|
48
47
|
* Your application generates a unique <code>sessionId</code> when a user first visits your website or uses your application. </p>
|
|
48
|
+
* @public
|
|
49
49
|
*/
|
|
50
50
|
sessionId: string | undefined;
|
|
51
51
|
/**
|
|
52
|
-
* @public
|
|
53
52
|
* <p>The timestamp for when the action interaction event occurred. Timestamps must be in Unix epoch time format, in seconds.</p>
|
|
53
|
+
* @public
|
|
54
54
|
*/
|
|
55
55
|
timestamp: Date | undefined;
|
|
56
56
|
/**
|
|
57
|
-
* @public
|
|
58
57
|
* <p>The type of action interaction event. You can specify <code>Viewed</code>, <code>Taken</code>, and <code>Not Taken</code> event types. For more
|
|
59
58
|
* information about action interaction event type data, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/action-interaction-event-type-data.html">Event type data</a>. </p>
|
|
59
|
+
* @public
|
|
60
60
|
*/
|
|
61
61
|
eventType: string | undefined;
|
|
62
62
|
/**
|
|
63
|
-
* @public
|
|
64
63
|
* <p>An ID associated with the event. If an event ID is not provided, Amazon Personalize generates
|
|
65
64
|
* a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses
|
|
66
65
|
* the event ID to distinguish unique events. Any subsequent events after the first with the
|
|
67
66
|
* same event ID are not used in model training.</p>
|
|
67
|
+
* @public
|
|
68
68
|
*/
|
|
69
69
|
eventId?: string;
|
|
70
70
|
/**
|
|
71
|
-
* @public
|
|
72
71
|
* <p>The ID of the list of recommendations that contains the action the user interacted with.</p>
|
|
72
|
+
* @public
|
|
73
73
|
*/
|
|
74
74
|
recommendationId?: string;
|
|
75
75
|
/**
|
|
76
|
-
* @public
|
|
77
76
|
* <p>A list of action IDs that represents the sequence of actions you have shown the user. For example, <code>["actionId1", "actionId2", "actionId3"]</code>.
|
|
78
77
|
* Amazon Personalize doesn't use impressions data from action interaction events. Instead, record multiple events for each action and use the <code>Viewed</code> event type.
|
|
79
78
|
* </p>
|
|
79
|
+
* @public
|
|
80
80
|
*/
|
|
81
81
|
impression?: string[];
|
|
82
82
|
/**
|
|
83
|
-
* @public
|
|
84
83
|
* <p>A string map of event-specific data that you might choose to record. For example, if a
|
|
85
84
|
* user takes an action, other than the action ID, you might also send the number of actions taken by the user.</p>
|
|
86
85
|
* <p>Each item in the map consists of a key-value pair. For example,</p>
|
|
@@ -117,12 +116,13 @@ export interface ActionInteraction {
|
|
|
117
116
|
* <p>impression</p>
|
|
118
117
|
* </li>
|
|
119
118
|
* </ul>
|
|
119
|
+
* @public
|
|
120
120
|
*/
|
|
121
121
|
properties?: __LazyJsonString | string;
|
|
122
122
|
}
|
|
123
123
|
/**
|
|
124
|
-
* @public
|
|
125
124
|
* <p>Provide a valid value for the field or parameter.</p>
|
|
125
|
+
* @public
|
|
126
126
|
*/
|
|
127
127
|
export declare class InvalidInputException extends __BaseException {
|
|
128
128
|
readonly name: "InvalidInputException";
|
|
@@ -137,20 +137,20 @@ export declare class InvalidInputException extends __BaseException {
|
|
|
137
137
|
*/
|
|
138
138
|
export interface PutActionInteractionsRequest {
|
|
139
139
|
/**
|
|
140
|
-
* @public
|
|
141
140
|
* <p>The ID of your action interaction event tracker. When you create an Action interactions dataset, Amazon Personalize creates an
|
|
142
141
|
* action interaction event tracker for you. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/action-interaction-tracker-id.html">Action interaction event tracker ID</a>.</p>
|
|
142
|
+
* @public
|
|
143
143
|
*/
|
|
144
144
|
trackingId: string | undefined;
|
|
145
145
|
/**
|
|
146
|
-
* @public
|
|
147
146
|
* <p>A list of action interaction events from the session.</p>
|
|
147
|
+
* @public
|
|
148
148
|
*/
|
|
149
149
|
actionInteractions: ActionInteraction[] | undefined;
|
|
150
150
|
}
|
|
151
151
|
/**
|
|
152
|
-
* @public
|
|
153
152
|
* <p>The specified resource is in use.</p>
|
|
153
|
+
* @public
|
|
154
154
|
*/
|
|
155
155
|
export declare class ResourceInUseException extends __BaseException {
|
|
156
156
|
readonly name: "ResourceInUseException";
|
|
@@ -161,8 +161,8 @@ export declare class ResourceInUseException extends __BaseException {
|
|
|
161
161
|
constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
|
|
162
162
|
}
|
|
163
163
|
/**
|
|
164
|
-
* @public
|
|
165
164
|
* <p>Could not find the specified resource.</p>
|
|
165
|
+
* @public
|
|
166
166
|
*/
|
|
167
167
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
168
168
|
readonly name: "ResourceNotFoundException";
|
|
@@ -177,59 +177,58 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
177
177
|
*/
|
|
178
178
|
export interface PutActionsRequest {
|
|
179
179
|
/**
|
|
180
|
-
* @public
|
|
181
180
|
* <p>The Amazon Resource Name (ARN) of the Actions dataset you are adding the action or actions to.</p>
|
|
181
|
+
* @public
|
|
182
182
|
*/
|
|
183
183
|
datasetArn: string | undefined;
|
|
184
184
|
/**
|
|
185
|
-
* @public
|
|
186
185
|
* <p>A list of action data.</p>
|
|
186
|
+
* @public
|
|
187
187
|
*/
|
|
188
188
|
actions: Action[] | undefined;
|
|
189
189
|
}
|
|
190
190
|
/**
|
|
191
|
-
* @public
|
|
192
191
|
* <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>
|
|
192
|
+
* @public
|
|
193
193
|
*/
|
|
194
194
|
export interface MetricAttribution {
|
|
195
195
|
/**
|
|
196
|
-
* @public
|
|
197
196
|
* <p>The source of the event, such as a third party.</p>
|
|
197
|
+
* @public
|
|
198
198
|
*/
|
|
199
199
|
eventAttributionSource: string | undefined;
|
|
200
200
|
}
|
|
201
201
|
/**
|
|
202
|
-
* @public
|
|
203
202
|
* <p>Represents item interaction event information sent using the
|
|
204
203
|
* <code>PutEvents</code> API.</p>
|
|
204
|
+
* @public
|
|
205
205
|
*/
|
|
206
206
|
export interface Event {
|
|
207
207
|
/**
|
|
208
|
-
* @public
|
|
209
208
|
* <p>An ID associated with the event. If an event ID is not provided, Amazon Personalize generates
|
|
210
209
|
* a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses
|
|
211
210
|
* the event ID to distinguish unique events. Any subsequent events after the first with the
|
|
212
211
|
* same event ID are not used in model training.</p>
|
|
212
|
+
* @public
|
|
213
213
|
*/
|
|
214
214
|
eventId?: string;
|
|
215
215
|
/**
|
|
216
|
-
* @public
|
|
217
216
|
* <p>The type of event, such as click or download. This property corresponds to the <code>EVENT_TYPE</code>
|
|
218
217
|
* field of your Item interactions dataset's schema and depends on the types of events you are tracking.</p>
|
|
218
|
+
* @public
|
|
219
219
|
*/
|
|
220
220
|
eventType: string | undefined;
|
|
221
221
|
/**
|
|
222
|
-
* @public
|
|
223
222
|
* <p>The event value that corresponds to the <code>EVENT_VALUE</code> field of the Item interactions schema.</p>
|
|
223
|
+
* @public
|
|
224
224
|
*/
|
|
225
225
|
eventValue?: number;
|
|
226
226
|
/**
|
|
227
|
-
* @public
|
|
228
227
|
* <p>The item ID key that corresponds to the <code>ITEM_ID</code> field of the Item interactions dataset's schema.</p>
|
|
228
|
+
* @public
|
|
229
229
|
*/
|
|
230
230
|
itemId?: string;
|
|
231
231
|
/**
|
|
232
|
-
* @public
|
|
233
232
|
* <p>A string map of event-specific data that you might choose to record. For example, if a
|
|
234
233
|
* user rates a movie on your site, other than movie ID (<code>itemId</code>) and rating (<code>eventValue</code>)
|
|
235
234
|
* , you might also send the number of movie ratings made by the user.</p>
|
|
@@ -268,15 +267,15 @@ export interface Event {
|
|
|
268
267
|
* <p>impression</p>
|
|
269
268
|
* </li>
|
|
270
269
|
* </ul>
|
|
270
|
+
* @public
|
|
271
271
|
*/
|
|
272
272
|
properties?: __LazyJsonString | string;
|
|
273
273
|
/**
|
|
274
|
-
* @public
|
|
275
274
|
* <p>The timestamp (in Unix time) on the client side when the event occurred.</p>
|
|
275
|
+
* @public
|
|
276
276
|
*/
|
|
277
277
|
sentAt: Date | undefined;
|
|
278
278
|
/**
|
|
279
|
-
* @public
|
|
280
279
|
* <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
|
|
281
280
|
* 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.
|
|
282
281
|
* </p>
|
|
@@ -284,18 +283,19 @@ export interface Event {
|
|
|
284
283
|
* 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>.
|
|
285
284
|
* 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>.
|
|
286
285
|
* </p>
|
|
286
|
+
* @public
|
|
287
287
|
*/
|
|
288
288
|
recommendationId?: string;
|
|
289
289
|
/**
|
|
290
|
-
* @public
|
|
291
290
|
* <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
|
|
292
291
|
* items to manually record impressions data for an event. For more information on recording impressions data,
|
|
293
292
|
* see <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data">Recording impressions data</a>. </p>
|
|
293
|
+
* @public
|
|
294
294
|
*/
|
|
295
295
|
impression?: string[];
|
|
296
296
|
/**
|
|
297
|
-
* @public
|
|
298
297
|
* <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>
|
|
298
|
+
* @public
|
|
299
299
|
*/
|
|
300
300
|
metricAttribution?: MetricAttribution;
|
|
301
301
|
}
|
|
@@ -304,51 +304,51 @@ export interface Event {
|
|
|
304
304
|
*/
|
|
305
305
|
export interface PutEventsRequest {
|
|
306
306
|
/**
|
|
307
|
-
* @public
|
|
308
307
|
* <p>The tracking ID for the event.
|
|
309
308
|
* The ID is generated by a call to the
|
|
310
309
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a> API.</p>
|
|
310
|
+
* @public
|
|
311
311
|
*/
|
|
312
312
|
trackingId: string | undefined;
|
|
313
313
|
/**
|
|
314
|
-
* @public
|
|
315
314
|
* <p>The user associated with the event.</p>
|
|
315
|
+
* @public
|
|
316
316
|
*/
|
|
317
317
|
userId?: string;
|
|
318
318
|
/**
|
|
319
|
-
* @public
|
|
320
319
|
* <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.
|
|
321
320
|
* Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information, see
|
|
322
321
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html">Recording item interaction events</a>.</p>
|
|
322
|
+
* @public
|
|
323
323
|
*/
|
|
324
324
|
sessionId: string | undefined;
|
|
325
325
|
/**
|
|
326
|
-
* @public
|
|
327
326
|
* <p>A list of event data from the session.</p>
|
|
327
|
+
* @public
|
|
328
328
|
*/
|
|
329
329
|
eventList: Event[] | undefined;
|
|
330
330
|
}
|
|
331
331
|
/**
|
|
332
|
-
* @public
|
|
333
332
|
* <p>Represents item metadata added to an Items dataset using the
|
|
334
333
|
* <code>PutItems</code> API. For more information see
|
|
335
334
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html">Importing items individually</a>.
|
|
336
335
|
* </p>
|
|
336
|
+
* @public
|
|
337
337
|
*/
|
|
338
338
|
export interface Item {
|
|
339
339
|
/**
|
|
340
|
-
* @public
|
|
341
340
|
* <p>The ID associated with the item.</p>
|
|
341
|
+
* @public
|
|
342
342
|
*/
|
|
343
343
|
itemId: string | undefined;
|
|
344
344
|
/**
|
|
345
|
-
* @public
|
|
346
345
|
* <p>A string map of item-specific metadata. Each element in the map consists of a key-value pair.
|
|
347
346
|
* For example, <code>\{"numberOfRatings": "12"\}</code>.</p>
|
|
348
347
|
* <p>The keys use camel case names that match the fields in the schema for the Items
|
|
349
348
|
* dataset. In the previous example, the <code>numberOfRatings</code> matches the
|
|
350
349
|
* 'NUMBER_OF_RATINGS' field defined in the Items schema. For categorical string data, to include multiple categories for a single item,
|
|
351
350
|
* separate each category with a pipe separator (<code>|</code>). For example, <code>\"Horror|Action\"</code>.</p>
|
|
351
|
+
* @public
|
|
352
352
|
*/
|
|
353
353
|
properties?: __LazyJsonString | string;
|
|
354
354
|
}
|
|
@@ -357,30 +357,29 @@ export interface Item {
|
|
|
357
357
|
*/
|
|
358
358
|
export interface PutItemsRequest {
|
|
359
359
|
/**
|
|
360
|
-
* @public
|
|
361
360
|
* <p>The Amazon Resource Name (ARN) of the Items dataset you are adding the item or items to.</p>
|
|
361
|
+
* @public
|
|
362
362
|
*/
|
|
363
363
|
datasetArn: string | undefined;
|
|
364
364
|
/**
|
|
365
|
-
* @public
|
|
366
365
|
* <p>A list of item data.</p>
|
|
366
|
+
* @public
|
|
367
367
|
*/
|
|
368
368
|
items: Item[] | undefined;
|
|
369
369
|
}
|
|
370
370
|
/**
|
|
371
|
-
* @public
|
|
372
371
|
* <p>Represents user metadata added to a Users dataset using the
|
|
373
372
|
* <code>PutUsers</code> API. For more information see
|
|
374
373
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html">Importing users individually</a>.</p>
|
|
374
|
+
* @public
|
|
375
375
|
*/
|
|
376
376
|
export interface User {
|
|
377
377
|
/**
|
|
378
|
-
* @public
|
|
379
378
|
* <p>The ID associated with the user.</p>
|
|
379
|
+
* @public
|
|
380
380
|
*/
|
|
381
381
|
userId: string | undefined;
|
|
382
382
|
/**
|
|
383
|
-
* @public
|
|
384
383
|
* <p>A string map of user-specific metadata. Each element in the map consists of a key-value pair.
|
|
385
384
|
* For example, <code>\{"numberOfVideosWatched": "45"\}</code>.</p>
|
|
386
385
|
* <p>The keys use camel case names that match the fields in the schema for the Users
|
|
@@ -388,6 +387,7 @@ export interface User {
|
|
|
388
387
|
* 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema. For categorical string data,
|
|
389
388
|
* to include multiple categories for a single user, separate each category with a pipe separator (<code>|</code>).
|
|
390
389
|
* For example, <code>\"Member|Frequent shopper\"</code>.</p>
|
|
390
|
+
* @public
|
|
391
391
|
*/
|
|
392
392
|
properties?: __LazyJsonString | string;
|
|
393
393
|
}
|
|
@@ -396,13 +396,13 @@ export interface User {
|
|
|
396
396
|
*/
|
|
397
397
|
export interface PutUsersRequest {
|
|
398
398
|
/**
|
|
399
|
-
* @public
|
|
400
399
|
* <p>The Amazon Resource Name (ARN) of the Users dataset you are adding the user or users to.</p>
|
|
400
|
+
* @public
|
|
401
401
|
*/
|
|
402
402
|
datasetArn: string | undefined;
|
|
403
403
|
/**
|
|
404
|
-
* @public
|
|
405
404
|
* <p>A list of user data.</p>
|
|
405
|
+
* @public
|
|
406
406
|
*/
|
|
407
407
|
users: User[] | undefined;
|
|
408
408
|
}
|
|
@@ -20,6 +20,15 @@ declare const PutActionInteractionsCommand_base: {
|
|
|
20
20
|
ServiceInputTypes,
|
|
21
21
|
ServiceOutputTypes
|
|
22
22
|
>;
|
|
23
|
+
new (
|
|
24
|
+
__0_0: PutActionInteractionsCommandInput
|
|
25
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
26
|
+
PutActionInteractionsCommandInput,
|
|
27
|
+
PutActionInteractionsCommandOutput,
|
|
28
|
+
PersonalizeEventsClientResolvedConfig,
|
|
29
|
+
ServiceInputTypes,
|
|
30
|
+
ServiceOutputTypes
|
|
31
|
+
>;
|
|
23
32
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
24
33
|
};
|
|
25
34
|
export declare class PutActionInteractionsCommand extends PutActionInteractionsCommand_base {}
|
|
@@ -19,6 +19,15 @@ declare const PutActionsCommand_base: {
|
|
|
19
19
|
ServiceInputTypes,
|
|
20
20
|
ServiceOutputTypes
|
|
21
21
|
>;
|
|
22
|
+
new (
|
|
23
|
+
__0_0: PutActionsCommandInput
|
|
24
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
25
|
+
PutActionsCommandInput,
|
|
26
|
+
PutActionsCommandOutput,
|
|
27
|
+
PersonalizeEventsClientResolvedConfig,
|
|
28
|
+
ServiceInputTypes,
|
|
29
|
+
ServiceOutputTypes
|
|
30
|
+
>;
|
|
22
31
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
23
32
|
};
|
|
24
33
|
export declare class PutActionsCommand extends PutActionsCommand_base {}
|
|
@@ -19,6 +19,15 @@ declare const PutEventsCommand_base: {
|
|
|
19
19
|
ServiceInputTypes,
|
|
20
20
|
ServiceOutputTypes
|
|
21
21
|
>;
|
|
22
|
+
new (
|
|
23
|
+
__0_0: PutEventsCommandInput
|
|
24
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
25
|
+
PutEventsCommandInput,
|
|
26
|
+
PutEventsCommandOutput,
|
|
27
|
+
PersonalizeEventsClientResolvedConfig,
|
|
28
|
+
ServiceInputTypes,
|
|
29
|
+
ServiceOutputTypes
|
|
30
|
+
>;
|
|
22
31
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
23
32
|
};
|
|
24
33
|
export declare class PutEventsCommand extends PutEventsCommand_base {}
|
|
@@ -19,6 +19,15 @@ declare const PutItemsCommand_base: {
|
|
|
19
19
|
ServiceInputTypes,
|
|
20
20
|
ServiceOutputTypes
|
|
21
21
|
>;
|
|
22
|
+
new (
|
|
23
|
+
__0_0: PutItemsCommandInput
|
|
24
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
25
|
+
PutItemsCommandInput,
|
|
26
|
+
PutItemsCommandOutput,
|
|
27
|
+
PersonalizeEventsClientResolvedConfig,
|
|
28
|
+
ServiceInputTypes,
|
|
29
|
+
ServiceOutputTypes
|
|
30
|
+
>;
|
|
22
31
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
23
32
|
};
|
|
24
33
|
export declare class PutItemsCommand extends PutItemsCommand_base {}
|
|
@@ -19,6 +19,15 @@ declare const PutUsersCommand_base: {
|
|
|
19
19
|
ServiceInputTypes,
|
|
20
20
|
ServiceOutputTypes
|
|
21
21
|
>;
|
|
22
|
+
new (
|
|
23
|
+
__0_0: PutUsersCommandInput
|
|
24
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
25
|
+
PutUsersCommandInput,
|
|
26
|
+
PutUsersCommandOutput,
|
|
27
|
+
PersonalizeEventsClientResolvedConfig,
|
|
28
|
+
ServiceInputTypes,
|
|
29
|
+
ServiceOutputTypes
|
|
30
|
+
>;
|
|
22
31
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
23
32
|
};
|
|
24
33
|
export declare class PutUsersCommand extends PutUsersCommand_base {}
|
|
@@ -5,5 +5,4 @@ export { RuntimeExtension } from "./runtimeExtensions";
|
|
|
5
5
|
export { PersonalizeEventsExtensionConfiguration } from "./extensionConfiguration";
|
|
6
6
|
export * from "./commands";
|
|
7
7
|
export * from "./models";
|
|
8
|
-
import "@aws-sdk/util-endpoints";
|
|
9
8
|
export { PersonalizeEventsServiceException } from "./models/PersonalizeEventsServiceException";
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-personalize-events",
|
|
3
3
|
"description": "AWS SDK for JavaScript Personalize Events Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.540.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-personalize-events",
|
|
@@ -20,47 +20,47 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
23
|
-
"@aws-sdk/client-sts": "3.
|
|
24
|
-
"@aws-sdk/core": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
27
|
-
"@aws-sdk/middleware-logger": "3.
|
|
28
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
29
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
30
|
-
"@aws-sdk/region-config-resolver": "3.
|
|
31
|
-
"@aws-sdk/types": "3.
|
|
32
|
-
"@aws-sdk/util-endpoints": "3.
|
|
33
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
34
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
35
|
-
"@smithy/config-resolver": "^2.
|
|
36
|
-
"@smithy/core": "^1.
|
|
37
|
-
"@smithy/fetch-http-handler": "^2.
|
|
38
|
-
"@smithy/hash-node": "^2.
|
|
39
|
-
"@smithy/invalid-dependency": "^2.
|
|
40
|
-
"@smithy/middleware-content-length": "^2.
|
|
41
|
-
"@smithy/middleware-endpoint": "^2.
|
|
42
|
-
"@smithy/middleware-retry": "^2.
|
|
43
|
-
"@smithy/middleware-serde": "^2.
|
|
44
|
-
"@smithy/middleware-stack": "^2.
|
|
45
|
-
"@smithy/node-config-provider": "^2.
|
|
46
|
-
"@smithy/node-http-handler": "^2.
|
|
47
|
-
"@smithy/protocol-http": "^3.
|
|
48
|
-
"@smithy/smithy-client": "^2.
|
|
49
|
-
"@smithy/types": "^2.
|
|
50
|
-
"@smithy/url-parser": "^2.
|
|
51
|
-
"@smithy/util-base64": "^2.
|
|
52
|
-
"@smithy/util-body-length-browser": "^2.
|
|
53
|
-
"@smithy/util-body-length-node": "^2.
|
|
54
|
-
"@smithy/util-defaults-mode-browser": "^2.
|
|
55
|
-
"@smithy/util-defaults-mode-node": "^2.
|
|
56
|
-
"@smithy/util-endpoints": "^1.
|
|
57
|
-
"@smithy/util-middleware": "^2.
|
|
58
|
-
"@smithy/util-retry": "^2.
|
|
59
|
-
"@smithy/util-utf8": "^2.
|
|
60
|
-
"tslib": "^2.
|
|
23
|
+
"@aws-sdk/client-sts": "3.540.0",
|
|
24
|
+
"@aws-sdk/core": "3.535.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.540.0",
|
|
26
|
+
"@aws-sdk/middleware-host-header": "3.535.0",
|
|
27
|
+
"@aws-sdk/middleware-logger": "3.535.0",
|
|
28
|
+
"@aws-sdk/middleware-recursion-detection": "3.535.0",
|
|
29
|
+
"@aws-sdk/middleware-user-agent": "3.540.0",
|
|
30
|
+
"@aws-sdk/region-config-resolver": "3.535.0",
|
|
31
|
+
"@aws-sdk/types": "3.535.0",
|
|
32
|
+
"@aws-sdk/util-endpoints": "3.540.0",
|
|
33
|
+
"@aws-sdk/util-user-agent-browser": "3.535.0",
|
|
34
|
+
"@aws-sdk/util-user-agent-node": "3.535.0",
|
|
35
|
+
"@smithy/config-resolver": "^2.2.0",
|
|
36
|
+
"@smithy/core": "^1.4.0",
|
|
37
|
+
"@smithy/fetch-http-handler": "^2.5.0",
|
|
38
|
+
"@smithy/hash-node": "^2.2.0",
|
|
39
|
+
"@smithy/invalid-dependency": "^2.2.0",
|
|
40
|
+
"@smithy/middleware-content-length": "^2.2.0",
|
|
41
|
+
"@smithy/middleware-endpoint": "^2.5.0",
|
|
42
|
+
"@smithy/middleware-retry": "^2.2.0",
|
|
43
|
+
"@smithy/middleware-serde": "^2.3.0",
|
|
44
|
+
"@smithy/middleware-stack": "^2.2.0",
|
|
45
|
+
"@smithy/node-config-provider": "^2.3.0",
|
|
46
|
+
"@smithy/node-http-handler": "^2.5.0",
|
|
47
|
+
"@smithy/protocol-http": "^3.3.0",
|
|
48
|
+
"@smithy/smithy-client": "^2.5.0",
|
|
49
|
+
"@smithy/types": "^2.12.0",
|
|
50
|
+
"@smithy/url-parser": "^2.2.0",
|
|
51
|
+
"@smithy/util-base64": "^2.3.0",
|
|
52
|
+
"@smithy/util-body-length-browser": "^2.2.0",
|
|
53
|
+
"@smithy/util-body-length-node": "^2.3.0",
|
|
54
|
+
"@smithy/util-defaults-mode-browser": "^2.2.0",
|
|
55
|
+
"@smithy/util-defaults-mode-node": "^2.3.0",
|
|
56
|
+
"@smithy/util-endpoints": "^1.2.0",
|
|
57
|
+
"@smithy/util-middleware": "^2.2.0",
|
|
58
|
+
"@smithy/util-retry": "^2.2.0",
|
|
59
|
+
"@smithy/util-utf8": "^2.3.0",
|
|
60
|
+
"tslib": "^2.6.2"
|
|
61
61
|
},
|
|
62
62
|
"devDependencies": {
|
|
63
|
-
"@smithy/service-client-documentation-generator": "^2.
|
|
63
|
+
"@smithy/service-client-documentation-generator": "^2.2.0",
|
|
64
64
|
"@tsconfig/node14": "1.0.3",
|
|
65
65
|
"@types/node": "^14.14.31",
|
|
66
66
|
"concurrently": "7.0.0",
|