@aws-sdk/client-personalize 3.36.0 → 3.39.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (137) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/dist-cjs/Personalize.js +0 -4
  3. package/dist-cjs/PersonalizeClient.js +0 -9
  4. package/dist-cjs/commands/CreateBatchInferenceJobCommand.js +0 -25
  5. package/dist-cjs/commands/CreateCampaignCommand.js +0 -94
  6. package/dist-cjs/commands/CreateDatasetCommand.js +0 -74
  7. package/dist-cjs/commands/CreateDatasetExportJobCommand.js +0 -45
  8. package/dist-cjs/commands/CreateDatasetGroupCommand.js +0 -99
  9. package/dist-cjs/commands/CreateDatasetImportJobCommand.js +0 -65
  10. package/dist-cjs/commands/CreateEventTrackerCommand.js +0 -69
  11. package/dist-cjs/commands/CreateFilterCommand.js +0 -24
  12. package/dist-cjs/commands/CreateSchemaCommand.js +0 -49
  13. package/dist-cjs/commands/CreateSolutionCommand.js +0 -96
  14. package/dist-cjs/commands/CreateSolutionVersionCommand.js +0 -91
  15. package/dist-cjs/commands/DeleteCampaignCommand.js +0 -29
  16. package/dist-cjs/commands/DeleteDatasetCommand.js +0 -26
  17. package/dist-cjs/commands/DeleteDatasetGroupCommand.js +0 -36
  18. package/dist-cjs/commands/DeleteEventTrackerCommand.js +0 -26
  19. package/dist-cjs/commands/DeleteFilterCommand.js +0 -24
  20. package/dist-cjs/commands/DeleteSchemaCommand.js +0 -26
  21. package/dist-cjs/commands/DeleteSolutionCommand.js +0 -30
  22. package/dist-cjs/commands/DescribeAlgorithmCommand.js +0 -24
  23. package/dist-cjs/commands/DescribeBatchInferenceJobCommand.js +0 -26
  24. package/dist-cjs/commands/DescribeCampaignCommand.js +0 -36
  25. package/dist-cjs/commands/DescribeDatasetCommand.js +0 -24
  26. package/dist-cjs/commands/DescribeDatasetExportJobCommand.js +0 -25
  27. package/dist-cjs/commands/DescribeDatasetGroupCommand.js +0 -24
  28. package/dist-cjs/commands/DescribeDatasetImportJobCommand.js +0 -25
  29. package/dist-cjs/commands/DescribeEventTrackerCommand.js +0 -26
  30. package/dist-cjs/commands/DescribeFeatureTransformationCommand.js +0 -24
  31. package/dist-cjs/commands/DescribeFilterCommand.js +0 -24
  32. package/dist-cjs/commands/DescribeRecipeCommand.js +0 -42
  33. package/dist-cjs/commands/DescribeSchemaCommand.js +0 -25
  34. package/dist-cjs/commands/DescribeSolutionCommand.js +0 -25
  35. package/dist-cjs/commands/DescribeSolutionVersionCommand.js +0 -24
  36. package/dist-cjs/commands/GetSolutionMetricsCommand.js +0 -24
  37. package/dist-cjs/commands/ListBatchInferenceJobsCommand.js +0 -25
  38. package/dist-cjs/commands/ListCampaignsCommand.js +0 -27
  39. package/dist-cjs/commands/ListDatasetExportJobsCommand.js +0 -28
  40. package/dist-cjs/commands/ListDatasetGroupsCommand.js +0 -26
  41. package/dist-cjs/commands/ListDatasetImportJobsCommand.js +0 -28
  42. package/dist-cjs/commands/ListDatasetsCommand.js +0 -26
  43. package/dist-cjs/commands/ListEventTrackersCommand.js +0 -27
  44. package/dist-cjs/commands/ListFiltersCommand.js +0 -24
  45. package/dist-cjs/commands/ListRecipesCommand.js +0 -25
  46. package/dist-cjs/commands/ListSchemasCommand.js +0 -26
  47. package/dist-cjs/commands/ListSolutionVersionsCommand.js +0 -27
  48. package/dist-cjs/commands/ListSolutionsCommand.js +0 -27
  49. package/dist-cjs/commands/StopSolutionVersionCreationCommand.js +0 -37
  50. package/dist-cjs/commands/UpdateCampaignCommand.js +0 -32
  51. package/dist-cjs/commands/index.js +50 -0
  52. package/dist-cjs/endpoints.js +6 -1
  53. package/dist-cjs/index.js +4 -62
  54. package/dist-cjs/models/models_0.js +0 -429
  55. package/dist-cjs/pagination/ListBatchInferenceJobsPaginator.js +0 -10
  56. package/dist-cjs/pagination/ListCampaignsPaginator.js +0 -10
  57. package/dist-cjs/pagination/ListDatasetExportJobsPaginator.js +0 -10
  58. package/dist-cjs/pagination/ListDatasetGroupsPaginator.js +0 -10
  59. package/dist-cjs/pagination/ListDatasetImportJobsPaginator.js +0 -10
  60. package/dist-cjs/pagination/ListDatasetsPaginator.js +0 -10
  61. package/dist-cjs/pagination/ListEventTrackersPaginator.js +0 -10
  62. package/dist-cjs/pagination/ListFiltersPaginator.js +0 -10
  63. package/dist-cjs/pagination/ListRecipesPaginator.js +0 -10
  64. package/dist-cjs/pagination/ListSchemasPaginator.js +0 -10
  65. package/dist-cjs/pagination/ListSolutionVersionsPaginator.js +0 -10
  66. package/dist-cjs/pagination/ListSolutionsPaginator.js +0 -10
  67. package/dist-cjs/pagination/index.js +16 -0
  68. package/dist-cjs/protocols/Aws_json1_1.js +0 -5
  69. package/dist-cjs/runtimeConfig.browser.js +1 -5
  70. package/dist-cjs/runtimeConfig.js +1 -5
  71. package/dist-cjs/runtimeConfig.native.js +0 -3
  72. package/dist-cjs/runtimeConfig.shared.js +0 -3
  73. package/dist-es/commands/index.js +47 -0
  74. package/dist-es/endpoints.js +6 -1
  75. package/dist-es/index.js +4 -62
  76. package/dist-es/pagination/index.js +13 -0
  77. package/dist-types/commands/index.d.ts +47 -0
  78. package/dist-types/index.d.ts +4 -62
  79. package/dist-types/pagination/index.d.ts +13 -0
  80. package/dist-types/ts3.4/Personalize.d.ts +48 -728
  81. package/dist-types/ts3.4/PersonalizeClient.d.ts +24 -90
  82. package/dist-types/ts3.4/commands/CreateBatchInferenceJobCommand.d.ts +2 -21
  83. package/dist-types/ts3.4/commands/CreateCampaignCommand.d.ts +2 -90
  84. package/dist-types/ts3.4/commands/CreateDatasetCommand.d.ts +2 -70
  85. package/dist-types/ts3.4/commands/CreateDatasetExportJobCommand.d.ts +2 -41
  86. package/dist-types/ts3.4/commands/CreateDatasetGroupCommand.d.ts +2 -95
  87. package/dist-types/ts3.4/commands/CreateDatasetImportJobCommand.d.ts +2 -61
  88. package/dist-types/ts3.4/commands/CreateEventTrackerCommand.d.ts +2 -65
  89. package/dist-types/ts3.4/commands/CreateFilterCommand.d.ts +2 -20
  90. package/dist-types/ts3.4/commands/CreateSchemaCommand.d.ts +2 -45
  91. package/dist-types/ts3.4/commands/CreateSolutionCommand.d.ts +2 -92
  92. package/dist-types/ts3.4/commands/CreateSolutionVersionCommand.d.ts +2 -87
  93. package/dist-types/ts3.4/commands/DeleteCampaignCommand.d.ts +2 -25
  94. package/dist-types/ts3.4/commands/DeleteDatasetCommand.d.ts +2 -22
  95. package/dist-types/ts3.4/commands/DeleteDatasetGroupCommand.d.ts +2 -32
  96. package/dist-types/ts3.4/commands/DeleteEventTrackerCommand.d.ts +2 -22
  97. package/dist-types/ts3.4/commands/DeleteFilterCommand.d.ts +2 -20
  98. package/dist-types/ts3.4/commands/DeleteSchemaCommand.d.ts +2 -22
  99. package/dist-types/ts3.4/commands/DeleteSolutionCommand.d.ts +2 -26
  100. package/dist-types/ts3.4/commands/DescribeAlgorithmCommand.d.ts +2 -20
  101. package/dist-types/ts3.4/commands/DescribeBatchInferenceJobCommand.d.ts +2 -22
  102. package/dist-types/ts3.4/commands/DescribeCampaignCommand.d.ts +2 -32
  103. package/dist-types/ts3.4/commands/DescribeDatasetCommand.d.ts +2 -20
  104. package/dist-types/ts3.4/commands/DescribeDatasetExportJobCommand.d.ts +2 -21
  105. package/dist-types/ts3.4/commands/DescribeDatasetGroupCommand.d.ts +2 -20
  106. package/dist-types/ts3.4/commands/DescribeDatasetImportJobCommand.d.ts +2 -21
  107. package/dist-types/ts3.4/commands/DescribeEventTrackerCommand.d.ts +2 -22
  108. package/dist-types/ts3.4/commands/DescribeFeatureTransformationCommand.d.ts +2 -20
  109. package/dist-types/ts3.4/commands/DescribeFilterCommand.d.ts +2 -20
  110. package/dist-types/ts3.4/commands/DescribeRecipeCommand.d.ts +2 -38
  111. package/dist-types/ts3.4/commands/DescribeSchemaCommand.d.ts +2 -21
  112. package/dist-types/ts3.4/commands/DescribeSolutionCommand.d.ts +2 -21
  113. package/dist-types/ts3.4/commands/DescribeSolutionVersionCommand.d.ts +2 -20
  114. package/dist-types/ts3.4/commands/GetSolutionMetricsCommand.d.ts +2 -20
  115. package/dist-types/ts3.4/commands/ListBatchInferenceJobsCommand.d.ts +2 -21
  116. package/dist-types/ts3.4/commands/ListCampaignsCommand.d.ts +2 -23
  117. package/dist-types/ts3.4/commands/ListDatasetExportJobsCommand.d.ts +2 -24
  118. package/dist-types/ts3.4/commands/ListDatasetGroupsCommand.d.ts +2 -22
  119. package/dist-types/ts3.4/commands/ListDatasetImportJobsCommand.d.ts +2 -24
  120. package/dist-types/ts3.4/commands/ListDatasetsCommand.d.ts +2 -22
  121. package/dist-types/ts3.4/commands/ListEventTrackersCommand.d.ts +2 -23
  122. package/dist-types/ts3.4/commands/ListFiltersCommand.d.ts +2 -20
  123. package/dist-types/ts3.4/commands/ListRecipesCommand.d.ts +2 -21
  124. package/dist-types/ts3.4/commands/ListSchemasCommand.d.ts +2 -22
  125. package/dist-types/ts3.4/commands/ListSolutionVersionsCommand.d.ts +2 -23
  126. package/dist-types/ts3.4/commands/ListSolutionsCommand.d.ts +2 -23
  127. package/dist-types/ts3.4/commands/StopSolutionVersionCreationCommand.d.ts +2 -33
  128. package/dist-types/ts3.4/commands/UpdateCampaignCommand.d.ts +2 -28
  129. package/dist-types/ts3.4/commands/index.d.ts +47 -0
  130. package/dist-types/ts3.4/index.d.ts +4 -62
  131. package/dist-types/ts3.4/models/models_0.d.ts +620 -2318
  132. package/dist-types/ts3.4/pagination/index.d.ts +13 -0
  133. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  134. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  135. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  136. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  137. package/package.json +32 -32
