@aws-sdk/client-personalize 3.58.0 → 3.66.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/CHANGELOG.md +11 -0
- package/dist-cjs/Personalize.js +45 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +36 -0
- package/dist-cjs/commands/TagResourceCommand.js +36 -0
- package/dist-cjs/commands/UntagResourceCommand.js +36 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/models/models_0.js +72 -4
- package/dist-cjs/protocols/Aws_json1_1.js +315 -2
- package/dist-es/Personalize.js +45 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +39 -0
- package/dist-es/commands/TagResourceCommand.js +39 -0
- package/dist-es/commands/UntagResourceCommand.js +39 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +52 -0
- package/dist-es/protocols/Aws_json1_1.js +403 -47
- package/dist-types/Personalize.d.ts +113 -89
- package/dist-types/PersonalizeClient.d.ts +5 -2
- package/dist-types/commands/CreateBatchInferenceJobCommand.d.ts +3 -1
- package/dist-types/commands/CreateBatchSegmentJobCommand.d.ts +2 -1
- package/dist-types/commands/CreateCampaignCommand.d.ts +5 -6
- package/dist-types/commands/CreateDatasetCommand.d.ts +8 -6
- package/dist-types/commands/CreateDatasetExportJobCommand.d.ts +1 -1
- package/dist-types/commands/CreateDatasetGroupCommand.d.ts +7 -7
- package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +3 -3
- package/dist-types/commands/CreateEventTrackerCommand.d.ts +4 -4
- package/dist-types/commands/CreateFilterCommand.d.ts +1 -1
- package/dist-types/commands/CreateRecommenderCommand.d.ts +5 -5
- package/dist-types/commands/CreateSchemaCommand.d.ts +4 -4
- package/dist-types/commands/CreateSolutionCommand.d.ts +10 -10
- package/dist-types/commands/CreateSolutionVersionCommand.d.ts +9 -10
- package/dist-types/commands/DeleteCampaignCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDatasetCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEventTrackerCommand.d.ts +1 -1
- package/dist-types/commands/DeleteSchemaCommand.d.ts +1 -1
- package/dist-types/commands/DeleteSolutionCommand.d.ts +2 -2
- package/dist-types/commands/DescribeCampaignCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDatasetCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDatasetExportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventTrackerCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRecipeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSchemaCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSolutionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSolutionVersionCommand.d.ts +2 -1
- package/dist-types/commands/ListCampaignsCommand.d.ts +1 -1
- package/dist-types/commands/ListDatasetExportJobsCommand.d.ts +2 -2
- package/dist-types/commands/ListDatasetGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +2 -2
- package/dist-types/commands/ListDatasetsCommand.d.ts +1 -1
- package/dist-types/commands/ListEventTrackersCommand.d.ts +1 -1
- package/dist-types/commands/ListSchemasCommand.d.ts +1 -1
- package/dist-types/commands/ListSolutionVersionsCommand.d.ts +1 -2
- package/dist-types/commands/ListSolutionsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +35 -0
- package/dist-types/commands/TagResourceCommand.d.ts +35 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +35 -0
- package/dist-types/commands/UpdateCampaignCommand.d.ts +2 -2
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +199 -34
- package/dist-types/protocols/Aws_json1_1.d.ts +9 -0
- package/dist-types/ts3.4/Personalize.d.ts +15 -0
- package/dist-types/ts3.4/PersonalizeClient.d.ts +5 -2
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +97 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +9 -0
- package/package.json +1 -1
|
@@ -51,7 +51,10 @@ import { ListRecommendersCommandInput, ListRecommendersCommandOutput } from "./c
|
|
|
51
51
|
import { ListSchemasCommandInput, ListSchemasCommandOutput } from "./commands/ListSchemasCommand";
|
|
52
52
|
import { ListSolutionsCommandInput, ListSolutionsCommandOutput } from "./commands/ListSolutionsCommand";
|
|
53
53
|
import { ListSolutionVersionsCommandInput, ListSolutionVersionsCommandOutput } from "./commands/ListSolutionVersionsCommand";
|
|
54
|
+
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
54
55
|
import { StopSolutionVersionCreationCommandInput, StopSolutionVersionCreationCommandOutput } from "./commands/StopSolutionVersionCreationCommand";
|
|
56
|
+
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
57
|
+
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
55
58
|
import { UpdateCampaignCommandInput, UpdateCampaignCommandOutput } from "./commands/UpdateCampaignCommand";
|
|
56
59
|
import { UpdateRecommenderCommandInput, UpdateRecommenderCommandOutput } from "./commands/UpdateRecommenderCommand";
|
|
57
60
|
import { PersonalizeClient } from "./PersonalizeClient";
|
|
@@ -62,14 +65,17 @@ import { PersonalizeClient } from "./PersonalizeClient";
|
|
|
62
65
|
export declare class Personalize extends PersonalizeClient {
|
|
63
66
|
/**
|
|
64
67
|
* <p>Creates a batch inference job. The operation can handle up to 50 million records and the
|
|
65
|
-
* input file must be in JSON format. For more information, see
|
|
68
|
+
* input file must be in JSON format. For more information, see
|
|
69
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/creating-batch-inference-job.html">Creating a batch inference job</a>.
|
|
70
|
+
* </p>
|
|
66
71
|
*/
|
|
67
72
|
createBatchInferenceJob(args: CreateBatchInferenceJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateBatchInferenceJobCommandOutput>;
|
|
68
73
|
createBatchInferenceJob(args: CreateBatchInferenceJobCommandInput, cb: (err: any, data?: CreateBatchInferenceJobCommandOutput) => void): void;
|
|
69
74
|
createBatchInferenceJob(args: CreateBatchInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBatchInferenceJobCommandOutput) => void): void;
|
|
70
75
|
/**
|
|
71
76
|
* <p>Creates a batch segment job. The operation can handle up to 50 million records and the
|
|
72
|
-
* input file must be in JSON format. For more information, see
|
|
77
|
+
* input file must be in JSON format. For more information, see
|
|
78
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/recommendations-batch.html">Getting batch recommendations and user segments</a>.</p>
|
|
73
79
|
*/
|
|
74
80
|
createBatchSegmentJob(args: CreateBatchSegmentJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateBatchSegmentJobCommandOutput>;
|
|
75
81
|
createBatchSegmentJob(args: CreateBatchSegmentJobCommandInput, cb: (err: any, data?: CreateBatchSegmentJobCommandOutput) => void): void;
|
|
@@ -115,34 +121,33 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
115
121
|
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
116
122
|
* </li>
|
|
117
123
|
* </ul>
|
|
118
|
-
* <p>To get the campaign status, call <a>DescribeCampaign</a>.</p>
|
|
124
|
+
* <p>To get the campaign status, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html">DescribeCampaign</a>.</p>
|
|
119
125
|
* <note>
|
|
120
126
|
* <p>Wait until the <code>status</code> of the campaign
|
|
121
127
|
* is <code>ACTIVE</code> before asking the campaign for recommendations.</p>
|
|
122
128
|
* </note>
|
|
123
|
-
*
|
|
124
129
|
* <p class="title">
|
|
125
130
|
* <b>Related APIs</b>
|
|
126
131
|
* </p>
|
|
127
132
|
* <ul>
|
|
128
133
|
* <li>
|
|
129
134
|
* <p>
|
|
130
|
-
* <a>ListCampaigns</a>
|
|
135
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html">ListCampaigns</a>
|
|
131
136
|
* </p>
|
|
132
137
|
* </li>
|
|
133
138
|
* <li>
|
|
134
139
|
* <p>
|
|
135
|
-
* <a>DescribeCampaign</a>
|
|
140
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html">DescribeCampaign</a>
|
|
136
141
|
* </p>
|
|
137
142
|
* </li>
|
|
138
143
|
* <li>
|
|
139
144
|
* <p>
|
|
140
|
-
* <a>UpdateCampaign</a>
|
|
145
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateCampaign.html">UpdateCampaign</a>
|
|
141
146
|
* </p>
|
|
142
147
|
* </li>
|
|
143
148
|
* <li>
|
|
144
149
|
* <p>
|
|
145
|
-
* <a>DeleteCampaign</a>
|
|
150
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteCampaign.html">DeleteCampaign</a>
|
|
146
151
|
* </p>
|
|
147
152
|
* </li>
|
|
148
153
|
* </ul>
|
|
@@ -151,7 +156,9 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
151
156
|
createCampaign(args: CreateCampaignCommandInput, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void;
|
|
152
157
|
createCampaign(args: CreateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void;
|
|
153
158
|
/**
|
|
154
|
-
* <p>Creates an empty dataset and adds it to the specified dataset group. Use
|
|
159
|
+
* <p>Creates an empty dataset and adds it to the specified dataset group. Use
|
|
160
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> to import your training data to a dataset.</p>
|
|
161
|
+
*
|
|
155
162
|
* <p>There are three types of datasets:</p>
|
|
156
163
|
* <ul>
|
|
157
164
|
* <li>
|
|
@@ -176,29 +183,29 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
176
183
|
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
177
184
|
* </li>
|
|
178
185
|
* </ul>
|
|
179
|
-
* <p>To get the status of the dataset, call <a>DescribeDataset</a>.</p>
|
|
186
|
+
* <p>To get the status of the dataset, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html">DescribeDataset</a>.</p>
|
|
180
187
|
* <p class="title">
|
|
181
188
|
* <b>Related APIs</b>
|
|
182
189
|
* </p>
|
|
183
190
|
* <ul>
|
|
184
191
|
* <li>
|
|
185
192
|
* <p>
|
|
186
|
-
* <a>CreateDatasetGroup</a>
|
|
193
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>
|
|
187
194
|
* </p>
|
|
188
195
|
* </li>
|
|
189
196
|
* <li>
|
|
190
197
|
* <p>
|
|
191
|
-
* <a>ListDatasets</a>
|
|
198
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasets.html">ListDatasets</a>
|
|
192
199
|
* </p>
|
|
193
200
|
* </li>
|
|
194
201
|
* <li>
|
|
195
202
|
* <p>
|
|
196
|
-
* <a>DescribeDataset</a>
|
|
203
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html">DescribeDataset</a>
|
|
197
204
|
* </p>
|
|
198
205
|
* </li>
|
|
199
206
|
* <li>
|
|
200
207
|
* <p>
|
|
201
|
-
* <a>DeleteDataset</a>
|
|
208
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDataset.html">DeleteDataset</a>
|
|
202
209
|
* </p>
|
|
203
210
|
* </li>
|
|
204
211
|
* </ul>
|
|
@@ -224,7 +231,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
224
231
|
* </li>
|
|
225
232
|
* </ul>
|
|
226
233
|
* <p>
|
|
227
|
-
* To get the status of the export job, call <a>DescribeDatasetExportJob</a>,
|
|
234
|
+
* To get the status of the export job, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html">DescribeDatasetExportJob</a>,
|
|
228
235
|
* and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is
|
|
229
236
|
* complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response
|
|
230
237
|
* includes a <code>failureReason</code> key, which describes why the job failed.
|
|
@@ -263,7 +270,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
263
270
|
* <p>DELETE PENDING</p>
|
|
264
271
|
* </li>
|
|
265
272
|
* </ul>
|
|
266
|
-
* <p>To get the status of the dataset group, call <a>DescribeDatasetGroup</a>. If
|
|
273
|
+
* <p>To get the status of the dataset group, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html">DescribeDatasetGroup</a>. If
|
|
267
274
|
* the status shows as CREATE FAILED, the response includes a <code>failureReason</code> key,
|
|
268
275
|
* which describes why the creation failed.</p>
|
|
269
276
|
* <note>
|
|
@@ -279,17 +286,17 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
279
286
|
* <ul>
|
|
280
287
|
* <li>
|
|
281
288
|
* <p>
|
|
282
|
-
* <a>CreateDataset</a>
|
|
289
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>
|
|
283
290
|
* </p>
|
|
284
291
|
* </li>
|
|
285
292
|
* <li>
|
|
286
293
|
* <p>
|
|
287
|
-
* <a>CreateEventTracker</a>
|
|
294
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>
|
|
288
295
|
* </p>
|
|
289
296
|
* </li>
|
|
290
297
|
* <li>
|
|
291
298
|
* <p>
|
|
292
|
-
* <a>CreateSolution</a>
|
|
299
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>
|
|
293
300
|
* </p>
|
|
294
301
|
* </li>
|
|
295
302
|
* </ul>
|
|
@@ -299,17 +306,17 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
299
306
|
* <ul>
|
|
300
307
|
* <li>
|
|
301
308
|
* <p>
|
|
302
|
-
* <a>ListDatasetGroups</a>
|
|
309
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetGroups.html">ListDatasetGroups</a>
|
|
303
310
|
* </p>
|
|
304
311
|
* </li>
|
|
305
312
|
* <li>
|
|
306
313
|
* <p>
|
|
307
|
-
* <a>DescribeDatasetGroup</a>
|
|
314
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html">DescribeDatasetGroup</a>
|
|
308
315
|
* </p>
|
|
309
316
|
* </li>
|
|
310
317
|
* <li>
|
|
311
318
|
* <p>
|
|
312
|
-
* <a>DeleteDatasetGroup</a>
|
|
319
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDatasetGroup.html">DeleteDatasetGroup</a>
|
|
313
320
|
* </p>
|
|
314
321
|
* </li>
|
|
315
322
|
* </ul>
|
|
@@ -336,7 +343,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
336
343
|
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
|
|
337
344
|
* </li>
|
|
338
345
|
* </ul>
|
|
339
|
-
* <p>To get the status of the import job, call <a>DescribeDatasetImportJob</a>,
|
|
346
|
+
* <p>To get the status of the import job, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html">DescribeDatasetImportJob</a>,
|
|
340
347
|
* providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is
|
|
341
348
|
* complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response
|
|
342
349
|
* includes a <code>failureReason</code> key, which describes why the job failed.</p>
|
|
@@ -351,12 +358,12 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
351
358
|
* <ul>
|
|
352
359
|
* <li>
|
|
353
360
|
* <p>
|
|
354
|
-
* <a>ListDatasetImportJobs</a>
|
|
361
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetImportJobs.html">ListDatasetImportJobs</a>
|
|
355
362
|
* </p>
|
|
356
363
|
* </li>
|
|
357
364
|
* <li>
|
|
358
365
|
* <p>
|
|
359
|
-
* <a>DescribeDatasetImportJob</a>
|
|
366
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html">DescribeDatasetImportJob</a>
|
|
360
367
|
* </p>
|
|
361
368
|
* </li>
|
|
362
369
|
* </ul>
|
|
@@ -387,7 +394,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
387
394
|
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
388
395
|
* </li>
|
|
389
396
|
* </ul>
|
|
390
|
-
* <p>To get the status of the event tracker, call <a>DescribeEventTracker</a>.</p>
|
|
397
|
+
* <p>To get the status of the event tracker, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html">DescribeEventTracker</a>.</p>
|
|
391
398
|
* <note>
|
|
392
399
|
* <p>The event tracker must be in the ACTIVE state before using the tracking ID.</p>
|
|
393
400
|
* </note>
|
|
@@ -397,17 +404,17 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
397
404
|
* <ul>
|
|
398
405
|
* <li>
|
|
399
406
|
* <p>
|
|
400
|
-
* <a>ListEventTrackers</a>
|
|
407
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListEventTrackers.html">ListEventTrackers</a>
|
|
401
408
|
* </p>
|
|
402
409
|
* </li>
|
|
403
410
|
* <li>
|
|
404
411
|
* <p>
|
|
405
|
-
* <a>DescribeEventTracker</a>
|
|
412
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html">DescribeEventTracker</a>
|
|
406
413
|
* </p>
|
|
407
414
|
* </li>
|
|
408
415
|
* <li>
|
|
409
416
|
* <p>
|
|
410
|
-
* <a>DeleteEventTracker</a>
|
|
417
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteEventTracker.html">DeleteEventTracker</a>
|
|
411
418
|
* </p>
|
|
412
419
|
* </li>
|
|
413
420
|
* </ul>
|
|
@@ -416,7 +423,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
416
423
|
createEventTracker(args: CreateEventTrackerCommandInput, cb: (err: any, data?: CreateEventTrackerCommandOutput) => void): void;
|
|
417
424
|
createEventTracker(args: CreateEventTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventTrackerCommandOutput) => void): void;
|
|
418
425
|
/**
|
|
419
|
-
* <p>Creates a recommendation filter. For more information, see <a>
|
|
426
|
+
* <p>Creates a recommendation filter. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering recommendations and user segments</a>.</p>
|
|
420
427
|
*/
|
|
421
428
|
createFilter(args: CreateFilterCommandInput, options?: __HttpHandlerOptions): Promise<CreateFilterCommandOutput>;
|
|
422
429
|
createFilter(args: CreateFilterCommandInput, cb: (err: any, data?: CreateFilterCommandOutput) => void): void;
|
|
@@ -465,7 +472,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
465
472
|
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
466
473
|
* </li>
|
|
467
474
|
* </ul>
|
|
468
|
-
* <p>To get the recommender status, call <a>DescribeRecommender</a>.</p>
|
|
475
|
+
* <p>To get the recommender status, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html">DescribeRecommender</a>.</p>
|
|
469
476
|
* <note>
|
|
470
477
|
* <p>Wait until the <code>status</code> of the recommender
|
|
471
478
|
* is <code>ACTIVE</code> before asking the recommender for recommendations.</p>
|
|
@@ -476,22 +483,22 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
476
483
|
* <ul>
|
|
477
484
|
* <li>
|
|
478
485
|
* <p>
|
|
479
|
-
* <a>ListRecommenders</a>
|
|
486
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListRecommenders.html">ListRecommenders</a>
|
|
480
487
|
* </p>
|
|
481
488
|
* </li>
|
|
482
489
|
* <li>
|
|
483
490
|
* <p>
|
|
484
|
-
* <a>DescribeRecommender</a>
|
|
491
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html">DescribeRecommender</a>
|
|
485
492
|
* </p>
|
|
486
493
|
* </li>
|
|
487
494
|
* <li>
|
|
488
495
|
* <p>
|
|
489
|
-
* <a>UpdateRecommender</a>
|
|
496
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateRecommender.html">UpdateRecommender</a>
|
|
490
497
|
* </p>
|
|
491
498
|
* </li>
|
|
492
499
|
* <li>
|
|
493
500
|
* <p>
|
|
494
|
-
* <a>DeleteRecommender</a>
|
|
501
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteRecommender.html">DeleteRecommender</a>
|
|
495
502
|
* </p>
|
|
496
503
|
* </li>
|
|
497
504
|
* </ul>
|
|
@@ -505,7 +512,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
505
512
|
* <p>Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset
|
|
506
513
|
* type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you
|
|
507
514
|
* provide the domain of the Domain dataset group.
|
|
508
|
-
*
|
|
515
|
+
* You specify a schema when you call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
509
516
|
*
|
|
510
517
|
* <p class="title">
|
|
511
518
|
* <b>Related APIs</b>
|
|
@@ -513,17 +520,17 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
513
520
|
* <ul>
|
|
514
521
|
* <li>
|
|
515
522
|
* <p>
|
|
516
|
-
* <a>ListSchemas</a>
|
|
523
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSchemas.html">ListSchemas</a>
|
|
517
524
|
* </p>
|
|
518
525
|
* </li>
|
|
519
526
|
* <li>
|
|
520
527
|
* <p>
|
|
521
|
-
* <a>DescribeSchema</a>
|
|
528
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html">DescribeSchema</a>
|
|
522
529
|
* </p>
|
|
523
530
|
* </li>
|
|
524
531
|
* <li>
|
|
525
532
|
* <p>
|
|
526
|
-
* <a>DeleteSchema</a>
|
|
533
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSchema.html">DeleteSchema</a>
|
|
527
534
|
* </p>
|
|
528
535
|
* </li>
|
|
529
536
|
* </ul>
|
|
@@ -534,11 +541,11 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
534
541
|
/**
|
|
535
542
|
* <p>Creates the configuration for training a model. A trained model is known as
|
|
536
543
|
* a solution. After the configuration is created, you train the model (create a solution)
|
|
537
|
-
* by calling the <a>CreateSolutionVersion</a> operation. Every time you call
|
|
544
|
+
* by calling the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html">CreateSolutionVersion</a> operation. Every time you call
|
|
538
545
|
* <code>CreateSolutionVersion</code>, a new version of the solution is created.</p>
|
|
539
546
|
* <p>After creating a solution version, you check its accuracy by calling
|
|
540
|
-
* <a>GetSolutionMetrics</a>. When you are satisfied with the version, you
|
|
541
|
-
* deploy it using <a>CreateCampaign</a>. The campaign provides recommendations
|
|
547
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html">GetSolutionMetrics</a>. When you are satisfied with the version, you
|
|
548
|
+
* deploy it using <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>. The campaign provides recommendations
|
|
542
549
|
* to a client through the
|
|
543
550
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a> API.</p>
|
|
544
551
|
* <p>To train a model, Amazon Personalize requires training data and a recipe. The training data
|
|
@@ -563,7 +570,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
563
570
|
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
564
571
|
* </li>
|
|
565
572
|
* </ul>
|
|
566
|
-
* <p>To get the status of the solution, call <a>DescribeSolution</a>. Wait
|
|
573
|
+
* <p>To get the status of the solution, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html">DescribeSolution</a>. Wait
|
|
567
574
|
* until the status shows as ACTIVE before calling <code>CreateSolutionVersion</code>.</p>
|
|
568
575
|
*
|
|
569
576
|
*
|
|
@@ -574,34 +581,34 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
574
581
|
* <ul>
|
|
575
582
|
* <li>
|
|
576
583
|
* <p>
|
|
577
|
-
* <a>ListSolutions</a>
|
|
584
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html">ListSolutions</a>
|
|
578
585
|
* </p>
|
|
579
586
|
* </li>
|
|
580
587
|
* <li>
|
|
581
588
|
* <p>
|
|
582
|
-
* <a>CreateSolutionVersion</a>
|
|
589
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html">CreateSolutionVersion</a>
|
|
583
590
|
* </p>
|
|
584
591
|
* </li>
|
|
585
592
|
* <li>
|
|
586
593
|
* <p>
|
|
587
|
-
* <a>DescribeSolution</a>
|
|
594
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html">DescribeSolution</a>
|
|
588
595
|
* </p>
|
|
589
596
|
* </li>
|
|
590
597
|
* <li>
|
|
591
598
|
* <p>
|
|
592
|
-
* <a>DeleteSolution</a>
|
|
599
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html">DeleteSolution</a>
|
|
593
600
|
* </p>
|
|
594
601
|
* </li>
|
|
595
602
|
* </ul>
|
|
596
603
|
* <ul>
|
|
597
604
|
* <li>
|
|
598
605
|
* <p>
|
|
599
|
-
* <a>ListSolutionVersions</a>
|
|
606
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html">ListSolutionVersions</a>
|
|
600
607
|
* </p>
|
|
601
608
|
* </li>
|
|
602
609
|
* <li>
|
|
603
610
|
* <p>
|
|
604
|
-
* <a>DescribeSolutionVersion</a>
|
|
611
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html">DescribeSolutionVersion</a>
|
|
605
612
|
* </p>
|
|
606
613
|
* </li>
|
|
607
614
|
* </ul>
|
|
@@ -610,7 +617,8 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
610
617
|
createSolution(args: CreateSolutionCommandInput, cb: (err: any, data?: CreateSolutionCommandOutput) => void): void;
|
|
611
618
|
createSolution(args: CreateSolutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSolutionCommandOutput) => void): void;
|
|
612
619
|
/**
|
|
613
|
-
* <p>Trains or retrains an active solution in a Custom dataset group. A solution is created using the <a>CreateSolution</a>
|
|
620
|
+
* <p>Trains or retrains an active solution in a Custom dataset group. A solution is created using the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>
|
|
621
|
+
* operation and must be in the ACTIVE state before calling
|
|
614
622
|
* <code>CreateSolutionVersion</code>. A new version of the solution is created every time you
|
|
615
623
|
* call this operation.</p>
|
|
616
624
|
* <p>
|
|
@@ -637,7 +645,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
637
645
|
* <p>CREATE STOPPED</p>
|
|
638
646
|
* </li>
|
|
639
647
|
* </ul>
|
|
640
|
-
* <p>To get the status of the version, call <a>DescribeSolutionVersion</a>. Wait
|
|
648
|
+
* <p>To get the status of the version, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html">DescribeSolutionVersion</a>. Wait
|
|
641
649
|
* until the status shows as ACTIVE before calling <code>CreateCampaign</code>.</p>
|
|
642
650
|
* <p>If the status shows as CREATE FAILED, the response includes a <code>failureReason</code>
|
|
643
651
|
* key, which describes why the job failed.</p>
|
|
@@ -647,34 +655,32 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
647
655
|
* <ul>
|
|
648
656
|
* <li>
|
|
649
657
|
* <p>
|
|
650
|
-
* <a>ListSolutionVersions</a>
|
|
658
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html">ListSolutionVersions</a>
|
|
651
659
|
* </p>
|
|
652
660
|
* </li>
|
|
653
661
|
* <li>
|
|
654
662
|
* <p>
|
|
655
|
-
* <a>DescribeSolutionVersion</a>
|
|
663
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html">DescribeSolutionVersion</a>
|
|
656
664
|
* </p>
|
|
657
665
|
* </li>
|
|
658
|
-
* </ul>
|
|
659
|
-
* <ul>
|
|
660
666
|
* <li>
|
|
661
667
|
* <p>
|
|
662
|
-
* <a>ListSolutions</a>
|
|
668
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html">ListSolutions</a>
|
|
663
669
|
* </p>
|
|
664
670
|
* </li>
|
|
665
671
|
* <li>
|
|
666
672
|
* <p>
|
|
667
|
-
* <a>CreateSolution</a>
|
|
673
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>
|
|
668
674
|
* </p>
|
|
669
675
|
* </li>
|
|
670
676
|
* <li>
|
|
671
677
|
* <p>
|
|
672
|
-
* <a>DescribeSolution</a>
|
|
678
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html">DescribeSolution</a>
|
|
673
679
|
* </p>
|
|
674
680
|
* </li>
|
|
675
681
|
* <li>
|
|
676
682
|
* <p>
|
|
677
|
-
* <a>DeleteSolution</a>
|
|
683
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html">DeleteSolution</a>
|
|
678
684
|
* </p>
|
|
679
685
|
* </li>
|
|
680
686
|
* </ul>
|
|
@@ -688,7 +694,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
688
694
|
* longer be specified in a
|
|
689
695
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
|
|
690
696
|
* request.
|
|
691
|
-
* For
|
|
697
|
+
* For information on creating campaigns, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>.</p>
|
|
692
698
|
*/
|
|
693
699
|
deleteCampaign(args: DeleteCampaignCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCampaignCommandOutput>;
|
|
694
700
|
deleteCampaign(args: DeleteCampaignCommandInput, cb: (err: any, data?: DeleteCampaignCommandOutput) => void): void;
|
|
@@ -696,7 +702,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
696
702
|
/**
|
|
697
703
|
* <p>Deletes a dataset. You can't delete a dataset if an associated
|
|
698
704
|
* <code>DatasetImportJob</code> or <code>SolutionVersion</code> is in the CREATE PENDING or IN
|
|
699
|
-
* PROGRESS state. For more information on datasets, see <a>CreateDataset</a>.</p>
|
|
705
|
+
* PROGRESS state. For more information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
700
706
|
*/
|
|
701
707
|
deleteDataset(args: DeleteDatasetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatasetCommandOutput>;
|
|
702
708
|
deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
|
|
@@ -722,7 +728,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
722
728
|
/**
|
|
723
729
|
* <p>Deletes the event tracker. Does not delete the event-interactions dataset from
|
|
724
730
|
* the associated dataset group. For more
|
|
725
|
-
* information on event trackers, see <a>CreateEventTracker</a>.</p>
|
|
731
|
+
* information on event trackers, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>.</p>
|
|
726
732
|
*/
|
|
727
733
|
deleteEventTracker(args: DeleteEventTrackerCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEventTrackerCommandOutput>;
|
|
728
734
|
deleteEventTracker(args: DeleteEventTrackerCommandInput, cb: (err: any, data?: DeleteEventTrackerCommandOutput) => void): void;
|
|
@@ -743,7 +749,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
743
749
|
/**
|
|
744
750
|
* <p>Deletes a schema. Before deleting a schema, you must delete all
|
|
745
751
|
* datasets referencing the schema. For more information on schemas, see
|
|
746
|
-
* <a>CreateSchema</a>.</p>
|
|
752
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html">CreateSchema</a>.</p>
|
|
747
753
|
*/
|
|
748
754
|
deleteSchema(args: DeleteSchemaCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSchemaCommandOutput>;
|
|
749
755
|
deleteSchema(args: DeleteSchemaCommandInput, cb: (err: any, data?: DeleteSchemaCommandOutput) => void): void;
|
|
@@ -752,10 +758,10 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
752
758
|
* <p>Deletes all versions of a solution and the <code>Solution</code> object itself.
|
|
753
759
|
* Before deleting a solution, you must delete all campaigns based on
|
|
754
760
|
* the solution. To determine what campaigns are using the solution, call
|
|
755
|
-
* <a>ListCampaigns</a> and supply the Amazon Resource Name (ARN) of the solution.
|
|
761
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html">ListCampaigns</a> and supply the Amazon Resource Name (ARN) of the solution.
|
|
756
762
|
* You can't delete a solution if an associated <code>SolutionVersion</code> is in the
|
|
757
763
|
* CREATE PENDING or IN PROGRESS state.
|
|
758
|
-
* For more information on solutions, see <a>CreateSolution</a>.</p>
|
|
764
|
+
* For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>.</p>
|
|
759
765
|
*/
|
|
760
766
|
deleteSolution(args: DeleteSolutionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSolutionCommandOutput>;
|
|
761
767
|
deleteSolution(args: DeleteSolutionCommandInput, cb: (err: any, data?: DeleteSolutionCommandOutput) => void): void;
|
|
@@ -795,32 +801,32 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
795
801
|
* </ul>
|
|
796
802
|
* <p>When the <code>status</code> is <code>CREATE FAILED</code>, the response includes the
|
|
797
803
|
* <code>failureReason</code> key, which describes why.</p>
|
|
798
|
-
* <p>For more information on campaigns, see <a>CreateCampaign</a>.</p>
|
|
804
|
+
* <p>For more information on campaigns, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>.</p>
|
|
799
805
|
*/
|
|
800
806
|
describeCampaign(args: DescribeCampaignCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCampaignCommandOutput>;
|
|
801
807
|
describeCampaign(args: DescribeCampaignCommandInput, cb: (err: any, data?: DescribeCampaignCommandOutput) => void): void;
|
|
802
808
|
describeCampaign(args: DescribeCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCampaignCommandOutput) => void): void;
|
|
803
809
|
/**
|
|
804
|
-
* <p>Describes the given dataset. For more information on datasets, see <a>CreateDataset</a>.</p>
|
|
810
|
+
* <p>Describes the given dataset. For more information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
805
811
|
*/
|
|
806
812
|
describeDataset(args: DescribeDatasetCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetCommandOutput>;
|
|
807
813
|
describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
|
|
808
814
|
describeDataset(args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
|
|
809
815
|
/**
|
|
810
|
-
* <p>Describes the dataset export job created by <a>CreateDatasetExportJob</a>,
|
|
816
|
+
* <p>Describes the dataset export job created by <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html">CreateDatasetExportJob</a>,
|
|
811
817
|
* including the export job status.</p>
|
|
812
818
|
*/
|
|
813
819
|
describeDatasetExportJob(args: DescribeDatasetExportJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetExportJobCommandOutput>;
|
|
814
820
|
describeDatasetExportJob(args: DescribeDatasetExportJobCommandInput, cb: (err: any, data?: DescribeDatasetExportJobCommandOutput) => void): void;
|
|
815
821
|
describeDatasetExportJob(args: DescribeDatasetExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetExportJobCommandOutput) => void): void;
|
|
816
822
|
/**
|
|
817
|
-
* <p>Describes the given dataset group. For more information on dataset groups, see <a>CreateDatasetGroup</a>.</p>
|
|
823
|
+
* <p>Describes the given dataset group. For more information on dataset groups, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>.</p>
|
|
818
824
|
*/
|
|
819
825
|
describeDatasetGroup(args: DescribeDatasetGroupCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetGroupCommandOutput>;
|
|
820
826
|
describeDatasetGroup(args: DescribeDatasetGroupCommandInput, cb: (err: any, data?: DescribeDatasetGroupCommandOutput) => void): void;
|
|
821
827
|
describeDatasetGroup(args: DescribeDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetGroupCommandOutput) => void): void;
|
|
822
828
|
/**
|
|
823
|
-
* <p>Describes the dataset import job created by <a>CreateDatasetImportJob</a>,
|
|
829
|
+
* <p>Describes the dataset import job created by <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>,
|
|
824
830
|
* including the import job status.</p>
|
|
825
831
|
*/
|
|
826
832
|
describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetImportJobCommandOutput>;
|
|
@@ -829,7 +835,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
829
835
|
/**
|
|
830
836
|
* <p>Describes an event tracker. The response includes the <code>trackingId</code> and
|
|
831
837
|
* <code>status</code> of the event tracker.
|
|
832
|
-
* For more information on event trackers, see <a>CreateEventTracker</a>.</p>
|
|
838
|
+
* For more information on event trackers, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>.</p>
|
|
833
839
|
*/
|
|
834
840
|
describeEventTracker(args: DescribeEventTrackerCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventTrackerCommandOutput>;
|
|
835
841
|
describeEventTracker(args: DescribeEventTrackerCommandInput, cb: (err: any, data?: DescribeEventTrackerCommandOutput) => void): void;
|
|
@@ -861,7 +867,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
861
867
|
* </li>
|
|
862
868
|
* </ul>
|
|
863
869
|
* <p>Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a
|
|
864
|
-
* solution with the <a>CreateSolution</a> API.
|
|
870
|
+
* solution with the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a> API.
|
|
865
871
|
* <code>CreateSolution</code> trains a model by using the algorithm
|
|
866
872
|
* in the specified recipe and a training dataset. The solution, when deployed as a campaign,
|
|
867
873
|
* can provide recommendations using the
|
|
@@ -890,20 +896,21 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
890
896
|
describeRecommender(args: DescribeRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecommenderCommandOutput) => void): void;
|
|
891
897
|
/**
|
|
892
898
|
* <p>Describes a schema. For more information on schemas, see
|
|
893
|
-
* <a>CreateSchema</a>.</p>
|
|
899
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html">CreateSchema</a>.</p>
|
|
894
900
|
*/
|
|
895
901
|
describeSchema(args: DescribeSchemaCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSchemaCommandOutput>;
|
|
896
902
|
describeSchema(args: DescribeSchemaCommandInput, cb: (err: any, data?: DescribeSchemaCommandOutput) => void): void;
|
|
897
903
|
describeSchema(args: DescribeSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSchemaCommandOutput) => void): void;
|
|
898
904
|
/**
|
|
899
905
|
* <p>Describes a solution.
|
|
900
|
-
* For more information on solutions, see <a>CreateSolution</a>.</p>
|
|
906
|
+
* For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>.</p>
|
|
901
907
|
*/
|
|
902
908
|
describeSolution(args: DescribeSolutionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSolutionCommandOutput>;
|
|
903
909
|
describeSolution(args: DescribeSolutionCommandInput, cb: (err: any, data?: DescribeSolutionCommandOutput) => void): void;
|
|
904
910
|
describeSolution(args: DescribeSolutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSolutionCommandOutput) => void): void;
|
|
905
911
|
/**
|
|
906
|
-
* <p>Describes a specific version of a solution. For more information on solutions, see <a>CreateSolution</a
|
|
912
|
+
* <p>Describes a specific version of a solution. For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>
|
|
913
|
+
* </p>
|
|
907
914
|
*/
|
|
908
915
|
describeSolutionVersion(args: DescribeSolutionVersionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSolutionVersionCommandOutput>;
|
|
909
916
|
describeSolutionVersion(args: DescribeSolutionVersionCommandInput, cb: (err: any, data?: DescribeSolutionVersionCommandOutput) => void): void;
|
|
@@ -932,7 +939,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
932
939
|
* <p>Returns a list of campaigns that use the given solution.
|
|
933
940
|
* When a solution is not specified, all the campaigns associated with the account are listed.
|
|
934
941
|
* The response provides the properties for each campaign, including the Amazon Resource Name (ARN).
|
|
935
|
-
* For more information on campaigns, see <a>CreateCampaign</a>.</p>
|
|
942
|
+
* For more information on campaigns, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>.</p>
|
|
936
943
|
*/
|
|
937
944
|
listCampaigns(args: ListCampaignsCommandInput, options?: __HttpHandlerOptions): Promise<ListCampaignsCommandOutput>;
|
|
938
945
|
listCampaigns(args: ListCampaignsCommandInput, cb: (err: any, data?: ListCampaignsCommandOutput) => void): void;
|
|
@@ -941,8 +948,8 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
941
948
|
* <p>Returns a list of dataset export jobs that use the given dataset. When a dataset is not
|
|
942
949
|
* specified, all the dataset export jobs associated with the account are listed. The response
|
|
943
950
|
* provides the properties for each dataset export job, including the Amazon Resource Name (ARN).
|
|
944
|
-
* For more information on dataset export jobs, see <a>CreateDatasetExportJob</a>. For
|
|
945
|
-
* more information on datasets, see <a>CreateDataset</a>.</p>
|
|
951
|
+
* For more information on dataset export jobs, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html">CreateDatasetExportJob</a>. For
|
|
952
|
+
* more information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
946
953
|
*/
|
|
947
954
|
listDatasetExportJobs(args: ListDatasetExportJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetExportJobsCommandOutput>;
|
|
948
955
|
listDatasetExportJobs(args: ListDatasetExportJobsCommandInput, cb: (err: any, data?: ListDatasetExportJobsCommandOutput) => void): void;
|
|
@@ -950,7 +957,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
950
957
|
/**
|
|
951
958
|
* <p>Returns a list of dataset groups. The response provides the properties for each dataset
|
|
952
959
|
* group, including the Amazon Resource Name (ARN). For more information on dataset groups, see
|
|
953
|
-
*
|
|
960
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>.</p>
|
|
954
961
|
*/
|
|
955
962
|
listDatasetGroups(args: ListDatasetGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetGroupsCommandOutput>;
|
|
956
963
|
listDatasetGroups(args: ListDatasetGroupsCommandInput, cb: (err: any, data?: ListDatasetGroupsCommandOutput) => void): void;
|
|
@@ -959,8 +966,8 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
959
966
|
* <p>Returns a list of dataset import jobs that use the given dataset. When a dataset is not
|
|
960
967
|
* specified, all the dataset import jobs associated with the account are listed. The response
|
|
961
968
|
* provides the properties for each dataset import job, including the Amazon Resource Name (ARN).
|
|
962
|
-
* For more information on dataset import jobs, see <a>CreateDatasetImportJob</a>. For
|
|
963
|
-
* more information on datasets, see <a>CreateDataset</a>.</p>
|
|
969
|
+
* For more information on dataset import jobs, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>. For
|
|
970
|
+
* more information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
964
971
|
*/
|
|
965
972
|
listDatasetImportJobs(args: ListDatasetImportJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetImportJobsCommandOutput>;
|
|
966
973
|
listDatasetImportJobs(args: ListDatasetImportJobsCommandInput, cb: (err: any, data?: ListDatasetImportJobsCommandOutput) => void): void;
|
|
@@ -968,7 +975,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
968
975
|
/**
|
|
969
976
|
* <p>Returns the list of datasets contained in the given dataset group. The response provides
|
|
970
977
|
* the properties for each dataset, including the Amazon Resource Name (ARN). For more
|
|
971
|
-
* information on datasets, see <a>CreateDataset</a>.</p>
|
|
978
|
+
* information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
972
979
|
*/
|
|
973
980
|
listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetsCommandOutput>;
|
|
974
981
|
listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
|
|
@@ -977,7 +984,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
977
984
|
* <p>Returns the list of event trackers associated with the account.
|
|
978
985
|
* The response provides the properties for each event tracker, including the Amazon Resource
|
|
979
986
|
* Name (ARN) and tracking ID. For more
|
|
980
|
-
* information on event trackers, see <a>CreateEventTracker</a>.</p>
|
|
987
|
+
* information on event trackers, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>.</p>
|
|
981
988
|
*/
|
|
982
989
|
listEventTrackers(args: ListEventTrackersCommandInput, options?: __HttpHandlerOptions): Promise<ListEventTrackersCommandOutput>;
|
|
983
990
|
listEventTrackers(args: ListEventTrackersCommandInput, cb: (err: any, data?: ListEventTrackersCommandOutput) => void): void;
|
|
@@ -1007,7 +1014,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
1007
1014
|
/**
|
|
1008
1015
|
* <p>Returns the list of schemas associated with the account. The response provides the
|
|
1009
1016
|
* properties for each schema, including the Amazon Resource Name (ARN).
|
|
1010
|
-
* For more information on schemas, see <a>CreateSchema</a>.</p>
|
|
1017
|
+
* For more information on schemas, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html">CreateSchema</a>.</p>
|
|
1011
1018
|
*/
|
|
1012
1019
|
listSchemas(args: ListSchemasCommandInput, options?: __HttpHandlerOptions): Promise<ListSchemasCommandOutput>;
|
|
1013
1020
|
listSchemas(args: ListSchemasCommandInput, cb: (err: any, data?: ListSchemasCommandOutput) => void): void;
|
|
@@ -1016,7 +1023,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
1016
1023
|
* <p>Returns a list of solutions that use the given dataset group.
|
|
1017
1024
|
* When a dataset group is not specified, all the solutions associated with the account are listed.
|
|
1018
1025
|
* The response provides the properties for each solution, including the Amazon Resource Name (ARN).
|
|
1019
|
-
* For more information on solutions, see <a>CreateSolution</a>.</p>
|
|
1026
|
+
* For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>.</p>
|
|
1020
1027
|
*/
|
|
1021
1028
|
listSolutions(args: ListSolutionsCommandInput, options?: __HttpHandlerOptions): Promise<ListSolutionsCommandOutput>;
|
|
1022
1029
|
listSolutions(args: ListSolutionsCommandInput, cb: (err: any, data?: ListSolutionsCommandOutput) => void): void;
|
|
@@ -1024,12 +1031,17 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
1024
1031
|
/**
|
|
1025
1032
|
* <p>Returns a list of solution versions for the given solution. When a solution is not
|
|
1026
1033
|
* specified, all the solution versions associated with the account are listed. The response
|
|
1027
|
-
* provides the properties for each solution version, including the Amazon Resource Name (ARN)
|
|
1028
|
-
* For more information on solutions, see <a>CreateSolution</a>.</p>
|
|
1034
|
+
* provides the properties for each solution version, including the Amazon Resource Name (ARN).</p>
|
|
1029
1035
|
*/
|
|
1030
1036
|
listSolutionVersions(args: ListSolutionVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListSolutionVersionsCommandOutput>;
|
|
1031
1037
|
listSolutionVersions(args: ListSolutionVersionsCommandInput, cb: (err: any, data?: ListSolutionVersionsCommandOutput) => void): void;
|
|
1032
1038
|
listSolutionVersions(args: ListSolutionVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSolutionVersionsCommandOutput) => void): void;
|
|
1039
|
+
/**
|
|
1040
|
+
* <p>Get a list of <a href="https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html">tags</a> attached to a resource.</p>
|
|
1041
|
+
*/
|
|
1042
|
+
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
1043
|
+
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
1044
|
+
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
1033
1045
|
/**
|
|
1034
1046
|
* <p>Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
|
|
1035
1047
|
* </p>
|
|
@@ -1049,16 +1061,28 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
1049
1061
|
stopSolutionVersionCreation(args: StopSolutionVersionCreationCommandInput, options?: __HttpHandlerOptions): Promise<StopSolutionVersionCreationCommandOutput>;
|
|
1050
1062
|
stopSolutionVersionCreation(args: StopSolutionVersionCreationCommandInput, cb: (err: any, data?: StopSolutionVersionCreationCommandOutput) => void): void;
|
|
1051
1063
|
stopSolutionVersionCreation(args: StopSolutionVersionCreationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopSolutionVersionCreationCommandOutput) => void): void;
|
|
1064
|
+
/**
|
|
1065
|
+
* <p>Add a list of tags to a resource.</p>
|
|
1066
|
+
*/
|
|
1067
|
+
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
1068
|
+
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1069
|
+
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1070
|
+
/**
|
|
1071
|
+
* <p>Remove <a href="https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html">tags</a> that are attached to a resource.</p>
|
|
1072
|
+
*/
|
|
1073
|
+
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
1074
|
+
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1075
|
+
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1052
1076
|
/**
|
|
1053
1077
|
* <p>Updates a campaign by either deploying a new solution or changing the value of the
|
|
1054
1078
|
* campaign's <code>minProvisionedTPS</code> parameter.</p>
|
|
1055
1079
|
* <p>To update a campaign, the campaign status must be ACTIVE or CREATE FAILED.
|
|
1056
|
-
* Check the campaign status using the <a>DescribeCampaign</a>
|
|
1080
|
+
* Check the campaign status using the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html">DescribeCampaign</a> operation.</p>
|
|
1057
1081
|
* <note>
|
|
1058
1082
|
* <p>You must wait until the <code>status</code> of the
|
|
1059
1083
|
* updated campaign is <code>ACTIVE</code> before asking the campaign for recommendations.</p>
|
|
1060
1084
|
* </note>
|
|
1061
|
-
* <p>For more information on campaigns, see <a>CreateCampaign</a>.</p>
|
|
1085
|
+
* <p>For more information on campaigns, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>.</p>
|
|
1062
1086
|
*/
|
|
1063
1087
|
updateCampaign(args: UpdateCampaignCommandInput, options?: __HttpHandlerOptions): Promise<UpdateCampaignCommandOutput>;
|
|
1064
1088
|
updateCampaign(args: UpdateCampaignCommandInput, cb: (err: any, data?: UpdateCampaignCommandOutput) => void): void;
|