@aws-sdk/client-personalize-events 3.451.0 → 3.458.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.
Files changed (32) hide show
  1. package/README.md +27 -11
  2. package/dist-cjs/PersonalizeEvents.js +4 -0
  3. package/dist-cjs/commands/PutActionInteractionsCommand.js +52 -0
  4. package/dist-cjs/commands/PutActionsCommand.js +52 -0
  5. package/dist-cjs/commands/index.js +2 -0
  6. package/dist-cjs/models/models_0.js +26 -1
  7. package/dist-cjs/protocols/Aws_restJson1.js +150 -1
  8. package/dist-es/PersonalizeEvents.js +4 -0
  9. package/dist-es/commands/PutActionInteractionsCommand.js +48 -0
  10. package/dist-es/commands/PutActionsCommand.js +48 -0
  11. package/dist-es/commands/index.js +2 -0
  12. package/dist-es/models/models_0.js +21 -0
  13. package/dist-es/protocols/Aws_restJson1.js +145 -0
  14. package/dist-types/PersonalizeEvents.d.ts +15 -1
  15. package/dist-types/PersonalizeEventsClient.d.ts +5 -3
  16. package/dist-types/commands/PutActionInteractionsCommand.d.ts +99 -0
  17. package/dist-types/commands/PutActionsCommand.d.ts +88 -0
  18. package/dist-types/commands/PutEventsCommand.d.ts +2 -2
  19. package/dist-types/commands/PutItemsCommand.d.ts +1 -1
  20. package/dist-types/commands/PutUsersCommand.d.ts +1 -1
  21. package/dist-types/commands/index.d.ts +2 -0
  22. package/dist-types/index.d.ts +1 -1
  23. package/dist-types/models/models_0.d.ts +229 -34
  24. package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
  25. package/dist-types/ts3.4/PersonalizeEvents.d.ts +34 -0
  26. package/dist-types/ts3.4/PersonalizeEventsClient.d.ts +12 -0
  27. package/dist-types/ts3.4/commands/PutActionInteractionsCommand.d.ts +37 -0
  28. package/dist-types/ts3.4/commands/PutActionsCommand.d.ts +33 -0
  29. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  30. package/dist-types/ts3.4/models/models_0.d.ts +47 -14
  31. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
  32. package/package.json +3 -3
@@ -1,5 +1,125 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@smithy/smithy-client";
2
2
  import { PersonalizeEventsServiceException as __BaseException } from "./PersonalizeEventsServiceException";