@@ -47,873 +47,193 @@ import { ListSolutionVersionsCommandInput, ListSolutionVersionsCommandOutput } f
47
47
  import { StopSolutionVersionCreationCommandInput, StopSolutionVersionCreationCommandOutput } from "./commands/StopSolutionVersionCreationCommand";
48
48
  import { UpdateCampaignCommandInput, UpdateCampaignCommandOutput } from "./commands/UpdateCampaignCommand";
49
49
  import { PersonalizeClient } from "./PersonalizeClient";
50
- /**
51
- * <p>Amazon Personalize is a machine learning service that makes it easy to add individualized
52
- * recommendations to customers.</p>
53
- */
50
+
54
51
  export declare class Personalize extends PersonalizeClient {
55
- /**
56
- * <p>Creates a batch inference job. The operation can handle up to 50 million records and the
57
- * input file must be in JSON format. For more information, see <a>recommendations-batch</a>.</p>
58
- */
52
+
59
53
  createBatchInferenceJob(args: CreateBatchInferenceJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateBatchInferenceJobCommandOutput>;
60
54
  createBatchInferenceJob(args: CreateBatchInferenceJobCommandInput, cb: (err: any, data?: CreateBatchInferenceJobCommandOutput) => void): void;
61
55
  createBatchInferenceJob(args: CreateBatchInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBatchInferenceJobCommandOutput) => void): void;
62
- /**
63
- * <p>Creates a campaign by deploying a solution version. When a client calls the
64
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
65
- * and
66
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html">GetPersonalizedRanking</a>
67
- * APIs, a campaign is specified in the request.</p>
68
- *
69
- * <p>
70
- * <b>Minimum Provisioned TPS and Auto-Scaling</b>
71
- * </p>
72
- *
73
- * <p>A transaction is a single <code>GetRecommendations</code> or
74
- * <code>GetPersonalizedRanking</code> call. Transactions per second (TPS) is the throughput
75
- * and unit of billing for Amazon Personalize. The minimum provisioned TPS
76
- * (<code>minProvisionedTPS</code>) specifies the baseline throughput provisioned by
77
- * Amazon Personalize, and thus, the minimum billing charge.
78
- * </p>
79
- * <p>
80
- * If your TPS increases beyond
81
- * <code>minProvisionedTPS</code>, Amazon Personalize auto-scales the provisioned capacity up and down,
82
- * but never below <code>minProvisionedTPS</code>.
83
- * There's a short time delay while the capacity is increased that might cause loss of
84
- * transactions.</p>
85
- * <p>The actual TPS used is calculated as the average requests/second within a 5-minute window.
86
- * You pay for maximum of either the minimum provisioned TPS or the actual TPS.
87
- * We recommend starting with a low <code>minProvisionedTPS</code>, track
88
- * your usage using Amazon CloudWatch metrics, and then increase the <code>minProvisionedTPS</code>
89
- * as necessary.</p>
90
- *
91
- * <p>
92
- * <b>Status</b>
93
- * </p>
94
- * <p>A campaign can be in one of the following states:</p>
95
- * <ul>
96
- * <li>
97
- * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
98
- * </li>
99
- * <li>
100
- * <p>DELETE PENDING > DELETE IN_PROGRESS</p>
101
- * </li>
102
- * </ul>
103
- * <p>To get the campaign status, call <a>DescribeCampaign</a>.</p>
104
- * <note>
105
- * <p>Wait until the <code>status</code> of the campaign
106
- * is <code>ACTIVE</code> before asking the campaign for recommendations.</p>
107
- * </note>
108
- *
109
- * <p class="title">
110
- * <b>Related APIs</b>
111
- * </p>
112
- * <ul>
113
- * <li>
114
- * <p>
115
- * <a>ListCampaigns</a>
116
- * </p>
117
- * </li>
118
- * <li>
119
- * <p>
120
- * <a>DescribeCampaign</a>
121
- * </p>
122
- * </li>
123
- * <li>
124
- * <p>
125
- * <a>UpdateCampaign</a>
126
- * </p>
127
- * </li>
128
- * <li>
129
- * <p>
130
- * <a>DeleteCampaign</a>
131
- * </p>
132
- * </li>
133
- * </ul>
134
- */
56
+
135
57
  createCampaign(args: CreateCampaignCommandInput, options?: __HttpHandlerOptions): Promise<CreateCampaignCommandOutput>;
136
58
  createCampaign(args: CreateCampaignCommandInput, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void;
137
59
  createCampaign(args: CreateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void;
138
- /**
139
- * <p>Creates an empty dataset and adds it to the specified dataset group. Use <a>CreateDatasetImportJob</a> to import your training data to a dataset.</p>
140
- * <p>There are three types of datasets:</p>
141
- * <ul>
142
- * <li>
143
- * <p>Interactions</p>
144
- * </li>
145
- * <li>
146
- * <p>Items</p>
147
- * </li>
148
- * <li>
149
- * <p>Users</p>
150
- * </li>
151
- * </ul>
152
- * <p>Each dataset type has an associated schema with required field types. Only the
153
- * <code>Interactions</code> dataset is required in order to train a model (also referred to as
154
- * creating a solution).</p>
155
- * <p>A dataset can be in one of the following states:</p>
156
- * <ul>
157
- * <li>
158
- * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
159
- * </li>
160
- * <li>
161
- * <p>DELETE PENDING > DELETE IN_PROGRESS</p>
162
- * </li>
163
- * </ul>
164
- * <p>To get the status of the dataset, call <a>DescribeDataset</a>.</p>
165
- * <p class="title">
166
- * <b>Related APIs</b>
167
- * </p>
168
- * <ul>
169
- * <li>
170
- * <p>
171
- * <a>CreateDatasetGroup</a>
172
- * </p>
173
- * </li>
174
- * <li>
175
- * <p>
176
- * <a>ListDatasets</a>
177
- * </p>
178
- * </li>
179
- * <li>
180
- * <p>
181
- * <a>DescribeDataset</a>
182
- * </p>
183
- * </li>
184
- * <li>
185
- * <p>
186
- * <a>DeleteDataset</a>
187
- * </p>
188
- * </li>
189
- * </ul>
190
- */
60
+
191
61
  createDataset(args: CreateDatasetCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetCommandOutput>;
192
62
  createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
193
63
  createDataset(args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
194
- /**
195
- * <p>
196
- * Creates a job that exports data from your dataset to an Amazon S3 bucket.
197
- * To allow Amazon Personalize to export the training data, you must specify an
198
- * service-linked IAM role that gives Amazon Personalize <code>PutObject</code> permissions for your Amazon S3 bucket.
199
- * For information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/export-data.html">Exporting a dataset</a>
200
- * in the Amazon Personalize developer guide.
201
- * </p>
202
- * <p>
203
- * <b>Status</b>
204
- * </p>
205
- * <p>A dataset export job can be in one of the following states:</p>
206
- * <ul>
207
- * <li>
208
- * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
209
- * </li>
210
- * </ul>
211
- * <p>
212
- * To get the status of the export job, call <a>DescribeDatasetExportJob</a>,
213
- * and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is
214
- * complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response
215
- * includes a <code>failureReason</code> key, which describes why the job failed.
216
- * </p>
217
- */
64
+
218
65
  createDatasetExportJob(args: CreateDatasetExportJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetExportJobCommandOutput>;
219
66
  createDatasetExportJob(args: CreateDatasetExportJobCommandInput, cb: (err: any, data?: CreateDatasetExportJobCommandOutput) => void): void;
220
67
  createDatasetExportJob(args: CreateDatasetExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetExportJobCommandOutput) => void): void;
221
- /**
222
- * <p>Creates an empty dataset group. A dataset group contains related datasets that supply data
223
- * for training a model. A dataset group can contain at most three datasets, one for each type of
224
- * dataset:</p>
225
- * <ul>
226
- * <li>
227
- * <p>Interactions</p>
228
- * </li>
229
- * <li>
230
- * <p>Items</p>
231
- * </li>
232
- * <li>
233
- * <p>Users</p>
234
- * </li>
235
- * </ul>
236
- * <p>To train a model (create a solution), a dataset group that contains an
237
- * <code>Interactions</code> dataset is required. Call <a>CreateDataset</a> to add a
238
- * dataset to the group.</p>
239
- * <p>A dataset group can be in one of the following states:</p>
240
- * <ul>
241
- * <li>
242
- * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
243
- * </li>
244
- * <li>
245
- * <p>DELETE PENDING</p>
246
- * </li>
247
- * </ul>
248
- * <p>To get the status of the dataset group, call <a>DescribeDatasetGroup</a>. If
249
- * the status shows as CREATE FAILED, the response includes a <code>failureReason</code> key,
250
- * which describes why the creation failed.</p>
251
- * <note>
252
- * <p>You must wait until the <code>status</code> of the dataset group is <code>ACTIVE</code>
253
- * before adding a dataset to the group.</p>
254
- * </note>
255
- * <p>You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you
256
- * specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to
257
- * access the key.</p>
258
- * <p class="title">
259
- * <b>APIs that require a dataset group ARN in the request</b>
260
- * </p>
261
- * <ul>
262
- * <li>
263
- * <p>
264
- * <a>CreateDataset</a>
265
- * </p>
266
- * </li>
267
- * <li>
268
- * <p>
269
- * <a>CreateEventTracker</a>
270
- * </p>
271
- * </li>
272
- * <li>
273
- * <p>
274
- * <a>CreateSolution</a>
275
- * </p>
276
- * </li>
277
- * </ul>
278
- * <p class="title">
279
- * <b>Related APIs</b>
280
- * </p>
281
- * <ul>
282
- * <li>
283
- * <p>
284
- * <a>ListDatasetGroups</a>
285
- * </p>
286
- * </li>
287
- * <li>
288
- * <p>
289
- * <a>DescribeDatasetGroup</a>
290
- * </p>
291
- * </li>
292
- * <li>
293
- * <p>
294
- * <a>DeleteDatasetGroup</a>
295
- * </p>
296
- * </li>
297
- * </ul>
298
- */
68
+
299
69
  createDatasetGroup(args: CreateDatasetGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetGroupCommandOutput>;
300
70
  createDatasetGroup(args: CreateDatasetGroupCommandInput, cb: (err: any, data?: CreateDatasetGroupCommandOutput) => void): void;
301
71
  createDatasetGroup(args: CreateDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetGroupCommandOutput) => void): void;
302
- /**
303
- * <p>Creates a job that imports training data from your data source (an Amazon S3 bucket) to an
304
- * Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an
305
- * IAM service role that has permission to read from the data source, as Amazon Personalize makes a
306
- * copy of your data and processes it internally. For information on granting access
307
- * to your Amazon S3 bucket, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html">Giving Amazon Personalize
308
- * Access to Amazon S3 Resources</a>. </p>
309
- * <important>
310
- * <p>The dataset import job replaces any existing data in the dataset that you imported in bulk.</p>
311
- * </important>
312
- * <p>
313
- * <b>Status</b>
314
- * </p>
315
- * <p>A dataset import job can be in one of the following states:</p>
316
- * <ul>
317
- * <li>
318
- * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
319
- * </li>
320
- * </ul>
321
- * <p>To get the status of the import job, call <a>DescribeDatasetImportJob</a>,
322
- * providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is
323
- * complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response
324
- * includes a <code>failureReason</code> key, which describes why the job failed.</p>
325
- * <note>
326
- * <p>Importing takes time. You must wait until the status shows as ACTIVE before training a
327
- * model using the dataset.</p>
328
- * </note>
329
- *
330
- * <p class="title">
331
- * <b>Related APIs</b>
332
- * </p>
333
- * <ul>
334
- * <li>
335
- * <p>
336
- * <a>ListDatasetImportJobs</a>
337
- * </p>
338
- * </li>
339
- * <li>
340
- * <p>
341
- * <a>DescribeDatasetImportJob</a>
342
- * </p>
343
- * </li>
344
- * </ul>
345
- */
72
+
346
73
  createDatasetImportJob(args: CreateDatasetImportJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetImportJobCommandOutput>;
347
74
  createDatasetImportJob(args: CreateDatasetImportJobCommandInput, cb: (err: any, data?: CreateDatasetImportJobCommandOutput) => void): void;
348
75
  createDatasetImportJob(args: CreateDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetImportJobCommandOutput) => void): void;
349
- /**
350
- * <p>Creates an event tracker that you use when adding event data to a specified dataset
351
- * group using the
352
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html">PutEvents</a> API.</p>
353
- * <note>
354
- * <p>Only one event tracker can be associated with a dataset group. You will get
355
- * an error if you call <code>CreateEventTracker</code> using the same dataset group as an
356
- * existing event tracker.</p>
357
- * </note>
358
- * <p>When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the
359
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html">PutEvents</a> operation.
360
- * Amazon Personalize then appends the event data to the Interactions dataset of the dataset group you specify
361
- * in your event tracker.
362
- * </p>
363
- * <p>The event tracker can be in one of the following states:</p>
364
- * <ul>
365
- * <li>
366
- * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
367
- * </li>
368
- * <li>
369
- * <p>DELETE PENDING > DELETE IN_PROGRESS</p>
370
- * </li>
371
- * </ul>
372
- * <p>To get the status of the event tracker, call <a>DescribeEventTracker</a>.</p>
373
- * <note>
374
- * <p>The event tracker must be in the ACTIVE state before using the tracking ID.</p>
375
- * </note>
376
- * <p class="title">
377
- * <b>Related APIs</b>
378
- * </p>
379
- * <ul>
380
- * <li>
381
- * <p>
382
- * <a>ListEventTrackers</a>
383
- * </p>
384
- * </li>
385
- * <li>
386
- * <p>
387
- * <a>DescribeEventTracker</a>
388
- * </p>
389
- * </li>
390
- * <li>
391
- * <p>
392
- * <a>DeleteEventTracker</a>
393
- * </p>
394
- * </li>
395
- * </ul>
396
- */
76
+
397
77
  createEventTracker(args: CreateEventTrackerCommandInput, options?: __HttpHandlerOptions): Promise<CreateEventTrackerCommandOutput>;
398
78
  createEventTracker(args: CreateEventTrackerCommandInput, cb: (err: any, data?: CreateEventTrackerCommandOutput) => void): void;
399
79
  createEventTracker(args: CreateEventTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventTrackerCommandOutput) => void): void;
400
- /**
401
- * <p>Creates a recommendation filter. For more information, see <a>filter</a>.</p>
402
- */
80
+
403
81
  createFilter(args: CreateFilterCommandInput, options?: __HttpHandlerOptions): Promise<CreateFilterCommandOutput>;
404
82
  createFilter(args: CreateFilterCommandInput, cb: (err: any, data?: CreateFilterCommandOutput) => void): void;
405
83
  createFilter(args: CreateFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFilterCommandOutput) => void): void;
406
- /**
407
- * <p>Creates an Amazon Personalize schema from the specified schema string. The schema you create
408
- * must be in Avro JSON format.</p>
409
- * <p>Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset
410
- * type and has a set of required field and keywords.
411
- * You specify a schema when you call <a>CreateDataset</a>.</p>
412
- *
413
- * <p class="title">
414
- * <b>Related APIs</b>
415
- * </p>
416
- * <ul>
417
- * <li>
418
- * <p>
419
- * <a>ListSchemas</a>
420
- * </p>
421
- * </li>
422
- * <li>
423
- * <p>
424
- * <a>DescribeSchema</a>
425
- * </p>
426
- * </li>
427
- * <li>
428
- * <p>
429
- * <a>DeleteSchema</a>
430
- * </p>
431
- * </li>
432
- * </ul>
433
- */
84
+
434
85
  createSchema(args: CreateSchemaCommandInput, options?: __HttpHandlerOptions): Promise<CreateSchemaCommandOutput>;
435
86
  createSchema(args: CreateSchemaCommandInput, cb: (err: any, data?: CreateSchemaCommandOutput) => void): void;
436
87
  createSchema(args: CreateSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSchemaCommandOutput) => void): void;
437
- /**
438
- * <p>Creates the configuration for training a model. A trained model is known as
439
- * a solution. After the configuration is created, you train the model (create a solution)
440
- * by calling the <a>CreateSolutionVersion</a> operation. Every time you call
441
- * <code>CreateSolutionVersion</code>, a new version of the solution is created.</p>
442
- * <p>After creating a solution version, you check its accuracy by calling
443
- * <a>GetSolutionMetrics</a>. When you are satisfied with the version, you
444
- * deploy it using <a>CreateCampaign</a>. The campaign provides recommendations
445
- * to a client through the
446
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a> API.</p>
447
- * <p>To train a model, Amazon Personalize requires training data and a recipe. The training data
448
- * comes from the dataset group that you provide in the request. A recipe specifies
449
- * the training algorithm and a feature transformation. You can specify one of the predefined
450
- * recipes provided by Amazon Personalize. Alternatively, you can specify
451
- * <code>performAutoML</code> and Amazon Personalize will analyze your data and select the
452
- * optimum USER_PERSONALIZATION recipe for you.</p>
453
- * <note>
454
- * <p>Amazon Personalize doesn't support configuring the <code>hpoObjective</code>
455
- * for solution hyperparameter optimization at this time.</p>
456
- * </note>
457
- * <p>
458
- * <b>Status</b>
459
- * </p>
460
- * <p>A solution can be in one of the following states:</p>
461
- * <ul>
462
- * <li>
463
- * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
464
- * </li>
465
- * <li>
466
- * <p>DELETE PENDING > DELETE IN_PROGRESS</p>
467
- * </li>
468
- * </ul>
469
- * <p>To get the status of the solution, call <a>DescribeSolution</a>. Wait
470
- * until the status shows as ACTIVE before calling <code>CreateSolutionVersion</code>.</p>
471
- *
472
- *
473
- *
474
- * <p class="title">
475
- * <b>Related APIs</b>
476
- * </p>
477
- * <ul>
478
- * <li>
479
- * <p>
480
- * <a>ListSolutions</a>
481
- * </p>
482
- * </li>
483
- * <li>
484
- * <p>
485
- * <a>CreateSolutionVersion</a>
486
- * </p>
487
- * </li>
488
- * <li>
489
- * <p>
490
- * <a>DescribeSolution</a>
491
- * </p>
492
- * </li>
493
- * <li>
494
- * <p>
495
- * <a>DeleteSolution</a>
496
- * </p>
497
- * </li>
498
- * </ul>
499
- * <ul>
500
- * <li>
501
- * <p>
502
- * <a>ListSolutionVersions</a>
503
- * </p>
504
- * </li>
505
- * <li>
506
- * <p>
507
- * <a>DescribeSolutionVersion</a>
508
- * </p>
509
- * </li>
510
- * </ul>
511
- */
88
+
512
89
  createSolution(args: CreateSolutionCommandInput, options?: __HttpHandlerOptions): Promise<CreateSolutionCommandOutput>;
513
90
  createSolution(args: CreateSolutionCommandInput, cb: (err: any, data?: CreateSolutionCommandOutput) => void): void;
514
91
  createSolution(args: CreateSolutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSolutionCommandOutput) => void): void;
515
- /**
516
- * <p>Trains or retrains an active solution. A solution is created using the <a>CreateSolution</a> operation and must be in the ACTIVE state before calling
517
- * <code>CreateSolutionVersion</code>. A new version of the solution is created every time you
518
- * call this operation.</p>
519
- * <p>
520
- * <b>Status</b>
521
- * </p>
522
- * <p>A solution version can be in one of the following states:</p>
523
- * <ul>
524
- * <li>
525
- * <p>CREATE PENDING</p>
526
- * </li>
527
- * <li>
528
- * <p>CREATE IN_PROGRESS</p>
529
- * </li>
530
- * <li>
531
- * <p>ACTIVE</p>
532
- * </li>
533
- * <li>
534
- * <p>CREATE FAILED</p>
535
- * </li>
536
- * <li>
537
- * <p>CREATE STOPPING</p>
538
- * </li>
539
- * <li>
540
- * <p>CREATE STOPPED</p>
541
- * </li>
542
- * </ul>
543
- * <p>To get the status of the version, call <a>DescribeSolutionVersion</a>. Wait
544
- * until the status shows as ACTIVE before calling <code>CreateCampaign</code>.</p>
545
- * <p>If the status shows as CREATE FAILED, the response includes a <code>failureReason</code>
546
- * key, which describes why the job failed.</p>
547
- * <p class="title">
548
- * <b>Related APIs</b>
549
- * </p>
550
- * <ul>
551
- * <li>
552
- * <p>
553
- * <a>ListSolutionVersions</a>
554
- * </p>
555
- * </li>
556
- * <li>
557
- * <p>
558
- * <a>DescribeSolutionVersion</a>
559
- * </p>
560
- * </li>
561
- * </ul>
562
- * <ul>
563
- * <li>
564
- * <p>
565
- * <a>ListSolutions</a>
566
- * </p>
567
- * </li>
568
- * <li>
569
- * <p>
570
- * <a>CreateSolution</a>
571
- * </p>
572
- * </li>
573
- * <li>
574
- * <p>
575
- * <a>DescribeSolution</a>
576
- * </p>
577
- * </li>
578
- * <li>
579
- * <p>
580
- * <a>DeleteSolution</a>
581
- * </p>
582
- * </li>
583
- * </ul>
584
- */
92
+
585
93
  createSolutionVersion(args: CreateSolutionVersionCommandInput, options?: __HttpHandlerOptions): Promise<CreateSolutionVersionCommandOutput>;
586
94
  createSolutionVersion(args: CreateSolutionVersionCommandInput, cb: (err: any, data?: CreateSolutionVersionCommandOutput) => void): void;
587
95
  createSolutionVersion(args: CreateSolutionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSolutionVersionCommandOutput) => void): void;
