@aws-sdk/client-personalize 3.315.0 → 3.316.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/Personalize.js +70 -924
- package/dist-es/Personalize.js +70 -924
- package/dist-types/Personalize.d.ts +74 -844
- package/dist-types/ts3.4/Personalize.d.ts +4 -1
- package/package.json +6 -6
|
@@ -66,1178 +66,408 @@ import { UpdateCampaignCommandInput, UpdateCampaignCommandOutput } from "./comma
|
|
|
66
66
|
import { UpdateMetricAttributionCommandInput, UpdateMetricAttributionCommandOutput } from "./commands/UpdateMetricAttributionCommand";
|
|
67
67
|
import { UpdateRecommenderCommandInput, UpdateRecommenderCommandOutput } from "./commands/UpdateRecommenderCommand";
|
|
68
68
|
import { PersonalizeClient } from "./PersonalizeClient";
|
|
69
|
-
|
|
70
|
-
* @public
|
|
71
|
-
* <p>Amazon Personalize is a machine learning service that makes it easy to add individualized
|
|
72
|
-
* recommendations to customers.</p>
|
|
73
|
-
*/
|
|
74
|
-
export declare class Personalize extends PersonalizeClient {
|
|
69
|
+
export interface Personalize {
|
|
75
70
|
/**
|
|
76
|
-
* @
|
|
77
|
-
* <p>Creates a batch inference job. The operation can handle up to 50 million records and the
|
|
78
|
-
* input file must be in JSON format. For more information, see
|
|
79
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/creating-batch-inference-job.html">Creating a batch inference job</a>.
|
|
80
|
-
* </p>
|
|
71
|
+
* @see {@link CreateBatchInferenceJobCommand}
|
|
81
72
|
*/
|
|
82
73
|
createBatchInferenceJob(args: CreateBatchInferenceJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateBatchInferenceJobCommandOutput>;
|
|
83
74
|
createBatchInferenceJob(args: CreateBatchInferenceJobCommandInput, cb: (err: any, data?: CreateBatchInferenceJobCommandOutput) => void): void;
|
|
84
75
|
createBatchInferenceJob(args: CreateBatchInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBatchInferenceJobCommandOutput) => void): void;
|
|
85
76
|
/**
|
|
86
|
-
* @
|
|
87
|
-
* <p>Creates a batch segment job. The operation can handle up to 50 million records and the
|
|
88
|
-
* input file must be in JSON format. For more information, see
|
|
89
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/recommendations-batch.html">Getting batch recommendations and user segments</a>.</p>
|
|
77
|
+
* @see {@link CreateBatchSegmentJobCommand}
|
|
90
78
|
*/
|
|
91
79
|
createBatchSegmentJob(args: CreateBatchSegmentJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateBatchSegmentJobCommandOutput>;
|
|
92
80
|
createBatchSegmentJob(args: CreateBatchSegmentJobCommandInput, cb: (err: any, data?: CreateBatchSegmentJobCommandOutput) => void): void;
|
|
93
81
|
createBatchSegmentJob(args: CreateBatchSegmentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBatchSegmentJobCommandOutput) => void): void;
|
|
94
82
|
/**
|
|
95
|
-
* @
|
|
96
|
-
* <p>Creates a campaign that deploys a solution version. When a client calls the
|
|
97
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
|
|
98
|
-
* and
|
|
99
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html">GetPersonalizedRanking</a>
|
|
100
|
-
* APIs, a campaign is specified in the request.</p>
|
|
101
|
-
*
|
|
102
|
-
* <p>
|
|
103
|
-
* <b>Minimum Provisioned TPS and Auto-Scaling</b>
|
|
104
|
-
* </p>
|
|
105
|
-
*
|
|
106
|
-
* <p>A transaction is a single <code>GetRecommendations</code> or
|
|
107
|
-
* <code>GetPersonalizedRanking</code> call. Transactions per second (TPS) is the throughput
|
|
108
|
-
* and unit of billing for Amazon Personalize. The minimum provisioned TPS
|
|
109
|
-
* (<code>minProvisionedTPS</code>) specifies the baseline throughput provisioned by
|
|
110
|
-
* Amazon Personalize, and thus, the minimum billing charge.
|
|
111
|
-
* </p>
|
|
112
|
-
* <p>
|
|
113
|
-
* If your TPS increases beyond
|
|
114
|
-
* <code>minProvisionedTPS</code>, Amazon Personalize auto-scales the provisioned capacity up and down,
|
|
115
|
-
* but never below <code>minProvisionedTPS</code>.
|
|
116
|
-
* There's a short time delay while the capacity is increased that might cause loss of
|
|
117
|
-
* transactions.</p>
|
|
118
|
-
* <p>The actual TPS used is calculated as the average requests/second within a 5-minute window.
|
|
119
|
-
* You pay for maximum of either the minimum provisioned TPS or the actual TPS.
|
|
120
|
-
* We recommend starting with a low <code>minProvisionedTPS</code>, track
|
|
121
|
-
* your usage using Amazon CloudWatch metrics, and then increase the <code>minProvisionedTPS</code>
|
|
122
|
-
* as necessary.</p>
|
|
123
|
-
*
|
|
124
|
-
* <p>
|
|
125
|
-
* <b>Status</b>
|
|
126
|
-
* </p>
|
|
127
|
-
* <p>A campaign can be in one of the following states:</p>
|
|
128
|
-
* <ul>
|
|
129
|
-
* <li>
|
|
130
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
|
|
131
|
-
* </li>
|
|
132
|
-
* <li>
|
|
133
|
-
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
134
|
-
* </li>
|
|
135
|
-
* </ul>
|
|
136
|
-
* <p>To get the campaign status, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html">DescribeCampaign</a>.</p>
|
|
137
|
-
* <note>
|
|
138
|
-
* <p>Wait until the <code>status</code> of the campaign
|
|
139
|
-
* is <code>ACTIVE</code> before asking the campaign for recommendations.</p>
|
|
140
|
-
* </note>
|
|
141
|
-
* <p class="title">
|
|
142
|
-
* <b>Related APIs</b>
|
|
143
|
-
* </p>
|
|
144
|
-
* <ul>
|
|
145
|
-
* <li>
|
|
146
|
-
* <p>
|
|
147
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html">ListCampaigns</a>
|
|
148
|
-
* </p>
|
|
149
|
-
* </li>
|
|
150
|
-
* <li>
|
|
151
|
-
* <p>
|
|
152
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html">DescribeCampaign</a>
|
|
153
|
-
* </p>
|
|
154
|
-
* </li>
|
|
155
|
-
* <li>
|
|
156
|
-
* <p>
|
|
157
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateCampaign.html">UpdateCampaign</a>
|
|
158
|
-
* </p>
|
|
159
|
-
* </li>
|
|
160
|
-
* <li>
|
|
161
|
-
* <p>
|
|
162
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteCampaign.html">DeleteCampaign</a>
|
|
163
|
-
* </p>
|
|
164
|
-
* </li>
|
|
165
|
-
* </ul>
|
|
83
|
+
* @see {@link CreateCampaignCommand}
|
|
166
84
|
*/
|
|
167
85
|
createCampaign(args: CreateCampaignCommandInput, options?: __HttpHandlerOptions): Promise<CreateCampaignCommandOutput>;
|
|
168
86
|
createCampaign(args: CreateCampaignCommandInput, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void;
|
|
169
87
|
createCampaign(args: CreateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void;
|
|
170
88
|
/**
|
|
171
|
-
* @
|
|
172
|
-
* <p>Creates an empty dataset and adds it to the specified dataset group.
|
|
173
|
-
* Use <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> to import your training data to a
|
|
174
|
-
* dataset.</p>
|
|
175
|
-
*
|
|
176
|
-
* <p>There are three types of datasets:</p>
|
|
177
|
-
* <ul>
|
|
178
|
-
* <li>
|
|
179
|
-
* <p>Interactions</p>
|
|
180
|
-
* </li>
|
|
181
|
-
* <li>
|
|
182
|
-
* <p>Items</p>
|
|
183
|
-
* </li>
|
|
184
|
-
* <li>
|
|
185
|
-
* <p>Users</p>
|
|
186
|
-
* </li>
|
|
187
|
-
* </ul>
|
|
188
|
-
* <p>Each dataset type has an associated schema with required field types.
|
|
189
|
-
* Only the <code>Interactions</code> dataset is required in order to train a
|
|
190
|
-
* model (also referred to as creating a solution).</p>
|
|
191
|
-
* <p>A dataset can be in one of the following states:</p>
|
|
192
|
-
* <ul>
|
|
193
|
-
* <li>
|
|
194
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
195
|
-
* FAILED</p>
|
|
196
|
-
* </li>
|
|
197
|
-
* <li>
|
|
198
|
-
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
199
|
-
* </li>
|
|
200
|
-
* </ul>
|
|
201
|
-
* <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>
|
|
202
|
-
* <p class="title">
|
|
203
|
-
* <b>Related APIs</b>
|
|
204
|
-
* </p>
|
|
205
|
-
* <ul>
|
|
206
|
-
* <li>
|
|
207
|
-
* <p>
|
|
208
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>
|
|
209
|
-
* </p>
|
|
210
|
-
* </li>
|
|
211
|
-
* <li>
|
|
212
|
-
* <p>
|
|
213
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasets.html">ListDatasets</a>
|
|
214
|
-
* </p>
|
|
215
|
-
* </li>
|
|
216
|
-
* <li>
|
|
217
|
-
* <p>
|
|
218
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html">DescribeDataset</a>
|
|
219
|
-
* </p>
|
|
220
|
-
* </li>
|
|
221
|
-
* <li>
|
|
222
|
-
* <p>
|
|
223
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDataset.html">DeleteDataset</a>
|
|
224
|
-
* </p>
|
|
225
|
-
* </li>
|
|
226
|
-
* </ul>
|
|
89
|
+
* @see {@link CreateDatasetCommand}
|
|
227
90
|
*/
|
|
228
91
|
createDataset(args: CreateDatasetCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetCommandOutput>;
|
|
229
92
|
createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
|
|
230
93
|
createDataset(args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
|
|
231
94
|
/**
|
|
232
|
-
* @
|
|
233
|
-
* <p> Creates a job that exports data from your dataset to an Amazon S3 bucket.
|
|
234
|
-
* To allow Amazon Personalize to export the training data, you must specify an
|
|
235
|
-
* service-linked IAM role that gives Amazon Personalize <code>PutObject</code>
|
|
236
|
-
* permissions for your Amazon S3 bucket. For information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/export-data.html">Exporting a dataset</a> in the Amazon Personalize developer guide. </p>
|
|
237
|
-
* <p>
|
|
238
|
-
* <b>Status</b>
|
|
239
|
-
* </p>
|
|
240
|
-
* <p>A dataset export job can be in one of the following states:</p>
|
|
241
|
-
* <ul>
|
|
242
|
-
* <li>
|
|
243
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
244
|
-
* FAILED</p>
|
|
245
|
-
* </li>
|
|
246
|
-
* </ul>
|
|
247
|
-
* <p> To get the status of the export job, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html">DescribeDatasetExportJob</a>, and specify the Amazon Resource Name
|
|
248
|
-
* (ARN) of the dataset export job. The dataset export is complete when the
|
|
249
|
-
* status shows as ACTIVE. If the status shows as CREATE FAILED, the response
|
|
250
|
-
* includes a <code>failureReason</code> key, which describes why the job
|
|
251
|
-
* failed. </p>
|
|
95
|
+
* @see {@link CreateDatasetExportJobCommand}
|
|
252
96
|
*/
|
|
253
97
|
createDatasetExportJob(args: CreateDatasetExportJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetExportJobCommandOutput>;
|
|
254
98
|
createDatasetExportJob(args: CreateDatasetExportJobCommandInput, cb: (err: any, data?: CreateDatasetExportJobCommandOutput) => void): void;
|
|
255
99
|
createDatasetExportJob(args: CreateDatasetExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetExportJobCommandOutput) => void): void;
|
|
256
100
|
/**
|
|
257
|
-
* @
|
|
258
|
-
* <p>Creates an empty dataset group. A dataset group is a container for
|
|
259
|
-
* Amazon Personalize resources. A dataset group can contain at most three datasets, one
|
|
260
|
-
* for each type of dataset:</p>
|
|
261
|
-
* <ul>
|
|
262
|
-
* <li>
|
|
263
|
-
* <p>Interactions</p>
|
|
264
|
-
* </li>
|
|
265
|
-
* <li>
|
|
266
|
-
* <p>Items</p>
|
|
267
|
-
* </li>
|
|
268
|
-
* <li>
|
|
269
|
-
* <p>Users</p>
|
|
270
|
-
* </li>
|
|
271
|
-
* </ul>
|
|
272
|
-
* <p> A dataset group can be a Domain dataset group, where you specify a
|
|
273
|
-
* domain and use pre-configured resources like recommenders, or a
|
|
274
|
-
* Custom dataset group, where you use custom resources, such as a solution
|
|
275
|
-
* with a solution version, that you deploy with a campaign. If you start
|
|
276
|
-
* with a Domain dataset group, you can still add custom resources such as
|
|
277
|
-
* solutions and solution versions trained with recipes for custom use cases
|
|
278
|
-
* and deployed with campaigns. </p>
|
|
279
|
-
* <p>A dataset group can be in one of the following states:</p>
|
|
280
|
-
* <ul>
|
|
281
|
-
* <li>
|
|
282
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
283
|
-
* FAILED</p>
|
|
284
|
-
* </li>
|
|
285
|
-
* <li>
|
|
286
|
-
* <p>DELETE PENDING</p>
|
|
287
|
-
* </li>
|
|
288
|
-
* </ul>
|
|
289
|
-
* <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 the status shows as CREATE FAILED, the
|
|
290
|
-
* response includes a <code>failureReason</code> key, which describes why
|
|
291
|
-
* the creation failed.</p>
|
|
292
|
-
* <note>
|
|
293
|
-
* <p>You must wait until the <code>status</code> of the dataset group is
|
|
294
|
-
* <code>ACTIVE</code> before adding a dataset to the group.</p>
|
|
295
|
-
* </note>
|
|
296
|
-
* <p>You can specify an Key Management Service (KMS) key to encrypt the datasets in
|
|
297
|
-
* the group. If you specify a KMS key, you must also include an Identity and Access Management
|
|
298
|
-
* (IAM) role that has permission to access the key.</p>
|
|
299
|
-
* <p class="title">
|
|
300
|
-
* <b>APIs that require a dataset group ARN in the request</b>
|
|
301
|
-
* </p>
|
|
302
|
-
* <ul>
|
|
303
|
-
* <li>
|
|
304
|
-
* <p>
|
|
305
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>
|
|
306
|
-
* </p>
|
|
307
|
-
* </li>
|
|
308
|
-
* <li>
|
|
309
|
-
* <p>
|
|
310
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>
|
|
311
|
-
* </p>
|
|
312
|
-
* </li>
|
|
313
|
-
* <li>
|
|
314
|
-
* <p>
|
|
315
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>
|
|
316
|
-
* </p>
|
|
317
|
-
* </li>
|
|
318
|
-
* </ul>
|
|
319
|
-
* <p class="title">
|
|
320
|
-
* <b>Related APIs</b>
|
|
321
|
-
* </p>
|
|
322
|
-
* <ul>
|
|
323
|
-
* <li>
|
|
324
|
-
* <p>
|
|
325
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetGroups.html">ListDatasetGroups</a>
|
|
326
|
-
* </p>
|
|
327
|
-
* </li>
|
|
328
|
-
* <li>
|
|
329
|
-
* <p>
|
|
330
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html">DescribeDatasetGroup</a>
|
|
331
|
-
* </p>
|
|
332
|
-
* </li>
|
|
333
|
-
* <li>
|
|
334
|
-
* <p>
|
|
335
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDatasetGroup.html">DeleteDatasetGroup</a>
|
|
336
|
-
* </p>
|
|
337
|
-
* </li>
|
|
338
|
-
* </ul>
|
|
101
|
+
* @see {@link CreateDatasetGroupCommand}
|
|
339
102
|
*/
|
|
340
103
|
createDatasetGroup(args: CreateDatasetGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetGroupCommandOutput>;
|
|
341
104
|
createDatasetGroup(args: CreateDatasetGroupCommandInput, cb: (err: any, data?: CreateDatasetGroupCommandOutput) => void): void;
|
|
342
105
|
createDatasetGroup(args: CreateDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetGroupCommandOutput) => void): void;
|
|
343
106
|
/**
|
|
344
|
-
* @
|
|
345
|
-
* <p>Creates a job that imports training data from your data source (an
|
|
346
|
-
* Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the
|
|
347
|
-
* training data, you must specify an IAM service role that has permission to
|
|
348
|
-
* read from the data source, as Amazon Personalize makes a copy of your data and
|
|
349
|
-
* processes it internally. For information on granting access to your Amazon S3
|
|
350
|
-
* bucket, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html">Giving
|
|
351
|
-
* Amazon Personalize Access to Amazon S3 Resources</a>. </p>
|
|
352
|
-
* <important>
|
|
353
|
-
* <p>By default, a dataset import job replaces any existing data in the
|
|
354
|
-
* dataset that you imported in bulk. To add new records without replacing
|
|
355
|
-
* existing data, specify INCREMENTAL for the import mode in the
|
|
356
|
-
* CreateDatasetImportJob operation.</p>
|
|
357
|
-
* </important>
|
|
358
|
-
* <p>
|
|
359
|
-
* <b>Status</b>
|
|
360
|
-
* </p>
|
|
361
|
-
* <p>A dataset import job can be in one of the following states:</p>
|
|
362
|
-
* <ul>
|
|
363
|
-
* <li>
|
|
364
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
365
|
-
* FAILED</p>
|
|
366
|
-
* </li>
|
|
367
|
-
* </ul>
|
|
368
|
-
* <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>, providing the Amazon Resource Name
|
|
369
|
-
* (ARN) of the dataset import job. The dataset import is complete when the
|
|
370
|
-
* status shows as ACTIVE. If the status shows as CREATE FAILED, the response
|
|
371
|
-
* includes a <code>failureReason</code> key, which describes why the job
|
|
372
|
-
* failed.</p>
|
|
373
|
-
* <note>
|
|
374
|
-
* <p>Importing takes time. You must wait until the status shows as ACTIVE
|
|
375
|
-
* before training a model using the dataset.</p>
|
|
376
|
-
* </note>
|
|
377
|
-
*
|
|
378
|
-
* <p class="title">
|
|
379
|
-
* <b>Related APIs</b>
|
|
380
|
-
* </p>
|
|
381
|
-
* <ul>
|
|
382
|
-
* <li>
|
|
383
|
-
* <p>
|
|
384
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetImportJobs.html">ListDatasetImportJobs</a>
|
|
385
|
-
* </p>
|
|
386
|
-
* </li>
|
|
387
|
-
* <li>
|
|
388
|
-
* <p>
|
|
389
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html">DescribeDatasetImportJob</a>
|
|
390
|
-
* </p>
|
|
391
|
-
* </li>
|
|
392
|
-
* </ul>
|
|
107
|
+
* @see {@link CreateDatasetImportJobCommand}
|
|
393
108
|
*/
|
|
394
109
|
createDatasetImportJob(args: CreateDatasetImportJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetImportJobCommandOutput>;
|
|
395
110
|
createDatasetImportJob(args: CreateDatasetImportJobCommandInput, cb: (err: any, data?: CreateDatasetImportJobCommandOutput) => void): void;
|
|
396
111
|
createDatasetImportJob(args: CreateDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetImportJobCommandOutput) => void): void;
|
|
397
112
|
/**
|
|
398
|
-
* @
|
|
399
|
-
* <p>Creates an event tracker that you use when adding event data to a specified dataset
|
|
400
|
-
* group using the
|
|
401
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html">PutEvents</a> API.</p>
|
|
402
|
-
* <note>
|
|
403
|
-
* <p>Only one event tracker can be associated with a dataset group. You will get
|
|
404
|
-
* an error if you call <code>CreateEventTracker</code> using the same dataset group as an
|
|
405
|
-
* existing event tracker.</p>
|
|
406
|
-
* </note>
|
|
407
|
-
* <p>When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the
|
|
408
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html">PutEvents</a> operation.
|
|
409
|
-
* Amazon Personalize then appends the event data to the Interactions dataset of the dataset group you specify
|
|
410
|
-
* in your event tracker.
|
|
411
|
-
* </p>
|
|
412
|
-
* <p>The event tracker can be in one of the following states:</p>
|
|
413
|
-
* <ul>
|
|
414
|
-
* <li>
|
|
415
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
|
|
416
|
-
* </li>
|
|
417
|
-
* <li>
|
|
418
|
-
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
419
|
-
* </li>
|
|
420
|
-
* </ul>
|
|
421
|
-
* <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>
|
|
422
|
-
* <note>
|
|
423
|
-
* <p>The event tracker must be in the ACTIVE state before using the tracking ID.</p>
|
|
424
|
-
* </note>
|
|
425
|
-
* <p class="title">
|
|
426
|
-
* <b>Related APIs</b>
|
|
427
|
-
* </p>
|
|
428
|
-
* <ul>
|
|
429
|
-
* <li>
|
|
430
|
-
* <p>
|
|
431
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListEventTrackers.html">ListEventTrackers</a>
|
|
432
|
-
* </p>
|
|
433
|
-
* </li>
|
|
434
|
-
* <li>
|
|
435
|
-
* <p>
|
|
436
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html">DescribeEventTracker</a>
|
|
437
|
-
* </p>
|
|
438
|
-
* </li>
|
|
439
|
-
* <li>
|
|
440
|
-
* <p>
|
|
441
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteEventTracker.html">DeleteEventTracker</a>
|
|
442
|
-
* </p>
|
|
443
|
-
* </li>
|
|
444
|
-
* </ul>
|
|
113
|
+
* @see {@link CreateEventTrackerCommand}
|
|
445
114
|
*/
|
|
446
115
|
createEventTracker(args: CreateEventTrackerCommandInput, options?: __HttpHandlerOptions): Promise<CreateEventTrackerCommandOutput>;
|
|
447
116
|
createEventTracker(args: CreateEventTrackerCommandInput, cb: (err: any, data?: CreateEventTrackerCommandOutput) => void): void;
|
|
448
117
|
createEventTracker(args: CreateEventTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventTrackerCommandOutput) => void): void;
|
|
449
118
|
/**
|
|
450
|
-
* @
|
|
451
|
-
* <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>
|
|
119
|
+
* @see {@link CreateFilterCommand}
|
|
452
120
|
*/
|
|
453
121
|
createFilter(args: CreateFilterCommandInput, options?: __HttpHandlerOptions): Promise<CreateFilterCommandOutput>;
|
|
454
122
|
createFilter(args: CreateFilterCommandInput, cb: (err: any, data?: CreateFilterCommandOutput) => void): void;
|
|
455
123
|
createFilter(args: CreateFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFilterCommandOutput) => void): void;
|
|
456
124
|
/**
|
|
457
|
-
* @
|
|
458
|
-
* <p>Creates a metric attribution.
|
|
459
|
-
* A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3.
|
|
460
|
-
* For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html">Measuring impact of recommendations</a>.</p>
|
|
125
|
+
* @see {@link CreateMetricAttributionCommand}
|
|
461
126
|
*/
|
|
462
127
|
createMetricAttribution(args: CreateMetricAttributionCommandInput, options?: __HttpHandlerOptions): Promise<CreateMetricAttributionCommandOutput>;
|
|
463
128
|
createMetricAttribution(args: CreateMetricAttributionCommandInput, cb: (err: any, data?: CreateMetricAttributionCommandOutput) => void): void;
|
|
464
129
|
createMetricAttribution(args: CreateMetricAttributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMetricAttributionCommandOutput) => void): void;
|
|
465
130
|
/**
|
|
466
|
-
* @
|
|
467
|
-
* <p>Creates a recommender with the recipe (a Domain dataset group use case) you specify.
|
|
468
|
-
* You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a
|
|
469
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
|
|
470
|
-
* request.
|
|
471
|
-
* </p>
|
|
472
|
-
*
|
|
473
|
-
* <p>
|
|
474
|
-
* <b>Minimum recommendation requests per second</b>
|
|
475
|
-
* </p>
|
|
476
|
-
*
|
|
477
|
-
* <p>When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second
|
|
478
|
-
* (<code>minRecommendationRequestsPerSecond</code>) specifies the baseline recommendation request throughput provisioned by
|
|
479
|
-
* Amazon Personalize. The default minRecommendationRequestsPerSecond is <code>1</code>. A recommendation request is a single <code>GetRecommendations</code> operation.
|
|
480
|
-
* Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive
|
|
481
|
-
* your requests per hour and the price of your recommender usage.
|
|
482
|
-
* </p>
|
|
483
|
-
* <p>
|
|
484
|
-
* If your requests per second increases beyond
|
|
485
|
-
* <code>minRecommendationRequestsPerSecond</code>, Amazon Personalize auto-scales the provisioned capacity up and down,
|
|
486
|
-
* but never below <code>minRecommendationRequestsPerSecond</code>.
|
|
487
|
-
* There's a short time delay while the capacity is increased that might cause loss of
|
|
488
|
-
* requests.</p>
|
|
489
|
-
* <p>
|
|
490
|
-
* Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond)
|
|
491
|
-
* or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window.
|
|
492
|
-
*
|
|
493
|
-
* We recommend starting with the default <code>minRecommendationRequestsPerSecond</code>, track
|
|
494
|
-
* your usage using Amazon CloudWatch metrics, and then increase the <code>minRecommendationRequestsPerSecond</code>
|
|
495
|
-
* as necessary.
|
|
496
|
-
* </p>
|
|
497
|
-
*
|
|
498
|
-
* <p>
|
|
499
|
-
* <b>Status</b>
|
|
500
|
-
* </p>
|
|
501
|
-
* <p>A recommender can be in one of the following states:</p>
|
|
502
|
-
* <ul>
|
|
503
|
-
* <li>
|
|
504
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
|
|
505
|
-
* </li>
|
|
506
|
-
* <li>
|
|
507
|
-
* <p>STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE</p>
|
|
508
|
-
* </li>
|
|
509
|
-
* <li>
|
|
510
|
-
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
511
|
-
* </li>
|
|
512
|
-
* </ul>
|
|
513
|
-
* <p>To get the recommender status, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html">DescribeRecommender</a>.</p>
|
|
514
|
-
* <note>
|
|
515
|
-
* <p>Wait until the <code>status</code> of the recommender
|
|
516
|
-
* is <code>ACTIVE</code> before asking the recommender for recommendations.</p>
|
|
517
|
-
* </note>
|
|
518
|
-
* <p class="title">
|
|
519
|
-
* <b>Related APIs</b>
|
|
520
|
-
* </p>
|
|
521
|
-
* <ul>
|
|
522
|
-
* <li>
|
|
523
|
-
* <p>
|
|
524
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListRecommenders.html">ListRecommenders</a>
|
|
525
|
-
* </p>
|
|
526
|
-
* </li>
|
|
527
|
-
* <li>
|
|
528
|
-
* <p>
|
|
529
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html">DescribeRecommender</a>
|
|
530
|
-
* </p>
|
|
531
|
-
* </li>
|
|
532
|
-
* <li>
|
|
533
|
-
* <p>
|
|
534
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateRecommender.html">UpdateRecommender</a>
|
|
535
|
-
* </p>
|
|
536
|
-
* </li>
|
|
537
|
-
* <li>
|
|
538
|
-
* <p>
|
|
539
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteRecommender.html">DeleteRecommender</a>
|
|
540
|
-
* </p>
|
|
541
|
-
* </li>
|
|
542
|
-
* </ul>
|
|
131
|
+
* @see {@link CreateRecommenderCommand}
|
|
543
132
|
*/
|
|
544
133
|
createRecommender(args: CreateRecommenderCommandInput, options?: __HttpHandlerOptions): Promise<CreateRecommenderCommandOutput>;
|
|
545
134
|
createRecommender(args: CreateRecommenderCommandInput, cb: (err: any, data?: CreateRecommenderCommandOutput) => void): void;
|
|
546
135
|
createRecommender(args: CreateRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRecommenderCommandOutput) => void): void;
|
|
547
136
|
/**
|
|
548
|
-
* @
|
|
549
|
-
* <p>Creates an Amazon Personalize schema from the specified schema string. The schema you create
|
|
550
|
-
* must be in Avro JSON format.</p>
|
|
551
|
-
* <p>Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset
|
|
552
|
-
* 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
|
|
553
|
-
* provide the domain of the Domain dataset group.
|
|
554
|
-
* You specify a schema when you call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
555
|
-
*
|
|
556
|
-
* <p class="title">
|
|
557
|
-
* <b>Related APIs</b>
|
|
558
|
-
* </p>
|
|
559
|
-
* <ul>
|
|
560
|
-
* <li>
|
|
561
|
-
* <p>
|
|
562
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSchemas.html">ListSchemas</a>
|
|
563
|
-
* </p>
|
|
564
|
-
* </li>
|
|
565
|
-
* <li>
|
|
566
|
-
* <p>
|
|
567
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html">DescribeSchema</a>
|
|
568
|
-
* </p>
|
|
569
|
-
* </li>
|
|
570
|
-
* <li>
|
|
571
|
-
* <p>
|
|
572
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSchema.html">DeleteSchema</a>
|
|
573
|
-
* </p>
|
|
574
|
-
* </li>
|
|
575
|
-
* </ul>
|
|
137
|
+
* @see {@link CreateSchemaCommand}
|
|
576
138
|
*/
|
|
577
139
|
createSchema(args: CreateSchemaCommandInput, options?: __HttpHandlerOptions): Promise<CreateSchemaCommandOutput>;
|
|
578
140
|
createSchema(args: CreateSchemaCommandInput, cb: (err: any, data?: CreateSchemaCommandOutput) => void): void;
|
|
579
141
|
createSchema(args: CreateSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSchemaCommandOutput) => void): void;
|
|
580
142
|
/**
|
|
581
|
-
* @
|
|
582
|
-
* <p>Creates the configuration for training a model. A trained model is known as
|
|
583
|
-
* a solution. After the configuration is created, you train the model (create a solution)
|
|
584
|
-
* by calling the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html">CreateSolutionVersion</a> operation. Every time you call
|
|
585
|
-
* <code>CreateSolutionVersion</code>, a new version of the solution is created.</p>
|
|
586
|
-
* <p>After creating a solution version, you check its accuracy by calling
|
|
587
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html">GetSolutionMetrics</a>. When you are satisfied with the version, you
|
|
588
|
-
* deploy it using <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>. The campaign provides recommendations
|
|
589
|
-
* to a client through the
|
|
590
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a> API.</p>
|
|
591
|
-
* <p>To train a model, Amazon Personalize requires training data and a recipe. The training data
|
|
592
|
-
* comes from the dataset group that you provide in the request. A recipe specifies
|
|
593
|
-
* the training algorithm and a feature transformation. You can specify one of the predefined
|
|
594
|
-
* recipes provided by Amazon Personalize. Alternatively, you can specify
|
|
595
|
-
* <code>performAutoML</code> and Amazon Personalize will analyze your data and select the
|
|
596
|
-
* optimum USER_PERSONALIZATION recipe for you.</p>
|
|
597
|
-
* <note>
|
|
598
|
-
* <p>Amazon Personalize doesn't support configuring the <code>hpoObjective</code>
|
|
599
|
-
* for solution hyperparameter optimization at this time.</p>
|
|
600
|
-
* </note>
|
|
601
|
-
* <p>
|
|
602
|
-
* <b>Status</b>
|
|
603
|
-
* </p>
|
|
604
|
-
* <p>A solution can be in one of the following states:</p>
|
|
605
|
-
* <ul>
|
|
606
|
-
* <li>
|
|
607
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
|
|
608
|
-
* </li>
|
|
609
|
-
* <li>
|
|
610
|
-
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
611
|
-
* </li>
|
|
612
|
-
* </ul>
|
|
613
|
-
* <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
|
|
614
|
-
* until the status shows as ACTIVE before calling <code>CreateSolutionVersion</code>.</p>
|
|
615
|
-
*
|
|
616
|
-
*
|
|
617
|
-
*
|
|
618
|
-
* <p class="title">
|
|
619
|
-
* <b>Related APIs</b>
|
|
620
|
-
* </p>
|
|
621
|
-
* <ul>
|
|
622
|
-
* <li>
|
|
623
|
-
* <p>
|
|
624
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html">ListSolutions</a>
|
|
625
|
-
* </p>
|
|
626
|
-
* </li>
|
|
627
|
-
* <li>
|
|
628
|
-
* <p>
|
|
629
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html">CreateSolutionVersion</a>
|
|
630
|
-
* </p>
|
|
631
|
-
* </li>
|
|
632
|
-
* <li>
|
|
633
|
-
* <p>
|
|
634
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html">DescribeSolution</a>
|
|
635
|
-
* </p>
|
|
636
|
-
* </li>
|
|
637
|
-
* <li>
|
|
638
|
-
* <p>
|
|
639
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html">DeleteSolution</a>
|
|
640
|
-
* </p>
|
|
641
|
-
* </li>
|
|
642
|
-
* </ul>
|
|
643
|
-
* <ul>
|
|
644
|
-
* <li>
|
|
645
|
-
* <p>
|
|
646
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html">ListSolutionVersions</a>
|
|
647
|
-
* </p>
|
|
648
|
-
* </li>
|
|
649
|
-
* <li>
|
|
650
|
-
* <p>
|
|
651
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html">DescribeSolutionVersion</a>
|
|
652
|
-
* </p>
|
|
653
|
-
* </li>
|
|
654
|
-
* </ul>
|
|
143
|
+
* @see {@link CreateSolutionCommand}
|
|
655
144
|
*/
|
|
656
145
|
createSolution(args: CreateSolutionCommandInput, options?: __HttpHandlerOptions): Promise<CreateSolutionCommandOutput>;
|
|
657
146
|
createSolution(args: CreateSolutionCommandInput, cb: (err: any, data?: CreateSolutionCommandOutput) => void): void;
|
|
658
147
|
createSolution(args: CreateSolutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSolutionCommandOutput) => void): void;
|
|
659
148
|
/**
|
|
660
|
-
* @
|
|
661
|
-
* <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>
|
|
662
|
-
* operation and must be in the ACTIVE state before calling
|
|
663
|
-
* <code>CreateSolutionVersion</code>. A new version of the solution is created every time you
|
|
664
|
-
* call this operation.</p>
|
|
665
|
-
* <p>
|
|
666
|
-
* <b>Status</b>
|
|
667
|
-
* </p>
|
|
668
|
-
* <p>A solution version can be in one of the following states:</p>
|
|
669
|
-
* <ul>
|
|
670
|
-
* <li>
|
|
671
|
-
* <p>CREATE PENDING</p>
|
|
672
|
-
* </li>
|
|
673
|
-
* <li>
|
|
674
|
-
* <p>CREATE IN_PROGRESS</p>
|
|
675
|
-
* </li>
|
|
676
|
-
* <li>
|
|
677
|
-
* <p>ACTIVE</p>
|
|
678
|
-
* </li>
|
|
679
|
-
* <li>
|
|
680
|
-
* <p>CREATE FAILED</p>
|
|
681
|
-
* </li>
|
|
682
|
-
* <li>
|
|
683
|
-
* <p>CREATE STOPPING</p>
|
|
684
|
-
* </li>
|
|
685
|
-
* <li>
|
|
686
|
-
* <p>CREATE STOPPED</p>
|
|
687
|
-
* </li>
|
|
688
|
-
* </ul>
|
|
689
|
-
* <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
|
|
690
|
-
* until the status shows as ACTIVE before calling <code>CreateCampaign</code>.</p>
|
|
691
|
-
* <p>If the status shows as CREATE FAILED, the response includes a <code>failureReason</code>
|
|
692
|
-
* key, which describes why the job failed.</p>
|
|
693
|
-
* <p class="title">
|
|
694
|
-
* <b>Related APIs</b>
|
|
695
|
-
* </p>
|
|
696
|
-
* <ul>
|
|
697
|
-
* <li>
|
|
698
|
-
* <p>
|
|
699
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html">ListSolutionVersions</a>
|
|
700
|
-
* </p>
|
|
701
|
-
* </li>
|
|
702
|
-
* <li>
|
|
703
|
-
* <p>
|
|
704
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html">DescribeSolutionVersion</a>
|
|
705
|
-
* </p>
|
|
706
|
-
* </li>
|
|
707
|
-
* <li>
|
|
708
|
-
* <p>
|
|
709
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html">ListSolutions</a>
|
|
710
|
-
* </p>
|
|
711
|
-
* </li>
|
|
712
|
-
* <li>
|
|
713
|
-
* <p>
|
|
714
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>
|
|
715
|
-
* </p>
|
|
716
|
-
* </li>
|
|
717
|
-
* <li>
|
|
718
|
-
* <p>
|
|
719
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html">DescribeSolution</a>
|
|
720
|
-
* </p>
|
|
721
|
-
* </li>
|
|
722
|
-
* <li>
|
|
723
|
-
* <p>
|
|
724
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html">DeleteSolution</a>
|
|
725
|
-
* </p>
|
|
726
|
-
* </li>
|
|
727
|
-
* </ul>
|
|
149
|
+
* @see {@link CreateSolutionVersionCommand}
|
|
728
150
|
*/
|
|
729
151
|
createSolutionVersion(args: CreateSolutionVersionCommandInput, options?: __HttpHandlerOptions): Promise<CreateSolutionVersionCommandOutput>;
|
|
730
152
|
createSolutionVersion(args: CreateSolutionVersionCommandInput, cb: (err: any, data?: CreateSolutionVersionCommandOutput) => void): void;
|
|
731
153
|
createSolutionVersion(args: CreateSolutionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSolutionVersionCommandOutput) => void): void;
|
|
732
154
|
/**
|
|
733
|
-
* @
|
|
734
|
-
* <p>Removes a campaign by deleting the solution deployment. The solution that
|
|
735
|
-
* the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no
|
|
736
|
-
* longer be specified in a
|
|
737
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
|
|
738
|
-
* request.
|
|
739
|
-
* For information on creating campaigns, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>.</p>
|
|
155
|
+
* @see {@link DeleteCampaignCommand}
|
|
740
156
|
*/
|
|
741
157
|
deleteCampaign(args: DeleteCampaignCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCampaignCommandOutput>;
|
|
742
158
|
deleteCampaign(args: DeleteCampaignCommandInput, cb: (err: any, data?: DeleteCampaignCommandOutput) => void): void;
|
|
743
159
|
deleteCampaign(args: DeleteCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCampaignCommandOutput) => void): void;
|
|
744
160
|
/**
|
|
745
|
-
* @
|
|
746
|
-
* <p>Deletes a dataset. You can't delete a dataset if an associated
|
|
747
|
-
* <code>DatasetImportJob</code> or <code>SolutionVersion</code> is in the
|
|
748
|
-
* CREATE PENDING or IN PROGRESS state. For more information on datasets, see
|
|
749
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
161
|
+
* @see {@link DeleteDatasetCommand}
|
|
750
162
|
*/
|
|
751
163
|
deleteDataset(args: DeleteDatasetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatasetCommandOutput>;
|
|
752
164
|
deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
|
|
753
165
|
deleteDataset(args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
|
|
754
166
|
/**
|
|
755
|
-
* @
|
|
756
|
-
* <p>Deletes a dataset group. Before you delete a dataset group, you must
|
|
757
|
-
* delete the following:</p>
|
|
758
|
-
* <ul>
|
|
759
|
-
* <li>
|
|
760
|
-
* <p>All associated event trackers.</p>
|
|
761
|
-
* </li>
|
|
762
|
-
* <li>
|
|
763
|
-
* <p>All associated solutions.</p>
|
|
764
|
-
* </li>
|
|
765
|
-
* <li>
|
|
766
|
-
* <p>All datasets in the dataset group.</p>
|
|
767
|
-
* </li>
|
|
768
|
-
* </ul>
|
|
167
|
+
* @see {@link DeleteDatasetGroupCommand}
|
|
769
168
|
*/
|
|
770
169
|
deleteDatasetGroup(args: DeleteDatasetGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatasetGroupCommandOutput>;
|
|
771
170
|
deleteDatasetGroup(args: DeleteDatasetGroupCommandInput, cb: (err: any, data?: DeleteDatasetGroupCommandOutput) => void): void;
|
|
772
171
|
deleteDatasetGroup(args: DeleteDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetGroupCommandOutput) => void): void;
|
|
773
172
|
/**
|
|
774
|
-
* @
|
|
775
|
-
* <p>Deletes the event tracker. Does not delete the event-interactions dataset from
|
|
776
|
-
* the associated dataset group. For more
|
|
777
|
-
* information on event trackers, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>.</p>
|
|
173
|
+
* @see {@link DeleteEventTrackerCommand}
|
|
778
174
|
*/
|
|
779
175
|
deleteEventTracker(args: DeleteEventTrackerCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEventTrackerCommandOutput>;
|
|
780
176
|
deleteEventTracker(args: DeleteEventTrackerCommandInput, cb: (err: any, data?: DeleteEventTrackerCommandOutput) => void): void;
|
|
781
177
|
deleteEventTracker(args: DeleteEventTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventTrackerCommandOutput) => void): void;
|
|
782
178
|
/**
|
|
783
|
-
* @
|
|
784
|
-
* <p>Deletes a filter.</p>
|
|
179
|
+
* @see {@link DeleteFilterCommand}
|
|
785
180
|
*/
|
|
786
181
|
deleteFilter(args: DeleteFilterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteFilterCommandOutput>;
|
|
787
182
|
deleteFilter(args: DeleteFilterCommandInput, cb: (err: any, data?: DeleteFilterCommandOutput) => void): void;
|
|
788
183
|
deleteFilter(args: DeleteFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFilterCommandOutput) => void): void;
|
|
789
184
|
/**
|
|
790
|
-
* @
|
|
791
|
-
* <p>Deletes a metric attribution.</p>
|
|
185
|
+
* @see {@link DeleteMetricAttributionCommand}
|
|
792
186
|
*/
|
|
793
187
|
deleteMetricAttribution(args: DeleteMetricAttributionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMetricAttributionCommandOutput>;
|
|
794
188
|
deleteMetricAttribution(args: DeleteMetricAttributionCommandInput, cb: (err: any, data?: DeleteMetricAttributionCommandOutput) => void): void;
|
|
795
189
|
deleteMetricAttribution(args: DeleteMetricAttributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMetricAttributionCommandOutput) => void): void;
|
|
796
190
|
/**
|
|
797
|
-
* @
|
|
798
|
-
* <p>Deactivates and removes a recommender. A deleted recommender can no longer be specified in a <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
|
|
799
|
-
* request.</p>
|
|
191
|
+
* @see {@link DeleteRecommenderCommand}
|
|
800
192
|
*/
|
|
801
193
|
deleteRecommender(args: DeleteRecommenderCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRecommenderCommandOutput>;
|
|
802
194
|
deleteRecommender(args: DeleteRecommenderCommandInput, cb: (err: any, data?: DeleteRecommenderCommandOutput) => void): void;
|
|
803
195
|
deleteRecommender(args: DeleteRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRecommenderCommandOutput) => void): void;
|
|
804
196
|
/**
|
|
805
|
-
* @
|
|
806
|
-
* <p>Deletes a schema. Before deleting a schema, you must delete all
|
|
807
|
-
* datasets referencing the schema. For more information on schemas, see
|
|
808
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html">CreateSchema</a>.</p>
|
|
197
|
+
* @see {@link DeleteSchemaCommand}
|
|
809
198
|
*/
|
|
810
199
|
deleteSchema(args: DeleteSchemaCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSchemaCommandOutput>;
|
|
811
200
|
deleteSchema(args: DeleteSchemaCommandInput, cb: (err: any, data?: DeleteSchemaCommandOutput) => void): void;
|
|
812
201
|
deleteSchema(args: DeleteSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSchemaCommandOutput) => void): void;
|
|
813
202
|
/**
|
|
814
|
-
* @
|
|
815
|
-
* <p>Deletes all versions of a solution and the <code>Solution</code> object itself.
|
|
816
|
-
* Before deleting a solution, you must delete all campaigns based on
|
|
817
|
-
* the solution. To determine what campaigns are using the solution, call
|
|
818
|
-
* <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.
|
|
819
|
-
* You can't delete a solution if an associated <code>SolutionVersion</code> is in the
|
|
820
|
-
* CREATE PENDING or IN PROGRESS state.
|
|
821
|
-
* For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>.</p>
|
|
203
|
+
* @see {@link DeleteSolutionCommand}
|
|
822
204
|
*/
|
|
823
205
|
deleteSolution(args: DeleteSolutionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSolutionCommandOutput>;
|
|
824
206
|
deleteSolution(args: DeleteSolutionCommandInput, cb: (err: any, data?: DeleteSolutionCommandOutput) => void): void;
|
|
825
207
|
deleteSolution(args: DeleteSolutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSolutionCommandOutput) => void): void;
|
|
826
208
|
/**
|
|
827
|
-
* @
|
|
828
|
-
* <p>Describes the given algorithm.</p>
|
|
209
|
+
* @see {@link DescribeAlgorithmCommand}
|
|
829
210
|
*/
|
|
830
211
|
describeAlgorithm(args: DescribeAlgorithmCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAlgorithmCommandOutput>;
|
|
831
212
|
describeAlgorithm(args: DescribeAlgorithmCommandInput, cb: (err: any, data?: DescribeAlgorithmCommandOutput) => void): void;
|
|
832
213
|
describeAlgorithm(args: DescribeAlgorithmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAlgorithmCommandOutput) => void): void;
|
|
833
214
|
/**
|
|
834
|
-
* @
|
|
835
|
-
* <p>Gets the properties of a batch inference job including name, Amazon Resource Name (ARN),
|
|
836
|
-
* status, input and output configurations, and the ARN of the solution version used to generate
|
|
837
|
-
* the recommendations.</p>
|
|
215
|
+
* @see {@link DescribeBatchInferenceJobCommand}
|
|
838
216
|
*/
|
|
839
217
|
describeBatchInferenceJob(args: DescribeBatchInferenceJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBatchInferenceJobCommandOutput>;
|
|
840
218
|
describeBatchInferenceJob(args: DescribeBatchInferenceJobCommandInput, cb: (err: any, data?: DescribeBatchInferenceJobCommandOutput) => void): void;
|
|
841
219
|
describeBatchInferenceJob(args: DescribeBatchInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBatchInferenceJobCommandOutput) => void): void;
|
|
842
220
|
/**
|
|
843
|
-
* @
|
|
844
|
-
* <p>Gets the properties of a batch segment job including name, Amazon Resource Name (ARN),
|
|
845
|
-
* status, input and output configurations, and the ARN of the solution version used to generate
|
|
846
|
-
* segments.</p>
|
|
221
|
+
* @see {@link DescribeBatchSegmentJobCommand}
|
|
847
222
|
*/
|
|
848
223
|
describeBatchSegmentJob(args: DescribeBatchSegmentJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBatchSegmentJobCommandOutput>;
|
|
849
224
|
describeBatchSegmentJob(args: DescribeBatchSegmentJobCommandInput, cb: (err: any, data?: DescribeBatchSegmentJobCommandOutput) => void): void;
|
|
850
225
|
describeBatchSegmentJob(args: DescribeBatchSegmentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBatchSegmentJobCommandOutput) => void): void;
|
|
851
226
|
/**
|
|
852
|
-
* @
|
|
853
|
-
* <p>Describes the given campaign, including its status.</p>
|
|
854
|
-
* <p>A campaign can be in one of the following states:</p>
|
|
855
|
-
* <ul>
|
|
856
|
-
* <li>
|
|
857
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
|
|
858
|
-
* </li>
|
|
859
|
-
* <li>
|
|
860
|
-
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
861
|
-
* </li>
|
|
862
|
-
* </ul>
|
|
863
|
-
* <p>When the <code>status</code> is <code>CREATE FAILED</code>, the response includes the
|
|
864
|
-
* <code>failureReason</code> key, which describes why.</p>
|
|
865
|
-
* <p>For more information on campaigns, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>.</p>
|
|
227
|
+
* @see {@link DescribeCampaignCommand}
|
|
866
228
|
*/
|
|
867
229
|
describeCampaign(args: DescribeCampaignCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCampaignCommandOutput>;
|
|
868
230
|
describeCampaign(args: DescribeCampaignCommandInput, cb: (err: any, data?: DescribeCampaignCommandOutput) => void): void;
|
|
869
231
|
describeCampaign(args: DescribeCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCampaignCommandOutput) => void): void;
|
|
870
232
|
/**
|
|
871
|
-
* @
|
|
872
|
-
* <p>Describes the given dataset. For more information on datasets, see
|
|
873
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
233
|
+
* @see {@link DescribeDatasetCommand}
|
|
874
234
|
*/
|
|
875
235
|
describeDataset(args: DescribeDatasetCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetCommandOutput>;
|
|
876
236
|
describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
|
|
877
237
|
describeDataset(args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
|
|
878
238
|
/**
|
|
879
|
-
* @
|
|
880
|
-
* <p>Describes the dataset export job created by <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html">CreateDatasetExportJob</a>, including the export job status.</p>
|
|
239
|
+
* @see {@link DescribeDatasetExportJobCommand}
|
|
881
240
|
*/
|
|
882
241
|
describeDatasetExportJob(args: DescribeDatasetExportJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetExportJobCommandOutput>;
|
|
883
242
|
describeDatasetExportJob(args: DescribeDatasetExportJobCommandInput, cb: (err: any, data?: DescribeDatasetExportJobCommandOutput) => void): void;
|
|
884
243
|
describeDatasetExportJob(args: DescribeDatasetExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetExportJobCommandOutput) => void): void;
|
|
885
244
|
/**
|
|
886
|
-
* @
|
|
887
|
-
* <p>Describes the given dataset group. For more information on dataset
|
|
888
|
-
* groups, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>.</p>
|
|
245
|
+
* @see {@link DescribeDatasetGroupCommand}
|
|
889
246
|
*/
|
|
890
247
|
describeDatasetGroup(args: DescribeDatasetGroupCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetGroupCommandOutput>;
|
|
891
248
|
describeDatasetGroup(args: DescribeDatasetGroupCommandInput, cb: (err: any, data?: DescribeDatasetGroupCommandOutput) => void): void;
|
|
892
249
|
describeDatasetGroup(args: DescribeDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetGroupCommandOutput) => void): void;
|
|
893
250
|
/**
|
|
894
|
-
* @
|
|
895
|
-
* <p>Describes the dataset import job created by <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>, including the import job status.</p>
|
|
251
|
+
* @see {@link DescribeDatasetImportJobCommand}
|
|
896
252
|
*/
|
|
897
253
|
describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetImportJobCommandOutput>;
|
|
898
254
|
describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, cb: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void): void;
|
|
899
255
|
describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void): void;
|
|
900
256
|
/**
|
|
901
|
-
* @
|
|
902
|
-
* <p>Describes an event tracker. The response includes the <code>trackingId</code> and
|
|
903
|
-
* <code>status</code> of the event tracker.
|
|
904
|
-
* For more information on event trackers, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>.</p>
|
|
257
|
+
* @see {@link DescribeEventTrackerCommand}
|
|
905
258
|
*/
|
|
906
259
|
describeEventTracker(args: DescribeEventTrackerCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventTrackerCommandOutput>;
|
|
907
260
|
describeEventTracker(args: DescribeEventTrackerCommandInput, cb: (err: any, data?: DescribeEventTrackerCommandOutput) => void): void;
|
|
908
261
|
describeEventTracker(args: DescribeEventTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventTrackerCommandOutput) => void): void;
|
|
909
262
|
/**
|
|
910
|
-
* @
|
|
911
|
-
* <p>Describes the given feature transformation.</p>
|
|
263
|
+
* @see {@link DescribeFeatureTransformationCommand}
|
|
912
264
|
*/
|
|
913
265
|
describeFeatureTransformation(args: DescribeFeatureTransformationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFeatureTransformationCommandOutput>;
|
|
914
266
|
describeFeatureTransformation(args: DescribeFeatureTransformationCommandInput, cb: (err: any, data?: DescribeFeatureTransformationCommandOutput) => void): void;
|
|
915
267
|
describeFeatureTransformation(args: DescribeFeatureTransformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFeatureTransformationCommandOutput) => void): void;
|
|
916
268
|
/**
|
|
917
|
-
* @
|
|
918
|
-
* <p>Describes a filter's properties.</p>
|
|
269
|
+
* @see {@link DescribeFilterCommand}
|
|
919
270
|
*/
|
|
920
271
|
describeFilter(args: DescribeFilterCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFilterCommandOutput>;
|
|
921
272
|
describeFilter(args: DescribeFilterCommandInput, cb: (err: any, data?: DescribeFilterCommandOutput) => void): void;
|
|
922
273
|
describeFilter(args: DescribeFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFilterCommandOutput) => void): void;
|
|
923
274
|
/**
|
|
924
|
-
* @
|
|
925
|
-
* <p>Describes a metric attribution.</p>
|
|
275
|
+
* @see {@link DescribeMetricAttributionCommand}
|
|
926
276
|
*/
|
|
927
277
|
describeMetricAttribution(args: DescribeMetricAttributionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeMetricAttributionCommandOutput>;
|
|
928
278
|
describeMetricAttribution(args: DescribeMetricAttributionCommandInput, cb: (err: any, data?: DescribeMetricAttributionCommandOutput) => void): void;
|
|
929
279
|
describeMetricAttribution(args: DescribeMetricAttributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMetricAttributionCommandOutput) => void): void;
|
|
930
280
|
/**
|
|
931
|
-
* @
|
|
932
|
-
* <p>Describes a recipe.</p>
|
|
933
|
-
* <p>A recipe contains three items:</p>
|
|
934
|
-
* <ul>
|
|
935
|
-
* <li>
|
|
936
|
-
* <p>An algorithm that trains a model.</p>
|
|
937
|
-
* </li>
|
|
938
|
-
* <li>
|
|
939
|
-
* <p>Hyperparameters that govern the training.</p>
|
|
940
|
-
* </li>
|
|
941
|
-
* <li>
|
|
942
|
-
* <p>Feature transformation information for modifying the input data before training.</p>
|
|
943
|
-
* </li>
|
|
944
|
-
* </ul>
|
|
945
|
-
* <p>Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a
|
|
946
|
-
* solution with the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a> API.
|
|
947
|
-
* <code>CreateSolution</code> trains a model by using the algorithm
|
|
948
|
-
* in the specified recipe and a training dataset. The solution, when deployed as a campaign,
|
|
949
|
-
* can provide recommendations using the
|
|
950
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a> API.</p>
|
|
281
|
+
* @see {@link DescribeRecipeCommand}
|
|
951
282
|
*/
|
|
952
283
|
describeRecipe(args: DescribeRecipeCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRecipeCommandOutput>;
|
|
953
284
|
describeRecipe(args: DescribeRecipeCommandInput, cb: (err: any, data?: DescribeRecipeCommandOutput) => void): void;
|
|
954
285
|
describeRecipe(args: DescribeRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecipeCommandOutput) => void): void;
|
|
955
286
|
/**
|
|
956
|
-
* @
|
|
957
|
-
* <p>Describes the given recommender, including its status.</p>
|
|
958
|
-
* <p>A recommender can be in one of the following states:</p>
|
|
959
|
-
* <ul>
|
|
960
|
-
* <li>
|
|
961
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
|
|
962
|
-
* </li>
|
|
963
|
-
* <li>
|
|
964
|
-
* <p>STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE</p>
|
|
965
|
-
* </li>
|
|
966
|
-
* <li>
|
|
967
|
-
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
968
|
-
* </li>
|
|
969
|
-
* </ul>
|
|
970
|
-
* <p>When the <code>status</code> is <code>CREATE FAILED</code>, the response includes the
|
|
971
|
-
* <code>failureReason</code> key, which describes why.</p>
|
|
972
|
-
* <p>The <code>modelMetrics</code> key is null when
|
|
973
|
-
* the recommender is being created or deleted.</p>
|
|
974
|
-
* <p>For more information on recommenders, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html">CreateRecommender</a>.</p>
|
|
287
|
+
* @see {@link DescribeRecommenderCommand}
|
|
975
288
|
*/
|
|
976
289
|
describeRecommender(args: DescribeRecommenderCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRecommenderCommandOutput>;
|
|
977
290
|
describeRecommender(args: DescribeRecommenderCommandInput, cb: (err: any, data?: DescribeRecommenderCommandOutput) => void): void;
|
|
978
291
|
describeRecommender(args: DescribeRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecommenderCommandOutput) => void): void;
|
|
979
292
|
/**
|
|
980
|
-
* @
|
|
981
|
-
* <p>Describes a schema. For more information on schemas, see
|
|
982
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html">CreateSchema</a>.</p>
|
|
293
|
+
* @see {@link DescribeSchemaCommand}
|
|
983
294
|
*/
|
|
984
295
|
describeSchema(args: DescribeSchemaCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSchemaCommandOutput>;
|
|
985
296
|
describeSchema(args: DescribeSchemaCommandInput, cb: (err: any, data?: DescribeSchemaCommandOutput) => void): void;
|
|
986
297
|
describeSchema(args: DescribeSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSchemaCommandOutput) => void): void;
|
|
987
298
|
/**
|
|
988
|
-
* @
|
|
989
|
-
* <p>Describes a solution.
|
|
990
|
-
* For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>.</p>
|
|
299
|
+
* @see {@link DescribeSolutionCommand}
|
|
991
300
|
*/
|
|
992
301
|
describeSolution(args: DescribeSolutionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSolutionCommandOutput>;
|
|
993
302
|
describeSolution(args: DescribeSolutionCommandInput, cb: (err: any, data?: DescribeSolutionCommandOutput) => void): void;
|
|
994
303
|
describeSolution(args: DescribeSolutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSolutionCommandOutput) => void): void;
|
|
995
304
|
/**
|
|
996
|
-
* @
|
|
997
|
-
* <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>
|
|
998
|
-
* </p>
|
|
305
|
+
* @see {@link DescribeSolutionVersionCommand}
|
|
999
306
|
*/
|
|
1000
307
|
describeSolutionVersion(args: DescribeSolutionVersionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSolutionVersionCommandOutput>;
|
|
1001
308
|
describeSolutionVersion(args: DescribeSolutionVersionCommandInput, cb: (err: any, data?: DescribeSolutionVersionCommandOutput) => void): void;
|
|
1002
309
|
describeSolutionVersion(args: DescribeSolutionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSolutionVersionCommandOutput) => void): void;
|
|
1003
310
|
/**
|
|
1004
|
-
* @
|
|
1005
|
-
* <p>Gets the metrics for the specified solution version.</p>
|
|
311
|
+
* @see {@link GetSolutionMetricsCommand}
|
|
1006
312
|
*/
|
|
1007
313
|
getSolutionMetrics(args: GetSolutionMetricsCommandInput, options?: __HttpHandlerOptions): Promise<GetSolutionMetricsCommandOutput>;
|
|
1008
314
|
getSolutionMetrics(args: GetSolutionMetricsCommandInput, cb: (err: any, data?: GetSolutionMetricsCommandOutput) => void): void;
|
|
1009
315
|
getSolutionMetrics(args: GetSolutionMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSolutionMetricsCommandOutput) => void): void;
|
|
1010
316
|
/**
|
|
1011
|
-
* @
|
|
1012
|
-
* <p>Gets a list of the batch inference jobs that have been performed off of a solution
|
|
1013
|
-
* version.</p>
|
|
317
|
+
* @see {@link ListBatchInferenceJobsCommand}
|
|
1014
318
|
*/
|
|
1015
319
|
listBatchInferenceJobs(args: ListBatchInferenceJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListBatchInferenceJobsCommandOutput>;
|
|
1016
320
|
listBatchInferenceJobs(args: ListBatchInferenceJobsCommandInput, cb: (err: any, data?: ListBatchInferenceJobsCommandOutput) => void): void;
|
|
1017
321
|
listBatchInferenceJobs(args: ListBatchInferenceJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBatchInferenceJobsCommandOutput) => void): void;
|
|
1018
322
|
/**
|
|
1019
|
-
* @
|
|
1020
|
-
* <p>Gets a list of the batch segment jobs that have been performed off of a solution
|
|
1021
|
-
* version that you specify.</p>
|
|
323
|
+
* @see {@link ListBatchSegmentJobsCommand}
|
|
1022
324
|
*/
|
|
1023
325
|
listBatchSegmentJobs(args: ListBatchSegmentJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListBatchSegmentJobsCommandOutput>;
|
|
1024
326
|
listBatchSegmentJobs(args: ListBatchSegmentJobsCommandInput, cb: (err: any, data?: ListBatchSegmentJobsCommandOutput) => void): void;
|
|
1025
327
|
listBatchSegmentJobs(args: ListBatchSegmentJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBatchSegmentJobsCommandOutput) => void): void;
|
|
1026
328
|
/**
|
|
1027
|
-
* @
|
|
1028
|
-
* <p>Returns a list of campaigns that use the given solution.
|
|
1029
|
-
* When a solution is not specified, all the campaigns associated with the account are listed.
|
|
1030
|
-
* The response provides the properties for each campaign, including the Amazon Resource Name (ARN).
|
|
1031
|
-
* For more information on campaigns, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>.</p>
|
|
329
|
+
* @see {@link ListCampaignsCommand}
|
|
1032
330
|
*/
|
|
1033
331
|
listCampaigns(args: ListCampaignsCommandInput, options?: __HttpHandlerOptions): Promise<ListCampaignsCommandOutput>;
|
|
1034
332
|
listCampaigns(args: ListCampaignsCommandInput, cb: (err: any, data?: ListCampaignsCommandOutput) => void): void;
|
|
1035
333
|
listCampaigns(args: ListCampaignsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCampaignsCommandOutput) => void): void;
|
|
1036
334
|
/**
|
|
1037
|
-
* @
|
|
1038
|
-
* <p>Returns a list of dataset export jobs that use the given dataset. When
|
|
1039
|
-
* a dataset is not specified, all the dataset export jobs associated with
|
|
1040
|
-
* the account are listed. The response provides the properties for each
|
|
1041
|
-
* dataset export job, including the Amazon Resource Name (ARN). For more
|
|
1042
|
-
* information on dataset export jobs, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html">CreateDatasetExportJob</a>. For more information on datasets, see
|
|
1043
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
335
|
+
* @see {@link ListDatasetExportJobsCommand}
|
|
1044
336
|
*/
|
|
1045
337
|
listDatasetExportJobs(args: ListDatasetExportJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetExportJobsCommandOutput>;
|
|
1046
338
|
listDatasetExportJobs(args: ListDatasetExportJobsCommandInput, cb: (err: any, data?: ListDatasetExportJobsCommandOutput) => void): void;
|
|
1047
339
|
listDatasetExportJobs(args: ListDatasetExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetExportJobsCommandOutput) => void): void;
|
|
1048
340
|
/**
|
|
1049
|
-
* @
|
|
1050
|
-
* <p>Returns a list of dataset groups. The response provides the properties
|
|
1051
|
-
* for each dataset group, including the Amazon Resource Name (ARN). For more
|
|
1052
|
-
* information on dataset groups, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>.</p>
|
|
341
|
+
* @see {@link ListDatasetGroupsCommand}
|
|
1053
342
|
*/
|
|
1054
343
|
listDatasetGroups(args: ListDatasetGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetGroupsCommandOutput>;
|
|
1055
344
|
listDatasetGroups(args: ListDatasetGroupsCommandInput, cb: (err: any, data?: ListDatasetGroupsCommandOutput) => void): void;
|
|
1056
345
|
listDatasetGroups(args: ListDatasetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetGroupsCommandOutput) => void): void;
|
|
1057
346
|
/**
|
|
1058
|
-
* @
|
|
1059
|
-
* <p>Returns a list of dataset import jobs that use the given dataset. When
|
|
1060
|
-
* a dataset is not specified, all the dataset import jobs associated with
|
|
1061
|
-
* the account are listed. The response provides the properties for each
|
|
1062
|
-
* dataset import job, including the Amazon Resource Name (ARN). For more
|
|
1063
|
-
* information on dataset import jobs, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>. For more information on datasets, see
|
|
1064
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
347
|
+
* @see {@link ListDatasetImportJobsCommand}
|
|
1065
348
|
*/
|
|
1066
349
|
listDatasetImportJobs(args: ListDatasetImportJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetImportJobsCommandOutput>;
|
|
1067
350
|
listDatasetImportJobs(args: ListDatasetImportJobsCommandInput, cb: (err: any, data?: ListDatasetImportJobsCommandOutput) => void): void;
|
|
1068
351
|
listDatasetImportJobs(args: ListDatasetImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetImportJobsCommandOutput) => void): void;
|
|
1069
352
|
/**
|
|
1070
|
-
* @
|
|
1071
|
-
* <p>Returns the list of datasets contained in the given dataset group. The
|
|
1072
|
-
* response provides the properties for each dataset, including the Amazon
|
|
1073
|
-
* Resource Name (ARN). For more information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
353
|
+
* @see {@link ListDatasetsCommand}
|
|
1074
354
|
*/
|
|
1075
355
|
listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetsCommandOutput>;
|
|
1076
356
|
listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
|
|
1077
357
|
listDatasets(args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
|
|
1078
358
|
/**
|
|
1079
|
-
* @
|
|
1080
|
-
* <p>Returns the list of event trackers associated with the account.
|
|
1081
|
-
* The response provides the properties for each event tracker, including the Amazon Resource
|
|
1082
|
-
* Name (ARN) and tracking ID. For more
|
|
1083
|
-
* information on event trackers, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>.</p>
|
|
359
|
+
* @see {@link ListEventTrackersCommand}
|
|
1084
360
|
*/
|
|
1085
361
|
listEventTrackers(args: ListEventTrackersCommandInput, options?: __HttpHandlerOptions): Promise<ListEventTrackersCommandOutput>;
|
|
1086
362
|
listEventTrackers(args: ListEventTrackersCommandInput, cb: (err: any, data?: ListEventTrackersCommandOutput) => void): void;
|
|
1087
363
|
listEventTrackers(args: ListEventTrackersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventTrackersCommandOutput) => void): void;
|
|
1088
364
|
/**
|
|
1089
|
-
* @
|
|
1090
|
-
* <p>Lists all filters that belong to a given dataset group.</p>
|
|
365
|
+
* @see {@link ListFiltersCommand}
|
|
1091
366
|
*/
|
|
1092
367
|
listFilters(args: ListFiltersCommandInput, options?: __HttpHandlerOptions): Promise<ListFiltersCommandOutput>;
|
|
1093
368
|
listFilters(args: ListFiltersCommandInput, cb: (err: any, data?: ListFiltersCommandOutput) => void): void;
|
|
1094
369
|
listFilters(args: ListFiltersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFiltersCommandOutput) => void): void;
|
|
1095
370
|
/**
|
|
1096
|
-
* @
|
|
1097
|
-
* <p>Lists the metrics for the metric attribution.</p>
|
|
371
|
+
* @see {@link ListMetricAttributionMetricsCommand}
|
|
1098
372
|
*/
|
|
1099
373
|
listMetricAttributionMetrics(args: ListMetricAttributionMetricsCommandInput, options?: __HttpHandlerOptions): Promise<ListMetricAttributionMetricsCommandOutput>;
|
|
1100
374
|
listMetricAttributionMetrics(args: ListMetricAttributionMetricsCommandInput, cb: (err: any, data?: ListMetricAttributionMetricsCommandOutput) => void): void;
|
|
1101
375
|
listMetricAttributionMetrics(args: ListMetricAttributionMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMetricAttributionMetricsCommandOutput) => void): void;
|
|
1102
376
|
/**
|
|
1103
|
-
* @
|
|
1104
|
-
* <p>Lists metric attributions.</p>
|
|
377
|
+
* @see {@link ListMetricAttributionsCommand}
|
|
1105
378
|
*/
|
|
1106
379
|
listMetricAttributions(args: ListMetricAttributionsCommandInput, options?: __HttpHandlerOptions): Promise<ListMetricAttributionsCommandOutput>;
|
|
1107
380
|
listMetricAttributions(args: ListMetricAttributionsCommandInput, cb: (err: any, data?: ListMetricAttributionsCommandOutput) => void): void;
|
|
1108
381
|
listMetricAttributions(args: ListMetricAttributionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMetricAttributionsCommandOutput) => void): void;
|
|
1109
382
|
/**
|
|
1110
|
-
* @
|
|
1111
|
-
* <p>Returns a list of available recipes. The response provides the properties
|
|
1112
|
-
* for each recipe, including the recipe's Amazon Resource Name (ARN).</p>
|
|
383
|
+
* @see {@link ListRecipesCommand}
|
|
1113
384
|
*/
|
|
1114
385
|
listRecipes(args: ListRecipesCommandInput, options?: __HttpHandlerOptions): Promise<ListRecipesCommandOutput>;
|
|
1115
386
|
listRecipes(args: ListRecipesCommandInput, cb: (err: any, data?: ListRecipesCommandOutput) => void): void;
|
|
1116
387
|
listRecipes(args: ListRecipesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecipesCommandOutput) => void): void;
|
|
1117
388
|
/**
|
|
1118
|
-
* @
|
|
1119
|
-
* <p>Returns a list of recommenders in a given Domain dataset group.
|
|
1120
|
-
* When a Domain dataset group is not specified, all the recommenders associated with the account are listed.
|
|
1121
|
-
* The response provides the properties for each recommender, including the Amazon Resource Name (ARN).
|
|
1122
|
-
* For more information on recommenders, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html">CreateRecommender</a>.</p>
|
|
389
|
+
* @see {@link ListRecommendersCommand}
|
|
1123
390
|
*/
|
|
1124
391
|
listRecommenders(args: ListRecommendersCommandInput, options?: __HttpHandlerOptions): Promise<ListRecommendersCommandOutput>;
|
|
1125
392
|
listRecommenders(args: ListRecommendersCommandInput, cb: (err: any, data?: ListRecommendersCommandOutput) => void): void;
|
|
1126
393
|
listRecommenders(args: ListRecommendersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecommendersCommandOutput) => void): void;
|
|
1127
394
|
/**
|
|
1128
|
-
* @
|
|
1129
|
-
* <p>Returns the list of schemas associated with the account. The response provides the
|
|
1130
|
-
* properties for each schema, including the Amazon Resource Name (ARN).
|
|
1131
|
-
* For more information on schemas, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html">CreateSchema</a>.</p>
|
|
395
|
+
* @see {@link ListSchemasCommand}
|
|
1132
396
|
*/
|
|
1133
397
|
listSchemas(args: ListSchemasCommandInput, options?: __HttpHandlerOptions): Promise<ListSchemasCommandOutput>;
|
|
1134
398
|
listSchemas(args: ListSchemasCommandInput, cb: (err: any, data?: ListSchemasCommandOutput) => void): void;
|
|
1135
399
|
listSchemas(args: ListSchemasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSchemasCommandOutput) => void): void;
|
|
1136
400
|
/**
|
|
1137
|
-
* @
|
|
1138
|
-
* <p>Returns a list of solutions that use the given dataset group.
|
|
1139
|
-
* When a dataset group is not specified, all the solutions associated with the account are listed.
|
|
1140
|
-
* The response provides the properties for each solution, including the Amazon Resource Name (ARN).
|
|
1141
|
-
* For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>.</p>
|
|
401
|
+
* @see {@link ListSolutionsCommand}
|
|
1142
402
|
*/
|
|
1143
403
|
listSolutions(args: ListSolutionsCommandInput, options?: __HttpHandlerOptions): Promise<ListSolutionsCommandOutput>;
|
|
1144
404
|
listSolutions(args: ListSolutionsCommandInput, cb: (err: any, data?: ListSolutionsCommandOutput) => void): void;
|
|
1145
405
|
listSolutions(args: ListSolutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSolutionsCommandOutput) => void): void;
|
|
1146
406
|
/**
|
|
1147
|
-
* @
|
|
1148
|
-
* <p>Returns a list of solution versions for the given solution. When a solution is not
|
|
1149
|
-
* specified, all the solution versions associated with the account are listed. The response
|
|
1150
|
-
* provides the properties for each solution version, including the Amazon Resource Name (ARN).</p>
|
|
407
|
+
* @see {@link ListSolutionVersionsCommand}
|
|
1151
408
|
*/
|
|
1152
409
|
listSolutionVersions(args: ListSolutionVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListSolutionVersionsCommandOutput>;
|
|
1153
410
|
listSolutionVersions(args: ListSolutionVersionsCommandInput, cb: (err: any, data?: ListSolutionVersionsCommandOutput) => void): void;
|
|
1154
411
|
listSolutionVersions(args: ListSolutionVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSolutionVersionsCommandOutput) => void): void;
|
|
1155
412
|
/**
|
|
1156
|
-
* @
|
|
1157
|
-
* <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>
|
|
413
|
+
* @see {@link ListTagsForResourceCommand}
|
|
1158
414
|
*/
|
|
1159
415
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
1160
416
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
1161
417
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
1162
418
|
/**
|
|
1163
|
-
* @
|
|
1164
|
-
* <p>Starts a recommender that is INACTIVE. Starting a recommender does not
|
|
1165
|
-
* create any new models, but resumes billing and automatic retraining for the recommender.</p>
|
|
419
|
+
* @see {@link StartRecommenderCommand}
|
|
1166
420
|
*/
|
|
1167
421
|
startRecommender(args: StartRecommenderCommandInput, options?: __HttpHandlerOptions): Promise<StartRecommenderCommandOutput>;
|
|
1168
422
|
startRecommender(args: StartRecommenderCommandInput, cb: (err: any, data?: StartRecommenderCommandOutput) => void): void;
|
|
1169
423
|
startRecommender(args: StartRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartRecommenderCommandOutput) => void): void;
|
|
1170
424
|
/**
|
|
1171
|
-
* @
|
|
1172
|
-
* <p>Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.</p>
|
|
425
|
+
* @see {@link StopRecommenderCommand}
|
|
1173
426
|
*/
|
|
1174
427
|
stopRecommender(args: StopRecommenderCommandInput, options?: __HttpHandlerOptions): Promise<StopRecommenderCommandOutput>;
|
|
1175
428
|
stopRecommender(args: StopRecommenderCommandInput, cb: (err: any, data?: StopRecommenderCommandOutput) => void): void;
|
|
1176
429
|
stopRecommender(args: StopRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopRecommenderCommandOutput) => void): void;
|
|
1177
430
|
/**
|
|
1178
|
-
* @
|
|
1179
|
-
* <p>Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
|
|
1180
|
-
* </p>
|
|
1181
|
-
* <p>Depending on the current state of the solution version, the solution version state changes as follows:</p>
|
|
1182
|
-
* <ul>
|
|
1183
|
-
* <li>
|
|
1184
|
-
* <p>CREATE_PENDING > CREATE_STOPPED</p>
|
|
1185
|
-
* <p>or</p>
|
|
1186
|
-
* </li>
|
|
1187
|
-
* <li>
|
|
1188
|
-
* <p>CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED</p>
|
|
1189
|
-
* </li>
|
|
1190
|
-
* </ul>
|
|
1191
|
-
* <p>You are billed for all of the training completed up
|
|
1192
|
-
* until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.</p>
|
|
431
|
+
* @see {@link StopSolutionVersionCreationCommand}
|
|
1193
432
|
*/
|
|
1194
433
|
stopSolutionVersionCreation(args: StopSolutionVersionCreationCommandInput, options?: __HttpHandlerOptions): Promise<StopSolutionVersionCreationCommandOutput>;
|
|
1195
434
|
stopSolutionVersionCreation(args: StopSolutionVersionCreationCommandInput, cb: (err: any, data?: StopSolutionVersionCreationCommandOutput) => void): void;
|
|
1196
435
|
stopSolutionVersionCreation(args: StopSolutionVersionCreationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopSolutionVersionCreationCommandOutput) => void): void;
|
|
1197
436
|
/**
|
|
1198
|
-
* @
|
|
1199
|
-
* <p>Add a list of tags to a resource.</p>
|
|
437
|
+
* @see {@link TagResourceCommand}
|
|
1200
438
|
*/
|
|
1201
439
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
1202
440
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1203
441
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1204
442
|
/**
|
|
1205
|
-
* @
|
|
1206
|
-
* <p>Remove <a href="https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html">tags</a> that are attached to a resource.</p>
|
|
443
|
+
* @see {@link UntagResourceCommand}
|
|
1207
444
|
*/
|
|
1208
445
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
1209
446
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1210
447
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1211
448
|
/**
|
|
1212
|
-
* @
|
|
1213
|
-
* <p>Updates a campaign by either deploying a new solution or changing the value of the
|
|
1214
|
-
* campaign's <code>minProvisionedTPS</code> parameter.</p>
|
|
1215
|
-
* <p>To update a campaign, the campaign status must be ACTIVE or CREATE FAILED.
|
|
1216
|
-
* Check the campaign status using the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html">DescribeCampaign</a> operation.</p>
|
|
1217
|
-
*
|
|
1218
|
-
* <note>
|
|
1219
|
-
* <p>You can still get recommendations from a campaign while an update is in progress.
|
|
1220
|
-
* The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is <code>Active</code>.
|
|
1221
|
-
* </p>
|
|
1222
|
-
* </note>
|
|
1223
|
-
*
|
|
1224
|
-
* <p>For more information on campaigns, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>.</p>
|
|
449
|
+
* @see {@link UpdateCampaignCommand}
|
|
1225
450
|
*/
|
|
1226
451
|
updateCampaign(args: UpdateCampaignCommandInput, options?: __HttpHandlerOptions): Promise<UpdateCampaignCommandOutput>;
|
|
1227
452
|
updateCampaign(args: UpdateCampaignCommandInput, cb: (err: any, data?: UpdateCampaignCommandOutput) => void): void;
|
|
1228
453
|
updateCampaign(args: UpdateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCampaignCommandOutput) => void): void;
|
|
1229
454
|
/**
|
|
1230
|
-
* @
|
|
1231
|
-
* <p>Updates a metric attribution.</p>
|
|
455
|
+
* @see {@link UpdateMetricAttributionCommand}
|
|
1232
456
|
*/
|
|
1233
457
|
updateMetricAttribution(args: UpdateMetricAttributionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateMetricAttributionCommandOutput>;
|
|
1234
458
|
updateMetricAttribution(args: UpdateMetricAttributionCommandInput, cb: (err: any, data?: UpdateMetricAttributionCommandOutput) => void): void;
|
|
1235
459
|
updateMetricAttribution(args: UpdateMetricAttributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMetricAttributionCommandOutput) => void): void;
|
|
1236
460
|
/**
|
|
1237
|
-
* @
|
|
1238
|
-
* <p>Updates the recommender to modify the recommender configuration.</p>
|
|
461
|
+
* @see {@link UpdateRecommenderCommand}
|
|
1239
462
|
*/
|
|
1240
463
|
updateRecommender(args: UpdateRecommenderCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRecommenderCommandOutput>;
|
|
1241
464
|
updateRecommender(args: UpdateRecommenderCommandInput, cb: (err: any, data?: UpdateRecommenderCommandOutput) => void): void;
|
|
1242
465
|
updateRecommender(args: UpdateRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRecommenderCommandOutput) => void): void;
|
|
1243
466
|
}
|
|
467
|
+
/**
|
|
468
|
+
* @public
|
|
469
|
+
* <p>Amazon Personalize is a machine learning service that makes it easy to add individualized
|
|
470
|
+
* recommendations to customers.</p>
|
|
471
|
+
*/
|
|
472
|
+
export declare class Personalize extends PersonalizeClient implements Personalize {
|
|
473
|
+
}
|