3
+ /**
4
+ * @public
5
+ * <p>Represents action metadata added to an Action dataset using the
6
+ * <code>PutActions</code> API. For more information see
7
+ * <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-actions.html">Importing actions individually</a>.
8
+ * </p>
9
+ */
10
+ export interface Action {
11
+ /**
12
+ * @public
13
+ * <p>The ID associated with the action.</p>
14
+ */
15
+ actionId: string | undefined;
16
+ /**
17
+ * @public
18
+ * <p>A string map of action-specific metadata. Each element in the map consists of a key-value pair.
19
+ * For example, <code>\{"value": "100"\}</code>.</p>
20
+ * <p>The keys use camel case names that match the fields in the schema for the Actions
21
+ * dataset. In the previous example, the <code>value</code> matches the
22
+ * 'VALUE' field defined in the Actions schema. For categorical string data, to include multiple categories for a single action,
23
+ * separate each category with a pipe separator (<code>|</code>). For example, <code>\"Deluxe|Premium\"</code>.</p>
24
+ */
25
+ properties?: __LazyJsonString | string;
26
+ }
27
+ /**
28
+ * @public
29
+ * <p>Represents an action interaction event sent using the
30
+ * <code>PutActionInteractions</code> API.</p>
31
+ */
32
+ export interface ActionInteraction {
33
+ /**
34
+ * @public
35
+ * <p>The ID of the action the user interacted with. This corresponds to the <code>ACTION_ID</code>
36
+ * field of the Action interaction schema.</p>
37
+ */
38
+ actionId: string | undefined;
39
+ /**
40
+ * @public
41
+ * <p>The ID of the user who interacted with the action. This corresponds to the <code>USER_ID</code>
42
+ * field of the Action interaction schema.</p>
43
+ */
44
+ userId?: string;
45
+ /**
46
+ * @public
47
+ * <p>The ID associated with the user's visit.
48
+ * Your application generates a unique <code>sessionId</code> when a user first visits your website or uses your application. </p>
49
+ */
50
+ sessionId: string | undefined;
51
+ /**
52
+ * @public
53
+ * <p>The timestamp for when the action interaction event occurred. Timestamps must be in Unix epoch time format, in seconds.</p>
54
+ */
55
+ timestamp: Date | undefined;
56
+ /**
57
+ * @public
58
+ * <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
+ * 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>
60
+ */
61
+ eventType: string | undefined;
62
+ /**
63
+ * @public
64
+ * <p>An ID associated with the event. If an event ID is not provided, Amazon Personalize generates
65
+ * a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses
66
+ * the event ID to distinguish unique events. Any subsequent events after the first with the
67
+ * same event ID are not used in model training.</p>
68
+ */
69
+ eventId?: string;
70
+ /**
71
+ * @public
72
+ * <p>The ID of the list of recommendations that contains the action the user interacted with.</p>
73
+ */
74
+ recommendationId?: string;
75
+ /**
76
+ * @public
77
+ * <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
+ * 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
+ * </p>
80
+ */
81
+ impression?: string[];
82
+ /**
83
+ * @public
84
+ * <p>A string map of event-specific data that you might choose to record. For example, if a
85
+ * user takes an action, other than the action ID, you might also send the number of actions taken by the user.</p>
86
+ * <p>Each item in the map consists of a key-value pair. For example,</p>
87
+ * <p>
88
+ * <code>\{"numberOfActions": "12"\}</code>
89
+ * </p>
90
+ * <p>The keys use camel case names that match the fields in the Action interactions
91
+ * schema. In the above example, the <code>numberOfActions</code> would match the
92
+ * 'NUMBER_OF_ACTIONS' field defined in the Action interactions schema.</p>
93
+ * <p>
94
+ * The following can't be included as a keyword for properties (case insensitive).
95
+ * </p>
96
+ * <ul>
97
+ * <li>
98
+ * <p>
99
+ * userId
100
+ * </p>
101
+ * </li>
102
+ * <li>
103
+ * <p>
104
+ * sessionId
105
+ * </p>
106
+ * </li>
107
+ * <li>
108
+ * <p>eventType</p>
109
+ * </li>
110
+ * <li>
111
+ * <p>timestamp</p>
112
+ * </li>
113
+ * <li>
114
+ * <p>recommendationId</p>
115
+ * </li>
116
+ * <li>
117
+ * <p>impression</p>
118
+ * </li>
119
+ * </ul>
120
+ */
121
+ properties?: __LazyJsonString | string;
122
+ }
3
123
  /**
4
124
  * @public
5
125
  * <p>Provide a valid value for the field or parameter.</p>
@@ -12,6 +132,61 @@ export declare class InvalidInputException extends __BaseException {
12
132
  */
13
133
  constructor(opts: __ExceptionOptionType<InvalidInputException, __BaseException>);
14
134
  }
135
+ /**
136
+ * @public
137
+ */
138
+ export interface PutActionInteractionsRequest {
139
+ /**
140
+ * @public
141
+ * <p>The ID of your action interaction event tracker. When you create an Action interactions dataset, Amazon Personalize creates an
142
+ * 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>
143
+ */
144
+ trackingId: string | undefined;
145
+ /**
146
+ * @public
147
+ * <p>A list of action interaction events from the session.</p>
148
+ */
149
+ actionInteractions: ActionInteraction[] | undefined;
150
+ }
151
+ /**
152
+ * @public
153
+ * <p>The specified resource is in use.</p>
154
+ */
155
+ export declare class ResourceInUseException extends __BaseException {
156
+ readonly name: "ResourceInUseException";
157
+ readonly $fault: "client";
158
+ /**
159
+ * @internal
160
+ */
161
+ constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
162
+ }
163
+ /**
164
+ * @public
165
+ * <p>Could not find the specified resource.</p>
166
+ */
167
+ export declare class ResourceNotFoundException extends __BaseException {
168
+ readonly name: "ResourceNotFoundException";
169
+ readonly $fault: "client";
170
+ /**
171
+ * @internal
172
+ */
173
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
174
+ }
175
+ /**
176
+ * @public
177
+ */
178
+ export interface PutActionsRequest {
179
+ /**
180
+ * @public
181
+ * <p>The Amazon Resource Name (ARN) of the Actions dataset you are adding the action or actions to.</p>
182
+ */
183
+ datasetArn: string | undefined;
184
+ /**
185
+ * @public
186
+ * <p>A list of action data.</p>
187
+ */
188
+ actions: Action[] | undefined;
189
+ }
15
190
  /**
16
191
  * @public
17
192
  * <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>
@@ -25,7 +200,7 @@ export interface MetricAttribution {
25
200
  }
26
201
  /**
27
202
  * @public
28
- * <p>Represents user interaction event information sent using the
203
+ * <p>Represents item interaction event information sent using the
29
204
  * <code>PutEvents</code> API.</p>
30
205
  */