588
- /**
589
- * <p>Removes a campaign by deleting the solution deployment. The solution that
590
- * the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no
591
- * longer be specified in a
592
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
593
- * request.
594
- * For more information on campaigns, see <a>CreateCampaign</a>.</p>
595
- */
96
+
596
97
  deleteCampaign(args: DeleteCampaignCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCampaignCommandOutput>;
597
98
  deleteCampaign(args: DeleteCampaignCommandInput, cb: (err: any, data?: DeleteCampaignCommandOutput) => void): void;
598
99
  deleteCampaign(args: DeleteCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCampaignCommandOutput) => void): void;
599
- /**
600
- * <p>Deletes a dataset. You can't delete a dataset if an associated
601
- * <code>DatasetImportJob</code> or <code>SolutionVersion</code> is in the CREATE PENDING or IN
602
- * PROGRESS state. For more information on datasets, see <a>CreateDataset</a>.</p>
603
- */
100
+
604
101
  deleteDataset(args: DeleteDatasetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatasetCommandOutput>;
605
102
  deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
606
103
  deleteDataset(args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
607
- /**
608
- * <p>Deletes a dataset group. Before you delete a dataset group, you must delete the
609
- * following:</p>
610
- * <ul>
611
- * <li>
612
- * <p>All associated event trackers.</p>
613
- * </li>
614
- * <li>
615
- * <p>All associated solutions.</p>
616
- * </li>
617
- * <li>
618
- * <p>All datasets in the dataset group.</p>
619
- * </li>
620
- * </ul>
621
- */
104
+
622
105
  deleteDatasetGroup(args: DeleteDatasetGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatasetGroupCommandOutput>;
623
106
  deleteDatasetGroup(args: DeleteDatasetGroupCommandInput, cb: (err: any, data?: DeleteDatasetGroupCommandOutput) => void): void;
624
107
  deleteDatasetGroup(args: DeleteDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetGroupCommandOutput) => void): void;
625
- /**
626
- * <p>Deletes the event tracker. Does not delete the event-interactions dataset from
627
- * the associated dataset group. For more
628
- * information on event trackers, see <a>CreateEventTracker</a>.</p>
629
- */
108
+
630
109
  deleteEventTracker(args: DeleteEventTrackerCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEventTrackerCommandOutput>;
631
110
  deleteEventTracker(args: DeleteEventTrackerCommandInput, cb: (err: any, data?: DeleteEventTrackerCommandOutput) => void): void;
632
111
  deleteEventTracker(args: DeleteEventTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventTrackerCommandOutput) => void): void;
633
- /**
634
- * <p>Deletes a filter.</p>
635
- */
112
+
636
113
  deleteFilter(args: DeleteFilterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteFilterCommandOutput>;
637
114
  deleteFilter(args: DeleteFilterCommandInput, cb: (err: any, data?: DeleteFilterCommandOutput) => void): void;
638
115
  deleteFilter(args: DeleteFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFilterCommandOutput) => void): void;
639
- /**
640
- * <p>Deletes a schema. Before deleting a schema, you must delete all
641
- * datasets referencing the schema. For more information on schemas, see
642
- * <a>CreateSchema</a>.</p>
643
- */
116
+
644
117
  deleteSchema(args: DeleteSchemaCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSchemaCommandOutput>;
645
118
  deleteSchema(args: DeleteSchemaCommandInput, cb: (err: any, data?: DeleteSchemaCommandOutput) => void): void;
646
119
  deleteSchema(args: DeleteSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSchemaCommandOutput) => void): void;
647
- /**
648
- * <p>Deletes all versions of a solution and the <code>Solution</code> object itself.
649
- * Before deleting a solution, you must delete all campaigns based on
650
- * the solution. To determine what campaigns are using the solution, call
651
- * <a>ListCampaigns</a> and supply the Amazon Resource Name (ARN) of the solution.
652
- * You can't delete a solution if an associated <code>SolutionVersion</code> is in the
653
- * CREATE PENDING or IN PROGRESS state.
654
- * For more information on solutions, see <a>CreateSolution</a>.</p>
655
- */
120
+
656
121
  deleteSolution(args: DeleteSolutionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSolutionCommandOutput>;
657
122
  deleteSolution(args: DeleteSolutionCommandInput, cb: (err: any, data?: DeleteSolutionCommandOutput) => void): void;
658
123
  deleteSolution(args: DeleteSolutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSolutionCommandOutput) => void): void;
659
- /**
660
- * <p>Describes the given algorithm.</p>
661
- */
124
+
662
125
  describeAlgorithm(args: DescribeAlgorithmCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAlgorithmCommandOutput>;
663
126
  describeAlgorithm(args: DescribeAlgorithmCommandInput, cb: (err: any, data?: DescribeAlgorithmCommandOutput) => void): void;
664
127
  describeAlgorithm(args: DescribeAlgorithmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAlgorithmCommandOutput) => void): void;
665
- /**
666
- * <p>Gets the properties of a batch inference job including name, Amazon Resource Name (ARN),
667
- * status, input and output configurations, and the ARN of the solution version used to generate
668
- * the recommendations.</p>
669
- */
128
+
670
129
  describeBatchInferenceJob(args: DescribeBatchInferenceJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBatchInferenceJobCommandOutput>;
671
130
  describeBatchInferenceJob(args: DescribeBatchInferenceJobCommandInput, cb: (err: any, data?: DescribeBatchInferenceJobCommandOutput) => void): void;
672
131
  describeBatchInferenceJob(args: DescribeBatchInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBatchInferenceJobCommandOutput) => void): void;
673
- /**
674
- * <p>Describes the given campaign, including its status.</p>
675
- * <p>A campaign can be in one of the following states:</p>
676
- * <ul>
677
- * <li>
678
- * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
679
- * </li>
680
- * <li>
681
- * <p>DELETE PENDING > DELETE IN_PROGRESS</p>
682
- * </li>
683
- * </ul>
684
- * <p>When the <code>status</code> is <code>CREATE FAILED</code>, the response includes the
685
- * <code>failureReason</code> key, which describes why.</p>
686
- * <p>For more information on campaigns, see <a>CreateCampaign</a>.</p>
687
- */
132
+
688
133
  describeCampaign(args: DescribeCampaignCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCampaignCommandOutput>;
689
134
  describeCampaign(args: DescribeCampaignCommandInput, cb: (err: any, data?: DescribeCampaignCommandOutput) => void): void;
690
135
  describeCampaign(args: DescribeCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCampaignCommandOutput) => void): void;
691
- /**
692
- * <p>Describes the given dataset. For more information on datasets, see <a>CreateDataset</a>.</p>
693
- */
136
+
694
137
  describeDataset(args: DescribeDatasetCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetCommandOutput>;
695
138
  describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
696
139
  describeDataset(args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
697
- /**
698
- * <p>Describes the dataset export job created by <a>CreateDatasetExportJob</a>,
699
- * including the export job status.</p>
700
- */
140
+
701
141
  describeDatasetExportJob(args: DescribeDatasetExportJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetExportJobCommandOutput>;
702
142
  describeDatasetExportJob(args: DescribeDatasetExportJobCommandInput, cb: (err: any, data?: DescribeDatasetExportJobCommandOutput) => void): void;
703
143
  describeDatasetExportJob(args: DescribeDatasetExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetExportJobCommandOutput) => void): void;
704
- /**
705
- * <p>Describes the given dataset group. For more information on dataset groups, see <a>CreateDatasetGroup</a>.</p>
706
- */
144
+
707
145
  describeDatasetGroup(args: DescribeDatasetGroupCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetGroupCommandOutput>;
708
146
  describeDatasetGroup(args: DescribeDatasetGroupCommandInput, cb: (err: any, data?: DescribeDatasetGroupCommandOutput) => void): void;
709
147
  describeDatasetGroup(args: DescribeDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetGroupCommandOutput) => void): void;
710
- /**
711
- * <p>Describes the dataset import job created by <a>CreateDatasetImportJob</a>,
712
- * including the import job status.</p>
713
- */
148
+
714
149
  describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetImportJobCommandOutput>;
715
150
  describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, cb: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void): void;
716
151
  describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void): void;
717
- /**
718
- * <p>Describes an event tracker. The response includes the <code>trackingId</code> and
719
- * <code>status</code> of the event tracker.
720
- * For more information on event trackers, see <a>CreateEventTracker</a>.</p>
721
- */
152
+
722
153
  describeEventTracker(args: DescribeEventTrackerCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventTrackerCommandOutput>;
723
154
  describeEventTracker(args: DescribeEventTrackerCommandInput, cb: (err: any, data?: DescribeEventTrackerCommandOutput) => void): void;
724
155
  describeEventTracker(args: DescribeEventTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventTrackerCommandOutput) => void): void;
725
- /**
726
- * <p>Describes the given feature transformation.</p>
727
- */
156
+
728
157
  describeFeatureTransformation(args: DescribeFeatureTransformationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFeatureTransformationCommandOutput>;
729
158
  describeFeatureTransformation(args: DescribeFeatureTransformationCommandInput, cb: (err: any, data?: DescribeFeatureTransformationCommandOutput) => void): void;
730
159
  describeFeatureTransformation(args: DescribeFeatureTransformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFeatureTransformationCommandOutput) => void): void;
731
- /**
732
- * <p>Describes a filter's properties.</p>
733
- */
160
+
734
161
  describeFilter(args: DescribeFilterCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFilterCommandOutput>;
735
162
  describeFilter(args: DescribeFilterCommandInput, cb: (err: any, data?: DescribeFilterCommandOutput) => void): void;
736
163
  describeFilter(args: DescribeFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFilterCommandOutput) => void): void;
737
- /**
738
- * <p>Describes a recipe.</p>
739
- * <p>A recipe contains three items:</p>
740
- * <ul>
741
- * <li>
742
- * <p>An algorithm that trains a model.</p>
743
- * </li>
744
- * <li>
745
- * <p>Hyperparameters that govern the training.</p>
746
- * </li>
747
- * <li>
748
- * <p>Feature transformation information for modifying the input data before training.</p>
749
- * </li>
750
- * </ul>
751
- * <p>Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a
752
- * solution with the <a>CreateSolution</a> API.
753
- * <code>CreateSolution</code> trains a model by using the algorithm
754
- * in the specified recipe and a training dataset. The solution, when deployed as a campaign,
755
- * can provide recommendations using the
756
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a> API.</p>
757
- */
164
+
758
165
  describeRecipe(args: DescribeRecipeCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRecipeCommandOutput>;
759
166
  describeRecipe(args: DescribeRecipeCommandInput, cb: (err: any, data?: DescribeRecipeCommandOutput) => void): void;
760
167
  describeRecipe(args: DescribeRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecipeCommandOutput) => void): void;
761
- /**
762
- * <p>Describes a schema. For more information on schemas, see
763
- * <a>CreateSchema</a>.</p>
764
- */
168
+
765
169
  describeSchema(args: DescribeSchemaCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSchemaCommandOutput>;
766
170
  describeSchema(args: DescribeSchemaCommandInput, cb: (err: any, data?: DescribeSchemaCommandOutput) => void): void;
767
171
  describeSchema(args: DescribeSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSchemaCommandOutput) => void): void;
768
- /**
769
- * <p>Describes a solution.
770
- * For more information on solutions, see <a>CreateSolution</a>.</p>
771
- */
172
+
772
173
  describeSolution(args: DescribeSolutionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSolutionCommandOutput>;
773
174
  describeSolution(args: DescribeSolutionCommandInput, cb: (err: any, data?: DescribeSolutionCommandOutput) => void): void;
774
175
  describeSolution(args: DescribeSolutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSolutionCommandOutput) => void): void;
775
- /**
776
- * <p>Describes a specific version of a solution. For more information on solutions, see <a>CreateSolution</a>.</p>
777
- */
176
+
778
177
  describeSolutionVersion(args: DescribeSolutionVersionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSolutionVersionCommandOutput>;
779
178
  describeSolutionVersion(args: DescribeSolutionVersionCommandInput, cb: (err: any, data?: DescribeSolutionVersionCommandOutput) => void): void;
780
179
  describeSolutionVersion(args: DescribeSolutionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSolutionVersionCommandOutput) => void): void;
781
- /**
782
- * <p>Gets the metrics for the specified solution version.</p>
783
- */
180
+
784
181
  getSolutionMetrics(args: GetSolutionMetricsCommandInput, options?: __HttpHandlerOptions): Promise<GetSolutionMetricsCommandOutput>;
785
182
  getSolutionMetrics(args: GetSolutionMetricsCommandInput, cb: (err: any, data?: GetSolutionMetricsCommandOutput) => void): void;
786
183
  getSolutionMetrics(args: GetSolutionMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSolutionMetricsCommandOutput) => void): void;
787
- /**
788
- * <p>Gets a list of the batch inference jobs that have been performed off of a solution
789
- * version.</p>
790
- */
184
+
791
185
  listBatchInferenceJobs(args: ListBatchInferenceJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListBatchInferenceJobsCommandOutput>;
792
186
  listBatchInferenceJobs(args: ListBatchInferenceJobsCommandInput, cb: (err: any, data?: ListBatchInferenceJobsCommandOutput) => void): void;
793
187
  listBatchInferenceJobs(args: ListBatchInferenceJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBatchInferenceJobsCommandOutput) => void): void;
794
- /**
795
- * <p>Returns a list of campaigns that use the given solution.
796
- * When a solution is not specified, all the campaigns associated with the account are listed.
797
- * The response provides the properties for each campaign, including the Amazon Resource Name (ARN).
798
- * For more information on campaigns, see <a>CreateCampaign</a>.</p>
799
- */
188
+
800
189
  listCampaigns(args: ListCampaignsCommandInput, options?: __HttpHandlerOptions): Promise<ListCampaignsCommandOutput>;
801
190
  listCampaigns(args: ListCampaignsCommandInput, cb: (err: any, data?: ListCampaignsCommandOutput) => void): void;
802
191
  listCampaigns(args: ListCampaignsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCampaignsCommandOutput) => void): void;
