@aws-sdk/client-personalize 3.137.0 → 3.145.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +31 -0
- package/README.md +1 -1
- package/dist-cjs/models/models_0.js +9 -4
- package/dist-cjs/protocols/Aws_json1_1.js +303 -501
- package/dist-es/models/models_0.js +5 -0
- package/dist-es/protocols/Aws_json1_1.js +484 -503
- package/dist-types/Personalize.d.ts +87 -77
- package/dist-types/commands/CreateDatasetCommand.d.ts +8 -6
- package/dist-types/commands/CreateDatasetExportJobCommand.d.ts +10 -13
- package/dist-types/commands/CreateDatasetGroupCommand.d.ts +20 -18
- package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +20 -14
- package/dist-types/commands/DeleteDatasetCommand.d.ts +3 -2
- package/dist-types/commands/DeleteDatasetGroupCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDatasetCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDatasetExportJobCommand.d.ts +1 -2
- package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +1 -2
- package/dist-types/commands/ListDatasetExportJobsCommand.d.ts +6 -5
- package/dist-types/commands/ListDatasetGroupsCommand.d.ts +3 -3
- package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +6 -5
- package/dist-types/commands/ListDatasetsCommand.d.ts +3 -3
- package/dist-types/models/models_0.d.ts +144 -72
- package/dist-types/ts3.4/models/models_0.d.ts +10 -0
- package/package.json +11 -6
|
@@ -158,8 +158,9 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
158
158
|
createCampaign(args: CreateCampaignCommandInput, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void;
|
|
159
159
|
createCampaign(args: CreateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void;
|
|
160
160
|
/**
|
|
161
|
-
* <p>Creates an empty dataset and adds it to the specified dataset group.
|
|
162
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> to import your training data to a
|
|
161
|
+
* <p>Creates an empty dataset and adds it to the specified dataset group.
|
|
162
|
+
* Use <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> to import your training data to a
|
|
163
|
+
* dataset.</p>
|
|
163
164
|
*
|
|
164
165
|
* <p>There are three types of datasets:</p>
|
|
165
166
|
* <ul>
|
|
@@ -173,13 +174,14 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
173
174
|
* <p>Users</p>
|
|
174
175
|
* </li>
|
|
175
176
|
* </ul>
|
|
176
|
-
* <p>Each dataset type has an associated schema with required field types.
|
|
177
|
-
*
|
|
178
|
-
* creating a solution).</p>
|
|
177
|
+
* <p>Each dataset type has an associated schema with required field types.
|
|
178
|
+
* Only the <code>Interactions</code> dataset is required in order to train a
|
|
179
|
+
* model (also referred to as creating a solution).</p>
|
|
179
180
|
* <p>A dataset can be in one of the following states:</p>
|
|
180
181
|
* <ul>
|
|
181
182
|
* <li>
|
|
182
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
183
|
+
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
184
|
+
* FAILED</p>
|
|
183
185
|
* </li>
|
|
184
186
|
* <li>
|
|
185
187
|
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
@@ -216,36 +218,33 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
216
218
|
createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
|
|
217
219
|
createDataset(args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
|
|
218
220
|
/**
|
|
219
|
-
* <p>
|
|
220
|
-
* Creates a job that exports data from your dataset to an Amazon S3 bucket.
|
|
221
|
+
* <p> Creates a job that exports data from your dataset to an Amazon S3 bucket.
|
|
221
222
|
* To allow Amazon Personalize to export the training data, you must specify an
|
|
222
|
-
* service-linked IAM role that gives Amazon Personalize <code>PutObject</code>
|
|
223
|
-
* For information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/export-data.html">Exporting a dataset</a>
|
|
224
|
-
* in the Amazon Personalize developer guide.
|
|
225
|
-
* </p>
|
|
223
|
+
* service-linked IAM role that gives Amazon Personalize <code>PutObject</code>
|
|
224
|
+
* 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>
|
|
226
225
|
* <p>
|
|
227
226
|
* <b>Status</b>
|
|
228
227
|
* </p>
|
|
229
228
|
* <p>A dataset export job can be in one of the following states:</p>
|
|
230
229
|
* <ul>
|
|
231
230
|
* <li>
|
|
232
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
231
|
+
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
232
|
+
* FAILED</p>
|
|
233
233
|
* </li>
|
|
234
234
|
* </ul>
|
|
235
|
-
* <p>
|
|
236
|
-
*
|
|
237
|
-
*
|
|
238
|
-
*
|
|
239
|
-
*
|
|
240
|
-
* </p>
|
|
235
|
+
* <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
|
|
236
|
+
* (ARN) of the dataset export job. The dataset export is complete when the
|
|
237
|
+
* status shows as ACTIVE. If the status shows as CREATE FAILED, the response
|
|
238
|
+
* includes a <code>failureReason</code> key, which describes why the job
|
|
239
|
+
* failed. </p>
|
|
241
240
|
*/
|
|
242
241
|
createDatasetExportJob(args: CreateDatasetExportJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetExportJobCommandOutput>;
|
|
243
242
|
createDatasetExportJob(args: CreateDatasetExportJobCommandInput, cb: (err: any, data?: CreateDatasetExportJobCommandOutput) => void): void;
|
|
244
243
|
createDatasetExportJob(args: CreateDatasetExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetExportJobCommandOutput) => void): void;
|
|
245
244
|
/**
|
|
246
|
-
* <p>Creates an empty dataset group. A dataset group is a container for
|
|
247
|
-
* A dataset group can contain at most three datasets, one
|
|
248
|
-
* dataset:</p>
|
|
245
|
+
* <p>Creates an empty dataset group. A dataset group is a container for
|
|
246
|
+
* Amazon Personalize resources. A dataset group can contain at most three datasets, one
|
|
247
|
+
* for each type of dataset:</p>
|
|
249
248
|
* <ul>
|
|
250
249
|
* <li>
|
|
251
250
|
* <p>Interactions</p>
|
|
@@ -257,31 +256,33 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
257
256
|
* <p>Users</p>
|
|
258
257
|
* </li>
|
|
259
258
|
* </ul>
|
|
260
|
-
* <p>
|
|
261
|
-
*
|
|
262
|
-
*
|
|
263
|
-
*
|
|
264
|
-
*
|
|
265
|
-
*
|
|
259
|
+
* <p> A dataset group can be a Domain dataset group, where you specify a
|
|
260
|
+
* domain and use pre-configured resources like recommenders, or a
|
|
261
|
+
* Custom dataset group, where you use custom resources, such as a solution
|
|
262
|
+
* with a solution version, that you deploy with a campaign. If you start
|
|
263
|
+
* with a Domain dataset group, you can still add custom resources such as
|
|
264
|
+
* solutions and solution versions trained with recipes for custom use cases
|
|
265
|
+
* and deployed with campaigns. </p>
|
|
266
266
|
* <p>A dataset group can be in one of the following states:</p>
|
|
267
267
|
* <ul>
|
|
268
268
|
* <li>
|
|
269
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
269
|
+
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
270
|
+
* FAILED</p>
|
|
270
271
|
* </li>
|
|
271
272
|
* <li>
|
|
272
273
|
* <p>DELETE PENDING</p>
|
|
273
274
|
* </li>
|
|
274
275
|
* </ul>
|
|
275
|
-
* <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
|
|
276
|
-
*
|
|
277
|
-
*
|
|
276
|
+
* <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
|
|
277
|
+
* response includes a <code>failureReason</code> key, which describes why
|
|
278
|
+
* the creation failed.</p>
|
|
278
279
|
* <note>
|
|
279
|
-
* <p>You must wait until the <code>status</code> of the dataset group is
|
|
280
|
-
*
|
|
280
|
+
* <p>You must wait until the <code>status</code> of the dataset group is
|
|
281
|
+
* <code>ACTIVE</code> before adding a dataset to the group.</p>
|
|
281
282
|
* </note>
|
|
282
|
-
* <p>You can specify an Key Management Service (KMS) key to encrypt the datasets in
|
|
283
|
-
* specify a KMS key, you must also include an Identity and Access Management
|
|
284
|
-
* access the key.</p>
|
|
283
|
+
* <p>You can specify an Key Management Service (KMS) key to encrypt the datasets in
|
|
284
|
+
* the group. If you specify a KMS key, you must also include an Identity and Access Management
|
|
285
|
+
* (IAM) role that has permission to access the key.</p>
|
|
285
286
|
* <p class="title">
|
|
286
287
|
* <b>APIs that require a dataset group ARN in the request</b>
|
|
287
288
|
* </p>
|
|
@@ -327,14 +328,18 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
327
328
|
createDatasetGroup(args: CreateDatasetGroupCommandInput, cb: (err: any, data?: CreateDatasetGroupCommandOutput) => void): void;
|
|
328
329
|
createDatasetGroup(args: CreateDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetGroupCommandOutput) => void): void;
|
|
329
330
|
/**
|
|
330
|
-
* <p>Creates a job that imports training data from your data source (an
|
|
331
|
-
* Amazon Personalize dataset. To allow Amazon Personalize to import the
|
|
332
|
-
* IAM service role that has permission to
|
|
333
|
-
*
|
|
334
|
-
*
|
|
335
|
-
*
|
|
331
|
+
* <p>Creates a job that imports training data from your data source (an
|
|
332
|
+
* Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the
|
|
333
|
+
* training data, you must specify an IAM service role that has permission to
|
|
334
|
+
* read from the data source, as Amazon Personalize makes a copy of your data and
|
|
335
|
+
* processes it internally. For information on granting access to your Amazon S3
|
|
336
|
+
* bucket, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html">Giving
|
|
337
|
+
* Amazon Personalize Access to Amazon S3 Resources</a>. </p>
|
|
336
338
|
* <important>
|
|
337
|
-
* <p>
|
|
339
|
+
* <p>By default, a dataset import job replaces any existing data in the
|
|
340
|
+
* dataset that you imported in bulk. To add new records without replacing
|
|
341
|
+
* existing data, specify INCREMENTAL for the import mode in the
|
|
342
|
+
* CreateDatasetImportJob operation.</p>
|
|
338
343
|
* </important>
|
|
339
344
|
* <p>
|
|
340
345
|
* <b>Status</b>
|
|
@@ -342,16 +347,18 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
342
347
|
* <p>A dataset import job can be in one of the following states:</p>
|
|
343
348
|
* <ul>
|
|
344
349
|
* <li>
|
|
345
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
350
|
+
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
351
|
+
* FAILED</p>
|
|
346
352
|
* </li>
|
|
347
353
|
* </ul>
|
|
348
|
-
* <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>,
|
|
349
|
-
*
|
|
350
|
-
*
|
|
351
|
-
* includes a <code>failureReason</code> key, which describes why the job
|
|
354
|
+
* <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
|
|
355
|
+
* (ARN) of the dataset import job. The dataset import is complete when the
|
|
356
|
+
* status shows as ACTIVE. If the status shows as CREATE FAILED, the response
|
|
357
|
+
* includes a <code>failureReason</code> key, which describes why the job
|
|
358
|
+
* failed.</p>
|
|
352
359
|
* <note>
|
|
353
|
-
* <p>Importing takes time. You must wait until the status shows as ACTIVE
|
|
354
|
-
* model using the dataset.</p>
|
|
360
|
+
* <p>Importing takes time. You must wait until the status shows as ACTIVE
|
|
361
|
+
* before training a model using the dataset.</p>
|
|
355
362
|
* </note>
|
|
356
363
|
*
|
|
357
364
|
* <p class="title">
|
|
@@ -706,15 +713,16 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
706
713
|
deleteCampaign(args: DeleteCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCampaignCommandOutput) => void): void;
|
|
707
714
|
/**
|
|
708
715
|
* <p>Deletes a dataset. You can't delete a dataset if an associated
|
|
709
|
-
* <code>DatasetImportJob</code> or <code>SolutionVersion</code> is in the
|
|
710
|
-
* PROGRESS state. For more information on datasets, see
|
|
716
|
+
* <code>DatasetImportJob</code> or <code>SolutionVersion</code> is in the
|
|
717
|
+
* CREATE PENDING or IN PROGRESS state. For more information on datasets, see
|
|
718
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
711
719
|
*/
|
|
712
720
|
deleteDataset(args: DeleteDatasetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatasetCommandOutput>;
|
|
713
721
|
deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
|
|
714
722
|
deleteDataset(args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
|
|
715
723
|
/**
|
|
716
|
-
* <p>Deletes a dataset group. Before you delete a dataset group, you must
|
|
717
|
-
* following:</p>
|
|
724
|
+
* <p>Deletes a dataset group. Before you delete a dataset group, you must
|
|
725
|
+
* delete the following:</p>
|
|
718
726
|
* <ul>
|
|
719
727
|
* <li>
|
|
720
728
|
* <p>All associated event trackers.</p>
|
|
@@ -812,27 +820,27 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
812
820
|
describeCampaign(args: DescribeCampaignCommandInput, cb: (err: any, data?: DescribeCampaignCommandOutput) => void): void;
|
|
813
821
|
describeCampaign(args: DescribeCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCampaignCommandOutput) => void): void;
|
|
814
822
|
/**
|
|
815
|
-
* <p>Describes the given dataset. For more information on datasets, see
|
|
823
|
+
* <p>Describes the given dataset. For more information on datasets, see
|
|
824
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
816
825
|
*/
|
|
817
826
|
describeDataset(args: DescribeDatasetCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetCommandOutput>;
|
|
818
827
|
describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
|
|
819
828
|
describeDataset(args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
|
|
820
829
|
/**
|
|
821
|
-
* <p>Describes the dataset export job created by <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html">CreateDatasetExportJob</a>,
|
|
822
|
-
* including the export job status.</p>
|
|
830
|
+
* <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>
|
|
823
831
|
*/
|
|
824
832
|
describeDatasetExportJob(args: DescribeDatasetExportJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetExportJobCommandOutput>;
|
|
825
833
|
describeDatasetExportJob(args: DescribeDatasetExportJobCommandInput, cb: (err: any, data?: DescribeDatasetExportJobCommandOutput) => void): void;
|
|
826
834
|
describeDatasetExportJob(args: DescribeDatasetExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetExportJobCommandOutput) => void): void;
|
|
827
835
|
/**
|
|
828
|
-
* <p>Describes the given dataset group. For more information on dataset
|
|
836
|
+
* <p>Describes the given dataset group. For more information on dataset
|
|
837
|
+
* groups, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>.</p>
|
|
829
838
|
*/
|
|
830
839
|
describeDatasetGroup(args: DescribeDatasetGroupCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetGroupCommandOutput>;
|
|
831
840
|
describeDatasetGroup(args: DescribeDatasetGroupCommandInput, cb: (err: any, data?: DescribeDatasetGroupCommandOutput) => void): void;
|
|
832
841
|
describeDatasetGroup(args: DescribeDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetGroupCommandOutput) => void): void;
|
|
833
842
|
/**
|
|
834
|
-
* <p>Describes the dataset import job created by <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>,
|
|
835
|
-
* including the import job status.</p>
|
|
843
|
+
* <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>
|
|
836
844
|
*/
|
|
837
845
|
describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetImportJobCommandOutput>;
|
|
838
846
|
describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, cb: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void): void;
|
|
@@ -955,37 +963,39 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
955
963
|
listCampaigns(args: ListCampaignsCommandInput, cb: (err: any, data?: ListCampaignsCommandOutput) => void): void;
|
|
956
964
|
listCampaigns(args: ListCampaignsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCampaignsCommandOutput) => void): void;
|
|
957
965
|
/**
|
|
958
|
-
* <p>Returns a list of dataset export jobs that use the given dataset. When
|
|
959
|
-
* specified, all the dataset export jobs associated with
|
|
960
|
-
*
|
|
961
|
-
*
|
|
962
|
-
*
|
|
966
|
+
* <p>Returns a list of dataset export jobs that use the given dataset. When
|
|
967
|
+
* a dataset is not specified, all the dataset export jobs associated with
|
|
968
|
+
* the account are listed. The response provides the properties for each
|
|
969
|
+
* dataset export job, including the Amazon Resource Name (ARN). For more
|
|
970
|
+
* 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
|
|
971
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
963
972
|
*/
|
|
964
973
|
listDatasetExportJobs(args: ListDatasetExportJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetExportJobsCommandOutput>;
|
|
965
974
|
listDatasetExportJobs(args: ListDatasetExportJobsCommandInput, cb: (err: any, data?: ListDatasetExportJobsCommandOutput) => void): void;
|
|
966
975
|
listDatasetExportJobs(args: ListDatasetExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetExportJobsCommandOutput) => void): void;
|
|
967
976
|
/**
|
|
968
|
-
* <p>Returns a list of dataset groups. The response provides the properties
|
|
969
|
-
* group, including the Amazon Resource Name (ARN). For more
|
|
970
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>.</p>
|
|
977
|
+
* <p>Returns a list of dataset groups. The response provides the properties
|
|
978
|
+
* for each dataset group, including the Amazon Resource Name (ARN). For more
|
|
979
|
+
* information on dataset groups, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>.</p>
|
|
971
980
|
*/
|
|
972
981
|
listDatasetGroups(args: ListDatasetGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetGroupsCommandOutput>;
|
|
973
982
|
listDatasetGroups(args: ListDatasetGroupsCommandInput, cb: (err: any, data?: ListDatasetGroupsCommandOutput) => void): void;
|
|
974
983
|
listDatasetGroups(args: ListDatasetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetGroupsCommandOutput) => void): void;
|
|
975
984
|
/**
|
|
976
|
-
* <p>Returns a list of dataset import jobs that use the given dataset. When
|
|
977
|
-
* specified, all the dataset import jobs associated with
|
|
978
|
-
*
|
|
979
|
-
*
|
|
980
|
-
*
|
|
985
|
+
* <p>Returns a list of dataset import jobs that use the given dataset. When
|
|
986
|
+
* a dataset is not specified, all the dataset import jobs associated with
|
|
987
|
+
* the account are listed. The response provides the properties for each
|
|
988
|
+
* dataset import job, including the Amazon Resource Name (ARN). For more
|
|
989
|
+
* 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
|
|
990
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
981
991
|
*/
|
|
982
992
|
listDatasetImportJobs(args: ListDatasetImportJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetImportJobsCommandOutput>;
|
|
983
993
|
listDatasetImportJobs(args: ListDatasetImportJobsCommandInput, cb: (err: any, data?: ListDatasetImportJobsCommandOutput) => void): void;
|
|
984
994
|
listDatasetImportJobs(args: ListDatasetImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetImportJobsCommandOutput) => void): void;
|
|
985
995
|
/**
|
|
986
|
-
* <p>Returns the list of datasets contained in the given dataset group. The
|
|
987
|
-
* the properties for each dataset, including the Amazon
|
|
988
|
-
* information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
996
|
+
* <p>Returns the list of datasets contained in the given dataset group. The
|
|
997
|
+
* response provides the properties for each dataset, including the Amazon
|
|
998
|
+
* 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>
|
|
989
999
|
*/
|
|
990
1000
|
listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetsCommandOutput>;
|
|
991
1001
|
listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
|
|
@@ -7,8 +7,9 @@ export interface CreateDatasetCommandInput extends CreateDatasetRequest {
|
|
|
7
7
|
export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates an empty dataset and adds it to the specified dataset group.
|
|
11
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> to import your training data to a
|
|
10
|
+
* <p>Creates an empty dataset and adds it to the specified dataset group.
|
|
11
|
+
* Use <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> to import your training data to a
|
|
12
|
+
* dataset.</p>
|
|
12
13
|
*
|
|
13
14
|
* <p>There are three types of datasets:</p>
|
|
14
15
|
* <ul>
|
|
@@ -22,13 +23,14 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
|
|
|
22
23
|
* <p>Users</p>
|
|
23
24
|
* </li>
|
|
24
25
|
* </ul>
|
|
25
|
-
* <p>Each dataset type has an associated schema with required field types.
|
|
26
|
-
*
|
|
27
|
-
* creating a solution).</p>
|
|
26
|
+
* <p>Each dataset type has an associated schema with required field types.
|
|
27
|
+
* Only the <code>Interactions</code> dataset is required in order to train a
|
|
28
|
+
* model (also referred to as creating a solution).</p>
|
|
28
29
|
* <p>A dataset can be in one of the following states:</p>
|
|
29
30
|
* <ul>
|
|
30
31
|
* <li>
|
|
31
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
32
|
+
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
33
|
+
* FAILED</p>
|
|
32
34
|
* </li>
|
|
33
35
|
* <li>
|
|
34
36
|
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
@@ -7,28 +7,25 @@ export interface CreateDatasetExportJobCommandInput extends CreateDatasetExportJ
|
|
|
7
7
|
export interface CreateDatasetExportJobCommandOutput extends CreateDatasetExportJobResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
* Creates a job that exports data from your dataset to an Amazon S3 bucket.
|
|
10
|
+
* <p> Creates a job that exports data from your dataset to an Amazon S3 bucket.
|
|
12
11
|
* To allow Amazon Personalize to export the training data, you must specify an
|
|
13
|
-
* service-linked IAM role that gives Amazon Personalize <code>PutObject</code>
|
|
14
|
-
* For information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/export-data.html">Exporting a dataset</a>
|
|
15
|
-
* in the Amazon Personalize developer guide.
|
|
16
|
-
* </p>
|
|
12
|
+
* service-linked IAM role that gives Amazon Personalize <code>PutObject</code>
|
|
13
|
+
* 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>
|
|
17
14
|
* <p>
|
|
18
15
|
* <b>Status</b>
|
|
19
16
|
* </p>
|
|
20
17
|
* <p>A dataset export job can be in one of the following states:</p>
|
|
21
18
|
* <ul>
|
|
22
19
|
* <li>
|
|
23
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
20
|
+
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
21
|
+
* FAILED</p>
|
|
24
22
|
* </li>
|
|
25
23
|
* </ul>
|
|
26
|
-
* <p>
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* </p>
|
|
24
|
+
* <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
|
|
25
|
+
* (ARN) of the dataset export job. The dataset export is complete when the
|
|
26
|
+
* status shows as ACTIVE. If the status shows as CREATE FAILED, the response
|
|
27
|
+
* includes a <code>failureReason</code> key, which describes why the job
|
|
28
|
+
* failed. </p>
|
|
32
29
|
* @example
|
|
33
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
31
|
* ```javascript
|
|
@@ -7,9 +7,9 @@ export interface CreateDatasetGroupCommandInput extends CreateDatasetGroupReques
|
|
|
7
7
|
export interface CreateDatasetGroupCommandOutput extends CreateDatasetGroupResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates an empty dataset group. A dataset group is a container for
|
|
11
|
-
* A dataset group can contain at most three datasets, one
|
|
12
|
-
* dataset:</p>
|
|
10
|
+
* <p>Creates an empty dataset group. A dataset group is a container for
|
|
11
|
+
* Amazon Personalize resources. A dataset group can contain at most three datasets, one
|
|
12
|
+
* for each type of dataset:</p>
|
|
13
13
|
* <ul>
|
|
14
14
|
* <li>
|
|
15
15
|
* <p>Interactions</p>
|
|
@@ -21,31 +21,33 @@ export interface CreateDatasetGroupCommandOutput extends CreateDatasetGroupRespo
|
|
|
21
21
|
* <p>Users</p>
|
|
22
22
|
* </li>
|
|
23
23
|
* </ul>
|
|
24
|
-
* <p>
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
24
|
+
* <p> A dataset group can be a Domain dataset group, where you specify a
|
|
25
|
+
* domain and use pre-configured resources like recommenders, or a
|
|
26
|
+
* Custom dataset group, where you use custom resources, such as a solution
|
|
27
|
+
* with a solution version, that you deploy with a campaign. If you start
|
|
28
|
+
* with a Domain dataset group, you can still add custom resources such as
|
|
29
|
+
* solutions and solution versions trained with recipes for custom use cases
|
|
30
|
+
* and deployed with campaigns. </p>
|
|
30
31
|
* <p>A dataset group can be in one of the following states:</p>
|
|
31
32
|
* <ul>
|
|
32
33
|
* <li>
|
|
33
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
34
|
+
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
35
|
+
* FAILED</p>
|
|
34
36
|
* </li>
|
|
35
37
|
* <li>
|
|
36
38
|
* <p>DELETE PENDING</p>
|
|
37
39
|
* </li>
|
|
38
40
|
* </ul>
|
|
39
|
-
* <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
|
|
40
|
-
*
|
|
41
|
-
*
|
|
41
|
+
* <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
|
|
42
|
+
* response includes a <code>failureReason</code> key, which describes why
|
|
43
|
+
* the creation failed.</p>
|
|
42
44
|
* <note>
|
|
43
|
-
* <p>You must wait until the <code>status</code> of the dataset group is
|
|
44
|
-
*
|
|
45
|
+
* <p>You must wait until the <code>status</code> of the dataset group is
|
|
46
|
+
* <code>ACTIVE</code> before adding a dataset to the group.</p>
|
|
45
47
|
* </note>
|
|
46
|
-
* <p>You can specify an Key Management Service (KMS) key to encrypt the datasets in
|
|
47
|
-
* specify a KMS key, you must also include an Identity and Access Management
|
|
48
|
-
* access the key.</p>
|
|
48
|
+
* <p>You can specify an Key Management Service (KMS) key to encrypt the datasets in
|
|
49
|
+
* the group. If you specify a KMS key, you must also include an Identity and Access Management
|
|
50
|
+
* (IAM) role that has permission to access the key.</p>
|
|
49
51
|
* <p class="title">
|
|
50
52
|
* <b>APIs that require a dataset group ARN in the request</b>
|
|
51
53
|
* </p>
|
|
@@ -7,14 +7,18 @@ export interface CreateDatasetImportJobCommandInput extends CreateDatasetImportJ
|
|
|
7
7
|
export interface CreateDatasetImportJobCommandOutput extends CreateDatasetImportJobResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a job that imports training data from your data source (an
|
|
11
|
-
* Amazon Personalize dataset. To allow Amazon Personalize to import the
|
|
12
|
-
* IAM service role that has permission to
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
10
|
+
* <p>Creates a job that imports training data from your data source (an
|
|
11
|
+
* Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the
|
|
12
|
+
* training data, you must specify an IAM service role that has permission to
|
|
13
|
+
* read from the data source, as Amazon Personalize makes a copy of your data and
|
|
14
|
+
* processes it internally. For information on granting access to your Amazon S3
|
|
15
|
+
* bucket, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html">Giving
|
|
16
|
+
* Amazon Personalize Access to Amazon S3 Resources</a>. </p>
|
|
16
17
|
* <important>
|
|
17
|
-
* <p>
|
|
18
|
+
* <p>By default, a dataset import job replaces any existing data in the
|
|
19
|
+
* dataset that you imported in bulk. To add new records without replacing
|
|
20
|
+
* existing data, specify INCREMENTAL for the import mode in the
|
|
21
|
+
* CreateDatasetImportJob operation.</p>
|
|
18
22
|
* </important>
|
|
19
23
|
* <p>
|
|
20
24
|
* <b>Status</b>
|
|
@@ -22,16 +26,18 @@ export interface CreateDatasetImportJobCommandOutput extends CreateDatasetImport
|
|
|
22
26
|
* <p>A dataset import job can be in one of the following states:</p>
|
|
23
27
|
* <ul>
|
|
24
28
|
* <li>
|
|
25
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
29
|
+
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
30
|
+
* FAILED</p>
|
|
26
31
|
* </li>
|
|
27
32
|
* </ul>
|
|
28
|
-
* <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>,
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* includes a <code>failureReason</code> key, which describes why the job
|
|
33
|
+
* <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
|
|
34
|
+
* (ARN) of the dataset import job. The dataset import is complete when the
|
|
35
|
+
* status shows as ACTIVE. If the status shows as CREATE FAILED, the response
|
|
36
|
+
* includes a <code>failureReason</code> key, which describes why the job
|
|
37
|
+
* failed.</p>
|
|
32
38
|
* <note>
|
|
33
|
-
* <p>Importing takes time. You must wait until the status shows as ACTIVE
|
|
34
|
-
* model using the dataset.</p>
|
|
39
|
+
* <p>Importing takes time. You must wait until the status shows as ACTIVE
|
|
40
|
+
* before training a model using the dataset.</p>
|
|
35
41
|
* </note>
|
|
36
42
|
*
|
|
37
43
|
* <p class="title">
|
|
@@ -8,8 +8,9 @@ export interface DeleteDatasetCommandOutput extends __MetadataBearer {
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Deletes a dataset. You can't delete a dataset if an associated
|
|
11
|
-
* <code>DatasetImportJob</code> or <code>SolutionVersion</code> is in the
|
|
12
|
-
* PROGRESS state. For more information on datasets, see
|
|
11
|
+
* <code>DatasetImportJob</code> or <code>SolutionVersion</code> is in the
|
|
12
|
+
* CREATE PENDING or IN PROGRESS state. For more information on datasets, see
|
|
13
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
13
14
|
* @example
|
|
14
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
16
|
* ```javascript
|
|
@@ -7,8 +7,8 @@ export interface DeleteDatasetGroupCommandInput extends DeleteDatasetGroupReques
|
|
|
7
7
|
export interface DeleteDatasetGroupCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a dataset group. Before you delete a dataset group, you must
|
|
11
|
-
* following:</p>
|
|
10
|
+
* <p>Deletes a dataset group. Before you delete a dataset group, you must
|
|
11
|
+
* delete the following:</p>
|
|
12
12
|
* <ul>
|
|
13
13
|
* <li>
|
|
14
14
|
* <p>All associated event trackers.</p>
|
|
@@ -7,7 +7,8 @@ export interface DescribeDatasetCommandInput extends DescribeDatasetRequest {
|
|
|
7
7
|
export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describes the given dataset. For more information on datasets, see
|
|
10
|
+
* <p>Describes the given dataset. For more information on datasets, see
|
|
11
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
11
12
|
* @example
|
|
12
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
14
|
* ```javascript
|
|
@@ -7,8 +7,7 @@ export interface DescribeDatasetExportJobCommandInput extends DescribeDatasetExp
|
|
|
7
7
|
export interface DescribeDatasetExportJobCommandOutput extends DescribeDatasetExportJobResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describes the dataset export job created by <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html">CreateDatasetExportJob</a>,
|
|
11
|
-
* including the export job status.</p>
|
|
10
|
+
* <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>
|
|
12
11
|
* @example
|
|
13
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
13
|
* ```javascript
|
|
@@ -7,7 +7,8 @@ export interface DescribeDatasetGroupCommandInput extends DescribeDatasetGroupRe
|
|
|
7
7
|
export interface DescribeDatasetGroupCommandOutput extends DescribeDatasetGroupResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describes the given dataset group. For more information on dataset
|
|
10
|
+
* <p>Describes the given dataset group. For more information on dataset
|
|
11
|
+
* groups, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>.</p>
|
|
11
12
|
* @example
|
|
12
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
14
|
* ```javascript
|
|
@@ -7,8 +7,7 @@ export interface DescribeDatasetImportJobCommandInput extends DescribeDatasetImp
|
|
|
7
7
|
export interface DescribeDatasetImportJobCommandOutput extends DescribeDatasetImportJobResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describes the dataset import job created by <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>,
|
|
11
|
-
* including the import job status.</p>
|
|
10
|
+
* <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>
|
|
12
11
|
* @example
|
|
13
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
13
|
* ```javascript
|
|
@@ -7,11 +7,12 @@ export interface ListDatasetExportJobsCommandInput extends ListDatasetExportJobs
|
|
|
7
7
|
export interface ListDatasetExportJobsCommandOutput extends ListDatasetExportJobsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns a list of dataset export jobs that use the given dataset. When
|
|
11
|
-
* specified, all the dataset export jobs associated with
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
10
|
+
* <p>Returns a list of dataset export jobs that use the given dataset. When
|
|
11
|
+
* a dataset is not specified, all the dataset export jobs associated with
|
|
12
|
+
* the account are listed. The response provides the properties for each
|
|
13
|
+
* dataset export job, including the Amazon Resource Name (ARN). For more
|
|
14
|
+
* 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
|
|
15
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
15
16
|
* @example
|
|
16
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
18
|
* ```javascript
|
|
@@ -7,9 +7,9 @@ export interface ListDatasetGroupsCommandInput extends ListDatasetGroupsRequest
|
|
|
7
7
|
export interface ListDatasetGroupsCommandOutput extends ListDatasetGroupsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns a list of dataset groups. The response provides the properties
|
|
11
|
-
* group, including the Amazon Resource Name (ARN). For more
|
|
12
|
-
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>.</p>
|
|
10
|
+
* <p>Returns a list of dataset groups. The response provides the properties
|
|
11
|
+
* for each dataset group, including the Amazon Resource Name (ARN). For more
|
|
12
|
+
* information on dataset groups, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|