31
206
  export interface Event {
@@ -33,24 +208,24 @@ export interface Event {
33
208
  * @public
34
209
  * <p>An ID associated with the event. If an event ID is not provided, Amazon Personalize generates
35
210
  * a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses
36
- * the event ID to distinquish unique events. Any subsequent events after the first with the
211
+ * the event ID to distinguish unique events. Any subsequent events after the first with the
37
212
  * same event ID are not used in model training.</p>
38
213
  */
39
214
  eventId?: string;
40
215
  /**
41
216
  * @public
42
217
  * <p>The type of event, such as click or download. This property corresponds to the <code>EVENT_TYPE</code>
43
- * field of your Interactions schema and depends on the types of events you are tracking.</p>
218
+ * field of your Item interactions dataset's schema and depends on the types of events you are tracking.</p>
44
219
  */
45
220
  eventType: string | undefined;
46
221
  /**
47
222
  * @public
48
- * <p>The event value that corresponds to the <code>EVENT_VALUE</code> field of the Interactions schema.</p>
223
+ * <p>The event value that corresponds to the <code>EVENT_VALUE</code> field of the Item interactions schema.</p>
49
224
  */
50
225
  eventValue?: number;
51
226
  /**
52
227
  * @public
53
- * <p>The item ID key that corresponds to the <code>ITEM_ID</code> field of the Interactions schema.</p>
228
+ * <p>The item ID key that corresponds to the <code>ITEM_ID</code> field of the Item interactions dataset's schema.</p>
54
229
  */
55
230
  itemId?: string;
56
231
  /**
@@ -62,9 +237,37 @@ export interface Event {
62
237
  * <p>
63
238
  * <code>\{"numberOfRatings": "12"\}</code>
64
239
  * </p>
65
- * <p>The keys use camel case names that match the fields in the Interactions
240
+ * <p>The keys use camel case names that match the fields in the Item interactions dataset's
66
241
  * schema. In the above example, the <code>numberOfRatings</code> would match the
67
- * 'NUMBER_OF_RATINGS' field defined in the Interactions schema.</p>
242
+ * 'NUMBER_OF_RATINGS' field defined in the Item interactions dataset's schema.</p>
243
+ * <p>
244
+ * The following can't be included as a keyword for properties (case insensitive).
245
+ *
246
+ * </p>
247
+ * <ul>
248
+ * <li>
249
+ * <p>
250
+ * userId
251
+ * </p>
252
+ * </li>
253
+ * <li>
254
+ * <p>
255
+ * sessionId
256
+ * </p>
257
+ * </li>
258
+ * <li>
259
+ * <p>eventType</p>
260
+ * </li>
261
+ * <li>
262
+ * <p>timestamp</p>
263
+ * </li>
264
+ * <li>
265
+ * <p>recommendationId</p>
266
+ * </li>
267
+ * <li>
268
+ * <p>impression</p>
269
+ * </li>
270
+ * </ul>
68
271
  */
69
272
  properties?: __LazyJsonString | string;
70
273
  /**
@@ -116,7 +319,7 @@ export interface PutEventsRequest {
116
319
  * @public
117
320
  * <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.
118
321
  * Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information, see
119
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html">Recording Events</a>.</p>
322
+ * <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html">Recording item interaction events</a>.</p>
120
323
  */
121
324
  sessionId: string | undefined;
122
325
  /**
@@ -129,7 +332,7 @@ export interface PutEventsRequest {
129
332
  * @public
130
333
  * <p>Represents item metadata added to an Items dataset using the
131
334
  * <code>PutItems</code> API. For more information see
132
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html">Importing Items Incrementally</a>.
335
+ * <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html">Importing items individually</a>.
133
336
  * </p>
134
337
  */
135
338
  export interface Item {
@@ -164,35 +367,11 @@ export interface PutItemsRequest {
164
367
  */
165
368
  items: Item[] | undefined;
166
369
  }
167
- /**
168
- * @public
169
- * <p>The specified resource is in use.</p>
170
- */
171
- export declare class ResourceInUseException extends __BaseException {
172
- readonly name: "ResourceInUseException";
173
- readonly $fault: "client";
174
- /**
175
- * @internal
176
- */
177
- constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
178
- }
179
- /**
180
- * @public
181
- * <p>Could not find the specified resource.</p>
182
- */
183
- export declare class ResourceNotFoundException extends __BaseException {
184
- readonly name: "ResourceNotFoundException";
185
- readonly $fault: "client";
186
- /**
187
- * @internal
188
- */
189
- constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
190
- }
191
370
  /**
192
371
  * @public
193
372
  * <p>Represents user metadata added to a Users dataset using the
194
373
  * <code>PutUsers</code> API. For more information see
195
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html">Importing Users Incrementally</a>.</p>
374
+ * <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html">Importing users individually</a>.</p>
196
375
  */
197
376
  export interface User {
198
377
  /**
@@ -227,6 +406,22 @@ export interface PutUsersRequest {
227
406
  */
228
407
  users: User[] | undefined;
229
408
  }
409
+ /**
410
+ * @internal
411
+ */
412
+ export declare const ActionFilterSensitiveLog: (obj: Action) => any;
413
+ /**
414
+ * @internal
415
+ */
416
+ export declare const ActionInteractionFilterSensitiveLog: (obj: ActionInteraction) => any;
417
+ /**
418
+ * @internal
419
+ */
420
+ export declare const PutActionInteractionsRequestFilterSensitiveLog: (obj: PutActionInteractionsRequest) => any;
421
+ /**
422
+ * @internal
423
+ */
424
+ export declare const PutActionsRequestFilterSensitiveLog: (obj: PutActionsRequest) => any;
230
425
  /**
231
426
  * @internal
232
427
  */
@@ -1,8 +1,18 @@
1
1
  import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
2
2
  import { SerdeContext as __SerdeContext } from "@smithy/types";
3
+ import { PutActionInteractionsCommandInput, PutActionInteractionsCommandOutput } from "../commands/PutActionInteractionsCommand";
4
+ import { PutActionsCommandInput, PutActionsCommandOutput } from "../commands/PutActionsCommand";
3
5
  import { PutEventsCommandInput, PutEventsCommandOutput } from "../commands/PutEventsCommand";
4
6
  import { PutItemsCommandInput, PutItemsCommandOutput } from "../commands/PutItemsCommand";
5
7
  import { PutUsersCommandInput, PutUsersCommandOutput } from "../commands/PutUsersCommand";
8
+ /**
9
+ * serializeAws_restJson1PutActionInteractionsCommand
10
+ */
11
+ export declare const se_PutActionInteractionsCommand: (input: PutActionInteractionsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
12
+ /**
13
+ * serializeAws_restJson1PutActionsCommand
14
+ */
15
+ export declare const se_PutActionsCommand: (input: PutActionsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
6
16
  /**
7
17
  * serializeAws_restJson1PutEventsCommand
8
18
  */
@@ -15,6 +25,14 @@ export declare const se_PutItemsCommand: (input: PutItemsCommandInput, context:
15
25
  * serializeAws_restJson1PutUsersCommand
16
26
  */
17
27
  export declare const se_PutUsersCommand: (input: PutUsersCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
28
+ /**
29
+ * deserializeAws_restJson1PutActionInteractionsCommand
30
+ */
31
+ export declare const de_PutActionInteractionsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<PutActionInteractionsCommandOutput>;
32
+ /**
33
+ * deserializeAws_restJson1PutActionsCommand
34
+ */
35
+ export declare const de_PutActionsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<PutActionsCommandOutput>;
18
36
  /**
19
37
  * deserializeAws_restJson1PutEventsCommand
20
38
  */
@@ -1,4 +1,12 @@
1
1
  import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
2
+ import {
3
+ PutActionInteractionsCommandInput,
4
+ PutActionInteractionsCommandOutput,
5
+ } from "./commands/PutActionInteractionsCommand";
6
+ import {
7
+ PutActionsCommandInput,
8
+ PutActionsCommandOutput,
9
+ } from "./commands/PutActionsCommand";
2
10
  import {
3
11
  PutEventsCommandInput,
4
12
  PutEventsCommandOutput,
@@ -13,6 +21,32 @@ import {
13
21
  } from "./commands/PutUsersCommand";
14
22
  import { PersonalizeEventsClient } from "./PersonalizeEventsClient";
15
23
  export interface PersonalizeEvents {
24
+ putActionInteractions(
25
+ args: PutActionInteractionsCommandInput,
26
+ options?: __HttpHandlerOptions
27
+ ): Promise<PutActionInteractionsCommandOutput>;
28
+ putActionInteractions(
29
+ args: PutActionInteractionsCommandInput,
30
+ cb: (err: any, data?: PutActionInteractionsCommandOutput) => void
31
+ ): void;
32
+ putActionInteractions(
33
+ args: PutActionInteractionsCommandInput,
34
+ options: __HttpHandlerOptions,
35
+ cb: (err: any, data?: PutActionInteractionsCommandOutput) => void
36
+ ): void;
37
+ putActions(
38
+ args: PutActionsCommandInput,
39
+ options?: __HttpHandlerOptions
40
+ ): Promise<PutActionsCommandOutput>;
41
+ putActions(
42
+ args: PutActionsCommandInput,
43
+ cb: (err: any, data?: PutActionsCommandOutput) => void
44
+ ): void;
45
+ putActions(
46
+ args: PutActionsCommandInput,
47
+ options: __HttpHandlerOptions,
48
+ cb: (err: any, data?: PutActionsCommandOutput) => void
49
+ ): void;
16
50
  putEvents(
17
51
  args: PutEventsCommandInput,
18
52
  options?: __HttpHandlerOptions
@@ -45,6 +45,14 @@ import {
45
45
  UrlParser as __UrlParser,
46
46
  UserAgent as __UserAgent,
47
47
  } from "@smithy/types";
48
+ import {
49
+ PutActionInteractionsCommandInput,
50
+ PutActionInteractionsCommandOutput,
51
+ } from "./commands/PutActionInteractionsCommand";
52
+ import {
53
+ PutActionsCommandInput,
54
+ PutActionsCommandOutput,
55
+ } from "./commands/PutActionsCommand";
48
56
  import {
49
57
  PutEventsCommandInput,
50
58
  PutEventsCommandOutput,
@@ -65,10 +73,14 @@ import {
65
73
  import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
66
74
  export { __Client };
67
75
  export type ServiceInputTypes =
76
+ | PutActionInteractionsCommandInput
77
+ | PutActionsCommandInput
68
78
  | PutEventsCommandInput
69
79
  | PutItemsCommandInput
70
80
  | PutUsersCommandInput;
71
81
  export type ServiceOutputTypes =
82
+ | PutActionInteractionsCommandOutput
83
+ | PutActionsCommandOutput
72
84
  | PutEventsCommandOutput
73
85
  | PutItemsCommandOutput
74
86
  | PutUsersCommandOutput;
@@ -0,0 +1,37 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import {
4
+ Handler,
5
+ HttpHandlerOptions as __HttpHandlerOptions,
6
+ MetadataBearer as __MetadataBearer,
7
+ MiddlewareStack,
8
+ } from "@smithy/types";
9
+ import { PutActionInteractionsRequest } from "../models/models_0";
10
+ import {
11
+ PersonalizeEventsClientResolvedConfig,
12
+ ServiceInputTypes,
13
+ ServiceOutputTypes,
14
+ } from "../PersonalizeEventsClient";
15
+ export { __MetadataBearer, $Command };
16
+ export interface PutActionInteractionsCommandInput
17
+ extends PutActionInteractionsRequest {}
18
+ export interface PutActionInteractionsCommandOutput extends __MetadataBearer {}
19
+ export declare class PutActionInteractionsCommand extends $Command<
20
+ PutActionInteractionsCommandInput,
21
+ PutActionInteractionsCommandOutput,
22
+ PersonalizeEventsClientResolvedConfig
23
+ > {
24
+ readonly input: PutActionInteractionsCommandInput;
25
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
26
+ constructor(input: PutActionInteractionsCommandInput);
27
+ resolveMiddleware(
28
+ clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
29
+ configuration: PersonalizeEventsClientResolvedConfig,
30
+ options?: __HttpHandlerOptions
31
+ ): Handler<
32
+ PutActionInteractionsCommandInput,
33
+ PutActionInteractionsCommandOutput
34
+ >;
35
+ private serialize;
36
+ private deserialize;
37
+ }
@@ -0,0 +1,33 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import {
4
+ Handler,
5
+ HttpHandlerOptions as __HttpHandlerOptions,
6
+ MetadataBearer as __MetadataBearer,
7
+ MiddlewareStack,
8
+ } from "@smithy/types";
9
+ import { PutActionsRequest } from "../models/models_0";
10
+ import {
11
+ PersonalizeEventsClientResolvedConfig,
12
+ ServiceInputTypes,
13
+ ServiceOutputTypes,
14
+ } from "../PersonalizeEventsClient";
15
+ export { __MetadataBearer, $Command };
16
+ export interface PutActionsCommandInput extends PutActionsRequest {}
17
+ export interface PutActionsCommandOutput extends __MetadataBearer {}
18
+ export declare class PutActionsCommand extends $Command<
19
+ PutActionsCommandInput,
20
+ PutActionsCommandOutput,
21
+ PersonalizeEventsClientResolvedConfig
22
+ > {
23
+ readonly input: PutActionsCommandInput;
24
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
25
+ constructor(input: PutActionsCommandInput);
26
+ resolveMiddleware(
27
+ clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
28
+ configuration: PersonalizeEventsClientResolvedConfig,
29
+ options?: __HttpHandlerOptions
30
+ ): Handler<PutActionsCommandInput, PutActionsCommandOutput>;
31
+ private serialize;
32
+ private deserialize;
33
+ }
@@ -1,3 +1,5 @@
1
+ export * from "./PutActionInteractionsCommand";
2
+ export * from "./PutActionsCommand";
1
3
  export * from "./PutEventsCommand";
2
4
  export * from "./PutItemsCommand";
3
5
  export * from "./PutUsersCommand";
@@ -3,6 +3,21 @@ import {
3
3
  LazyJsonString as __LazyJsonString,
4
4
  } from "@smithy/smithy-client";
5
5
  import { PersonalizeEventsServiceException as __BaseException } from "./PersonalizeEventsServiceException";
6
+ export interface Action {
7
+ actionId: string | undefined;
8
+ properties?: __LazyJsonString | string;
9
+ }
10
+ export interface ActionInteraction {
11
+ actionId: string | undefined;
12
+ userId?: string;
13
+ sessionId: string | undefined;
14
+ timestamp: Date | undefined;
15
+ eventType: string | undefined;
16
+ eventId?: string;
17
+ recommendationId?: string;
18
+ impression?: string[];
19
+ properties?: __LazyJsonString | string;
20
+ }
6
21
  export declare class InvalidInputException extends __BaseException {
7
22
  readonly name: "InvalidInputException";
8
23
  readonly $fault: "client";
@@ -10,6 +25,28 @@ export declare class InvalidInputException extends __BaseException {
10
25
  opts: __ExceptionOptionType<InvalidInputException, __BaseException>
11
26
  );
12
27
  }
28
+ export interface PutActionInteractionsRequest {
29
+ trackingId: string | undefined;
30
+ actionInteractions: ActionInteraction[] | undefined;
31
+ }
32
+ export declare class ResourceInUseException extends __BaseException {
33
+ readonly name: "ResourceInUseException";
34
+ readonly $fault: "client";
35
+ constructor(
36
+ opts: __ExceptionOptionType<ResourceInUseException, __BaseException>
37
+ );
38
+ }
39
+ export declare class ResourceNotFoundException extends __BaseException {
40
+ readonly name: "ResourceNotFoundException";
41
+ readonly $fault: "client";
42
+ constructor(
43
+ opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
44
+ );
45
+ }
46
+ export interface PutActionsRequest {
47
+ datasetArn: string | undefined;
48
+ actions: Action[] | undefined;
49
+ }
13
50
  export interface MetricAttribution {
14
51
  eventAttributionSource: string | undefined;
15
52
  }
@@ -38,20 +75,6 @@ export interface PutItemsRequest {
38
75
  datasetArn: string | undefined;
39
76
  items: Item[] | undefined;
40
77
  }
41
- export declare class ResourceInUseException extends __BaseException {
42
- readonly name: "ResourceInUseException";
43
- readonly $fault: "client";
44
- constructor(
45
- opts: __ExceptionOptionType<ResourceInUseException, __BaseException>
46
- );
47
- }
48
- export declare class ResourceNotFoundException extends __BaseException {
49
- readonly name: "ResourceNotFoundException";
50
- readonly $fault: "client";
51
- constructor(
52
- opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
53
- );
54
- }
55
78
  export interface User {
56
79
  userId: string | undefined;
57
80
  properties?: __LazyJsonString | string;
@@ -60,6 +83,16 @@ export interface PutUsersRequest {
60
83
  datasetArn: string | undefined;
61
84
  users: User[] | undefined;
62
85
  }
86
+ export declare const ActionFilterSensitiveLog: (obj: Action) => any;
87
+ export declare const ActionInteractionFilterSensitiveLog: (
88
+ obj: ActionInteraction
89
+ ) => any;
90
+ export declare const PutActionInteractionsRequestFilterSensitiveLog: (
91
+ obj: PutActionInteractionsRequest
92
+ ) => any;
93
+ export declare const PutActionsRequestFilterSensitiveLog: (
94
+ obj: PutActionsRequest
95
+ ) => any;
63
96
  export declare const EventFilterSensitiveLog: (obj: Event) => any;
64
97
  export declare const PutEventsRequestFilterSensitiveLog: (
65
98
  obj: PutEventsRequest
@@ -3,6 +3,14 @@ import {
3
3
  HttpResponse as __HttpResponse,
4
4
  } from "@smithy/protocol-http";
5
5
  import { SerdeContext as __SerdeContext } from "@smithy/types";
6
+ import {
7
+ PutActionInteractionsCommandInput,
8
+ PutActionInteractionsCommandOutput,
9
+ } from "../commands/PutActionInteractionsCommand";
10
+ import {
11
+ PutActionsCommandInput,
12
+ PutActionsCommandOutput,
13
+ } from "../commands/PutActionsCommand";
6
14
  import {
7
15
  PutEventsCommandInput,
8
16
  PutEventsCommandOutput,
@@ -15,6 +23,14 @@ import {
15
23
  PutUsersCommandInput,
16
24
  PutUsersCommandOutput,
17
25
  } from "../commands/PutUsersCommand";
26
+ export declare const se_PutActionInteractionsCommand: (
27
+ input: PutActionInteractionsCommandInput,
28
+ context: __SerdeContext
29
+ ) => Promise<__HttpRequest>;
30
+ export declare const se_PutActionsCommand: (
31
+ input: PutActionsCommandInput,
32
+ context: __SerdeContext
33
+ ) => Promise<__HttpRequest>;
18
34
  export declare const se_PutEventsCommand: (
19
35
  input: PutEventsCommandInput,
20
36
  context: __SerdeContext
@@ -27,6 +43,14 @@ export declare const se_PutUsersCommand: (
27
43
  input: PutUsersCommandInput,
28
44
  context: __SerdeContext
29
45
  ) => Promise<__HttpRequest>;
46
+ export declare const de_PutActionInteractionsCommand: (
47
+ output: __HttpResponse,
48
+ context: __SerdeContext
49
+ ) => Promise<PutActionInteractionsCommandOutput>;
50
+ export declare const de_PutActionsCommand: (
51
+ output: __HttpResponse,
52
+ context: __SerdeContext
53
+ ) => Promise<PutActionsCommandOutput>;
30
54
  export declare const de_PutEventsCommand: (
31
55
  output: __HttpResponse,
32
56
  context: __SerdeContext