803
- /**
804
- * <p>Returns a list of dataset export jobs that use the given dataset. When a dataset is not
805
- * specified, all the dataset export jobs associated with the account are listed. The response
806
- * provides the properties for each dataset export job, including the Amazon Resource Name (ARN).
807
- * For more information on dataset export jobs, see <a>CreateDatasetExportJob</a>. For
808
- * more information on datasets, see <a>CreateDataset</a>.</p>
809
- */
192
+
810
193
  listDatasetExportJobs(args: ListDatasetExportJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetExportJobsCommandOutput>;
811
194
  listDatasetExportJobs(args: ListDatasetExportJobsCommandInput, cb: (err: any, data?: ListDatasetExportJobsCommandOutput) => void): void;
812
195
  listDatasetExportJobs(args: ListDatasetExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetExportJobsCommandOutput) => void): void;
813
- /**
814
- * <p>Returns a list of dataset groups. The response provides the properties for each dataset
815
- * group, including the Amazon Resource Name (ARN). For more information on dataset groups, see
816
- * <a>CreateDatasetGroup</a>.</p>
817
- */
196
+
818
197
  listDatasetGroups(args: ListDatasetGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetGroupsCommandOutput>;
819
198
  listDatasetGroups(args: ListDatasetGroupsCommandInput, cb: (err: any, data?: ListDatasetGroupsCommandOutput) => void): void;
820
199
  listDatasetGroups(args: ListDatasetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetGroupsCommandOutput) => void): void;
821
- /**
822
- * <p>Returns a list of dataset import jobs that use the given dataset. When a dataset is not
823
- * specified, all the dataset import jobs associated with the account are listed. The response
824
- * provides the properties for each dataset import job, including the Amazon Resource Name (ARN).
825
- * For more information on dataset import jobs, see <a>CreateDatasetImportJob</a>. For
826
- * more information on datasets, see <a>CreateDataset</a>.</p>
827
- */
200
+
828
201
  listDatasetImportJobs(args: ListDatasetImportJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetImportJobsCommandOutput>;
829
202
  listDatasetImportJobs(args: ListDatasetImportJobsCommandInput, cb: (err: any, data?: ListDatasetImportJobsCommandOutput) => void): void;
830
203
  listDatasetImportJobs(args: ListDatasetImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetImportJobsCommandOutput) => void): void;
831
- /**
832
- * <p>Returns the list of datasets contained in the given dataset group. The response provides
833
- * the properties for each dataset, including the Amazon Resource Name (ARN). For more
834
- * information on datasets, see <a>CreateDataset</a>.</p>
835
- */
204
+
836
205
  listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetsCommandOutput>;
837
206
  listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
838
207
  listDatasets(args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
839
- /**
840
- * <p>Returns the list of event trackers associated with the account.
841
- * The response provides the properties for each event tracker, including the Amazon Resource
842
- * Name (ARN) and tracking ID. For more
843
- * information on event trackers, see <a>CreateEventTracker</a>.</p>
844
- */
208
+
845
209
  listEventTrackers(args: ListEventTrackersCommandInput, options?: __HttpHandlerOptions): Promise<ListEventTrackersCommandOutput>;
846
210
  listEventTrackers(args: ListEventTrackersCommandInput, cb: (err: any, data?: ListEventTrackersCommandOutput) => void): void;
847
211
  listEventTrackers(args: ListEventTrackersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventTrackersCommandOutput) => void): void;
848
- /**
849
- * <p>Lists all filters that belong to a given dataset group.</p>
850
- */
212
+
851
213
  listFilters(args: ListFiltersCommandInput, options?: __HttpHandlerOptions): Promise<ListFiltersCommandOutput>;
852
214
  listFilters(args: ListFiltersCommandInput, cb: (err: any, data?: ListFiltersCommandOutput) => void): void;
853
215
  listFilters(args: ListFiltersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFiltersCommandOutput) => void): void;
854
- /**
855
- * <p>Returns a list of available recipes. The response provides the properties
856
- * for each recipe, including the recipe's Amazon Resource Name (ARN).</p>
857
- */
216
+
858
217
  listRecipes(args: ListRecipesCommandInput, options?: __HttpHandlerOptions): Promise<ListRecipesCommandOutput>;
859
218
  listRecipes(args: ListRecipesCommandInput, cb: (err: any, data?: ListRecipesCommandOutput) => void): void;
860
219
  listRecipes(args: ListRecipesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecipesCommandOutput) => void): void;
861
- /**
862
- * <p>Returns the list of schemas associated with the account. The response provides the
863
- * properties for each schema, including the Amazon Resource Name (ARN).
864
- * For more information on schemas, see <a>CreateSchema</a>.</p>
865
- */
220
+
866
221
  listSchemas(args: ListSchemasCommandInput, options?: __HttpHandlerOptions): Promise<ListSchemasCommandOutput>;
867
222
  listSchemas(args: ListSchemasCommandInput, cb: (err: any, data?: ListSchemasCommandOutput) => void): void;
868
223
  listSchemas(args: ListSchemasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSchemasCommandOutput) => void): void;
869
- /**
870
- * <p>Returns a list of solutions that use the given dataset group.
871
- * When a dataset group is not specified, all the solutions associated with the account are listed.
872
- * The response provides the properties for each solution, including the Amazon Resource Name (ARN).
873
- * For more information on solutions, see <a>CreateSolution</a>.</p>
874
- */
224
+
875
225
  listSolutions(args: ListSolutionsCommandInput, options?: __HttpHandlerOptions): Promise<ListSolutionsCommandOutput>;
876
226
  listSolutions(args: ListSolutionsCommandInput, cb: (err: any, data?: ListSolutionsCommandOutput) => void): void;
877
227
  listSolutions(args: ListSolutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSolutionsCommandOutput) => void): void;
878
- /**
879
- * <p>Returns a list of solution versions for the given solution. When a solution is not
880
- * specified, all the solution versions associated with the account are listed. The response
881
- * provides the properties for each solution version, including the Amazon Resource Name (ARN).
882
- * For more information on solutions, see <a>CreateSolution</a>.</p>
883
- */
228
+
884
229
  listSolutionVersions(args: ListSolutionVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListSolutionVersionsCommandOutput>;
885
230
  listSolutionVersions(args: ListSolutionVersionsCommandInput, cb: (err: any, data?: ListSolutionVersionsCommandOutput) => void): void;
886
231
  listSolutionVersions(args: ListSolutionVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSolutionVersionsCommandOutput) => void): void;
887
- /**
888
- * <p>Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
889
- * </p>
890
- * <p>Depending on the current state of the solution version, the solution version state changes as follows:</p>
891
- * <ul>
892
- * <li>
893
- * <p>CREATE_PENDING > CREATE_STOPPED</p>
894
- * <p>or</p>
895
- * </li>
896
- * <li>
897
- * <p>CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED</p>
898
- * </li>
899
- * </ul>
900
- * <p>You are billed for all of the training completed up
901
- * until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.</p>
902
- */
232
+
903
233
  stopSolutionVersionCreation(args: StopSolutionVersionCreationCommandInput, options?: __HttpHandlerOptions): Promise<StopSolutionVersionCreationCommandOutput>;
904
234
  stopSolutionVersionCreation(args: StopSolutionVersionCreationCommandInput, cb: (err: any, data?: StopSolutionVersionCreationCommandOutput) => void): void;
905
235
  stopSolutionVersionCreation(args: StopSolutionVersionCreationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopSolutionVersionCreationCommandOutput) => void): void;
906
- /**
907
- * <p>Updates a campaign by either deploying a new solution or changing the value of the
908
- * campaign's <code>minProvisionedTPS</code> parameter.</p>
909
- * <p>To update a campaign, the campaign status must be ACTIVE or CREATE FAILED.
910
- * Check the campaign status using the <a>DescribeCampaign</a> API.</p>
911
- * <note>
912
- * <p>You must wait until the <code>status</code> of the
913
- * updated campaign is <code>ACTIVE</code> before asking the campaign for recommendations.</p>
914
- * </note>
915
- * <p>For more information on campaigns, see <a>CreateCampaign</a>.</p>
916
- */
236
+
917
237
  updateCampaign(args: UpdateCampaignCommandInput, options?: __HttpHandlerOptions): Promise<UpdateCampaignCommandOutput>;
918
238
  updateCampaign(args: UpdateCampaignCommandInput, cb: (err: any, data?: UpdateCampaignCommandOutput) => void): void;
919
239
  updateCampaign(args: UpdateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCampaignCommandOutput) => void): void;