@aws-sdk/client-personalize 3.40.0 → 3.45.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 +41 -0
- package/dist-cjs/Personalize.js +120 -0
- package/dist-cjs/commands/CreateBatchSegmentJobCommand.js +36 -0
- package/dist-cjs/commands/CreateRecommenderCommand.js +36 -0
- package/dist-cjs/commands/DeleteRecommenderCommand.js +36 -0
- package/dist-cjs/commands/DescribeBatchSegmentJobCommand.js +36 -0
- package/dist-cjs/commands/DescribeRecommenderCommand.js +36 -0
- package/dist-cjs/commands/ListBatchSegmentJobsCommand.js +36 -0
- package/dist-cjs/commands/ListRecommendersCommand.js +36 -0
- package/dist-cjs/commands/UpdateRecommenderCommand.js +36 -0
- package/dist-cjs/commands/index.js +8 -0
- package/dist-cjs/endpoints.js +9 -0
- package/dist-cjs/models/models_0.js +147 -3
- package/dist-cjs/pagination/ListBatchSegmentJobsPaginator.js +35 -0
- package/dist-cjs/pagination/ListRecommendersPaginator.js +35 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_json1_1.js +891 -28
- package/dist-es/Personalize.js +120 -0
- package/dist-es/commands/CreateBatchSegmentJobCommand.js +39 -0
- package/dist-es/commands/CreateRecommenderCommand.js +39 -0
- package/dist-es/commands/DeleteRecommenderCommand.js +39 -0
- package/dist-es/commands/DescribeBatchSegmentJobCommand.js +39 -0
- package/dist-es/commands/DescribeRecommenderCommand.js +39 -0
- package/dist-es/commands/ListBatchSegmentJobsCommand.js +39 -0
- package/dist-es/commands/ListRecommendersCommand.js +39 -0
- package/dist-es/commands/UpdateRecommenderCommand.js +39 -0
- package/dist-es/commands/index.js +8 -0
- package/dist-es/endpoints.js +9 -0
- package/dist-es/models/models_0.js +97 -0
- package/dist-es/pagination/ListBatchSegmentJobsPaginator.js +74 -0
- package/dist-es/pagination/ListRecommendersPaginator.js +74 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_json1_1.js +944 -38
- package/dist-types/Personalize.d.ts +137 -8
- package/dist-types/PersonalizeClient.d.ts +10 -2
- package/dist-types/commands/CreateBatchInferenceJobCommand.d.ts +1 -1
- package/dist-types/commands/CreateBatchSegmentJobCommand.d.ts +36 -0
- package/dist-types/commands/CreateCampaignCommand.d.ts +2 -2
- package/dist-types/commands/CreateDatasetCommand.d.ts +1 -1
- package/dist-types/commands/CreateDatasetExportJobCommand.d.ts +1 -1
- package/dist-types/commands/CreateDatasetGroupCommand.d.ts +9 -6
- package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +1 -1
- package/dist-types/commands/CreateEventTrackerCommand.d.ts +1 -1
- package/dist-types/commands/CreateFilterCommand.d.ts +1 -1
- package/dist-types/commands/CreateRecommenderCommand.d.ts +84 -0
- package/dist-types/commands/CreateSchemaCommand.d.ts +3 -2
- package/dist-types/commands/CreateSolutionCommand.d.ts +1 -1
- package/dist-types/commands/CreateSolutionVersionCommand.d.ts +2 -2
- package/dist-types/commands/DeleteCampaignCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDatasetCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDatasetGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEventTrackerCommand.d.ts +1 -1
- package/dist-types/commands/DeleteFilterCommand.d.ts +1 -1
- package/dist-types/commands/DeleteRecommenderCommand.d.ts +36 -0
- package/dist-types/commands/DeleteSchemaCommand.d.ts +1 -1
- package/dist-types/commands/DeleteSolutionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAlgorithmCommand.d.ts +1 -1
- package/dist-types/commands/DescribeBatchInferenceJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeBatchSegmentJobCommand.d.ts +37 -0
- package/dist-types/commands/DescribeCampaignCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDatasetCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDatasetExportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventTrackerCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFeatureTransformationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFilterCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRecipeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRecommenderCommand.d.ts +47 -0
- package/dist-types/commands/DescribeSchemaCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSolutionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSolutionVersionCommand.d.ts +1 -1
- package/dist-types/commands/GetSolutionMetricsCommand.d.ts +1 -1
- package/dist-types/commands/ListBatchInferenceJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListBatchSegmentJobsCommand.d.ts +36 -0
- package/dist-types/commands/ListCampaignsCommand.d.ts +1 -1
- package/dist-types/commands/ListDatasetExportJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListDatasetGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListDatasetsCommand.d.ts +1 -1
- package/dist-types/commands/ListEventTrackersCommand.d.ts +1 -1
- package/dist-types/commands/ListFiltersCommand.d.ts +1 -1
- package/dist-types/commands/ListRecipesCommand.d.ts +1 -1
- package/dist-types/commands/ListRecommendersCommand.d.ts +38 -0
- package/dist-types/commands/ListSchemasCommand.d.ts +1 -1
- package/dist-types/commands/ListSolutionVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListSolutionsCommand.d.ts +1 -1
- package/dist-types/commands/StopSolutionVersionCreationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCampaignCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRecommenderCommand.d.ts +35 -0
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/models/models_0.d.ts +634 -3
- package/dist-types/pagination/ListBatchSegmentJobsPaginator.d.ts +4 -0
- package/dist-types/pagination/ListRecommendersPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +24 -0
- package/dist-types/ts3.4/Personalize.d.ts +40 -0
- package/dist-types/ts3.4/PersonalizeClient.d.ts +10 -2
- package/dist-types/ts3.4/commands/CreateBatchSegmentJobCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateRecommenderCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteRecommenderCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeBatchSegmentJobCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeRecommenderCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListBatchSegmentJobsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListRecommendersCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateRecommenderCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +8 -0
- package/dist-types/ts3.4/models/models_0.d.ts +322 -0
- package/dist-types/ts3.4/pagination/ListBatchSegmentJobsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListRecommendersPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +24 -0
- package/package.json +6 -6
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
2
2
|
import { CreateBatchInferenceJobCommandInput, CreateBatchInferenceJobCommandOutput } from "./commands/CreateBatchInferenceJobCommand";
|
|
3
|
+
import { CreateBatchSegmentJobCommandInput, CreateBatchSegmentJobCommandOutput } from "./commands/CreateBatchSegmentJobCommand";
|
|
3
4
|
import { CreateCampaignCommandInput, CreateCampaignCommandOutput } from "./commands/CreateCampaignCommand";
|
|
4
5
|
import { CreateDatasetCommandInput, CreateDatasetCommandOutput } from "./commands/CreateDatasetCommand";
|
|
5
6
|
import { CreateDatasetExportJobCommandInput, CreateDatasetExportJobCommandOutput } from "./commands/CreateDatasetExportJobCommand";
|
|
@@ -7,6 +8,7 @@ import { CreateDatasetGroupCommandInput, CreateDatasetGroupCommandOutput } from
|
|
|
7
8
|
import { CreateDatasetImportJobCommandInput, CreateDatasetImportJobCommandOutput } from "./commands/CreateDatasetImportJobCommand";
|
|
8
9
|
import { CreateEventTrackerCommandInput, CreateEventTrackerCommandOutput } from "./commands/CreateEventTrackerCommand";
|
|
9
10
|
import { CreateFilterCommandInput, CreateFilterCommandOutput } from "./commands/CreateFilterCommand";
|
|
11
|
+
import { CreateRecommenderCommandInput, CreateRecommenderCommandOutput } from "./commands/CreateRecommenderCommand";
|
|
10
12
|
import { CreateSchemaCommandInput, CreateSchemaCommandOutput } from "./commands/CreateSchemaCommand";
|
|
11
13
|
import { CreateSolutionCommandInput, CreateSolutionCommandOutput } from "./commands/CreateSolutionCommand";
|
|
12
14
|
import { CreateSolutionVersionCommandInput, CreateSolutionVersionCommandOutput } from "./commands/CreateSolutionVersionCommand";
|
|
@@ -15,10 +17,12 @@ import { DeleteDatasetCommandInput, DeleteDatasetCommandOutput } from "./command
|
|
|
15
17
|
import { DeleteDatasetGroupCommandInput, DeleteDatasetGroupCommandOutput } from "./commands/DeleteDatasetGroupCommand";
|
|
16
18
|
import { DeleteEventTrackerCommandInput, DeleteEventTrackerCommandOutput } from "./commands/DeleteEventTrackerCommand";
|
|
17
19
|
import { DeleteFilterCommandInput, DeleteFilterCommandOutput } from "./commands/DeleteFilterCommand";
|
|
20
|
+
import { DeleteRecommenderCommandInput, DeleteRecommenderCommandOutput } from "./commands/DeleteRecommenderCommand";
|
|
18
21
|
import { DeleteSchemaCommandInput, DeleteSchemaCommandOutput } from "./commands/DeleteSchemaCommand";
|
|
19
22
|
import { DeleteSolutionCommandInput, DeleteSolutionCommandOutput } from "./commands/DeleteSolutionCommand";
|
|
20
23
|
import { DescribeAlgorithmCommandInput, DescribeAlgorithmCommandOutput } from "./commands/DescribeAlgorithmCommand";
|
|
21
24
|
import { DescribeBatchInferenceJobCommandInput, DescribeBatchInferenceJobCommandOutput } from "./commands/DescribeBatchInferenceJobCommand";
|
|
25
|
+
import { DescribeBatchSegmentJobCommandInput, DescribeBatchSegmentJobCommandOutput } from "./commands/DescribeBatchSegmentJobCommand";
|
|
22
26
|
import { DescribeCampaignCommandInput, DescribeCampaignCommandOutput } from "./commands/DescribeCampaignCommand";
|
|
23
27
|
import { DescribeDatasetCommandInput, DescribeDatasetCommandOutput } from "./commands/DescribeDatasetCommand";
|
|
24
28
|
import { DescribeDatasetExportJobCommandInput, DescribeDatasetExportJobCommandOutput } from "./commands/DescribeDatasetExportJobCommand";
|
|
@@ -28,11 +32,13 @@ import { DescribeEventTrackerCommandInput, DescribeEventTrackerCommandOutput } f
|
|
|
28
32
|
import { DescribeFeatureTransformationCommandInput, DescribeFeatureTransformationCommandOutput } from "./commands/DescribeFeatureTransformationCommand";
|
|
29
33
|
import { DescribeFilterCommandInput, DescribeFilterCommandOutput } from "./commands/DescribeFilterCommand";
|
|
30
34
|
import { DescribeRecipeCommandInput, DescribeRecipeCommandOutput } from "./commands/DescribeRecipeCommand";
|
|
35
|
+
import { DescribeRecommenderCommandInput, DescribeRecommenderCommandOutput } from "./commands/DescribeRecommenderCommand";
|
|
31
36
|
import { DescribeSchemaCommandInput, DescribeSchemaCommandOutput } from "./commands/DescribeSchemaCommand";
|
|
32
37
|
import { DescribeSolutionCommandInput, DescribeSolutionCommandOutput } from "./commands/DescribeSolutionCommand";
|
|
33
38
|
import { DescribeSolutionVersionCommandInput, DescribeSolutionVersionCommandOutput } from "./commands/DescribeSolutionVersionCommand";
|
|
34
39
|
import { GetSolutionMetricsCommandInput, GetSolutionMetricsCommandOutput } from "./commands/GetSolutionMetricsCommand";
|
|
35
40
|
import { ListBatchInferenceJobsCommandInput, ListBatchInferenceJobsCommandOutput } from "./commands/ListBatchInferenceJobsCommand";
|
|
41
|
+
import { ListBatchSegmentJobsCommandInput, ListBatchSegmentJobsCommandOutput } from "./commands/ListBatchSegmentJobsCommand";
|
|
36
42
|
import { ListCampaignsCommandInput, ListCampaignsCommandOutput } from "./commands/ListCampaignsCommand";
|
|
37
43
|
import { ListDatasetExportJobsCommandInput, ListDatasetExportJobsCommandOutput } from "./commands/ListDatasetExportJobsCommand";
|
|
38
44
|
import { ListDatasetGroupsCommandInput, ListDatasetGroupsCommandOutput } from "./commands/ListDatasetGroupsCommand";
|
|
@@ -41,11 +47,13 @@ import { ListDatasetsCommandInput, ListDatasetsCommandOutput } from "./commands/
|
|
|
41
47
|
import { ListEventTrackersCommandInput, ListEventTrackersCommandOutput } from "./commands/ListEventTrackersCommand";
|
|
42
48
|
import { ListFiltersCommandInput, ListFiltersCommandOutput } from "./commands/ListFiltersCommand";
|
|
43
49
|
import { ListRecipesCommandInput, ListRecipesCommandOutput } from "./commands/ListRecipesCommand";
|
|
50
|
+
import { ListRecommendersCommandInput, ListRecommendersCommandOutput } from "./commands/ListRecommendersCommand";
|
|
44
51
|
import { ListSchemasCommandInput, ListSchemasCommandOutput } from "./commands/ListSchemasCommand";
|
|
45
52
|
import { ListSolutionsCommandInput, ListSolutionsCommandOutput } from "./commands/ListSolutionsCommand";
|
|
46
53
|
import { ListSolutionVersionsCommandInput, ListSolutionVersionsCommandOutput } from "./commands/ListSolutionVersionsCommand";
|
|
47
54
|
import { StopSolutionVersionCreationCommandInput, StopSolutionVersionCreationCommandOutput } from "./commands/StopSolutionVersionCreationCommand";
|
|
48
55
|
import { UpdateCampaignCommandInput, UpdateCampaignCommandOutput } from "./commands/UpdateCampaignCommand";
|
|
56
|
+
import { UpdateRecommenderCommandInput, UpdateRecommenderCommandOutput } from "./commands/UpdateRecommenderCommand";
|
|
49
57
|
import { PersonalizeClient } from "./PersonalizeClient";
|
|
50
58
|
/**
|
|
51
59
|
* <p>Amazon Personalize is a machine learning service that makes it easy to add individualized
|
|
@@ -60,7 +68,14 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
60
68
|
createBatchInferenceJob(args: CreateBatchInferenceJobCommandInput, cb: (err: any, data?: CreateBatchInferenceJobCommandOutput) => void): void;
|
|
61
69
|
createBatchInferenceJob(args: CreateBatchInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBatchInferenceJobCommandOutput) => void): void;
|
|
62
70
|
/**
|
|
63
|
-
* <p>Creates a
|
|
71
|
+
* <p>Creates a batch segment job. The operation can handle up to 50 million records and the
|
|
72
|
+
* input file must be in JSON format. For more information, see <a>recommendations-batch</a>.</p>
|
|
73
|
+
*/
|
|
74
|
+
createBatchSegmentJob(args: CreateBatchSegmentJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateBatchSegmentJobCommandOutput>;
|
|
75
|
+
createBatchSegmentJob(args: CreateBatchSegmentJobCommandInput, cb: (err: any, data?: CreateBatchSegmentJobCommandOutput) => void): void;
|
|
76
|
+
createBatchSegmentJob(args: CreateBatchSegmentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBatchSegmentJobCommandOutput) => void): void;
|
|
77
|
+
/**
|
|
78
|
+
* <p>Creates a campaign that deploys a solution version. When a client calls the
|
|
64
79
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
|
|
65
80
|
* and
|
|
66
81
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html">GetPersonalizedRanking</a>
|
|
@@ -219,8 +234,8 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
219
234
|
createDatasetExportJob(args: CreateDatasetExportJobCommandInput, cb: (err: any, data?: CreateDatasetExportJobCommandOutput) => void): void;
|
|
220
235
|
createDatasetExportJob(args: CreateDatasetExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetExportJobCommandOutput) => void): void;
|
|
221
236
|
/**
|
|
222
|
-
* <p>Creates an empty dataset group. A dataset group
|
|
223
|
-
*
|
|
237
|
+
* <p>Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources.
|
|
238
|
+
* A dataset group can contain at most three datasets, one for each type of
|
|
224
239
|
* dataset:</p>
|
|
225
240
|
* <ul>
|
|
226
241
|
* <li>
|
|
@@ -233,9 +248,12 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
233
248
|
* <p>Users</p>
|
|
234
249
|
* </li>
|
|
235
250
|
* </ul>
|
|
236
|
-
* <p>
|
|
237
|
-
*
|
|
238
|
-
* dataset
|
|
251
|
+
* <p>
|
|
252
|
+
* A dataset group can be a Domain dataset group, where you specify a domain and use
|
|
253
|
+
* pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that
|
|
254
|
+
* you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as
|
|
255
|
+
* solutions and solution versions trained with recipes for custom use cases and deployed with campaigns.
|
|
256
|
+
* </p>
|
|
239
257
|
* <p>A dataset group can be in one of the following states:</p>
|
|
240
258
|
* <ul>
|
|
241
259
|
* <li>
|
|
@@ -403,11 +421,67 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
403
421
|
createFilter(args: CreateFilterCommandInput, options?: __HttpHandlerOptions): Promise<CreateFilterCommandOutput>;
|
|
404
422
|
createFilter(args: CreateFilterCommandInput, cb: (err: any, data?: CreateFilterCommandOutput) => void): void;
|
|
405
423
|
createFilter(args: CreateFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFilterCommandOutput) => void): void;
|
|
424
|
+
/**
|
|
425
|
+
* <p>Creates a recommender with the recipe (a Domain dataset group use case) you specify.
|
|
426
|
+
* You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a
|
|
427
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
|
|
428
|
+
* request.
|
|
429
|
+
* </p>
|
|
430
|
+
*
|
|
431
|
+
*
|
|
432
|
+
*
|
|
433
|
+
* <p>
|
|
434
|
+
* <b>Status</b>
|
|
435
|
+
* </p>
|
|
436
|
+
* <p>A recommender can be in one of the following states:</p>
|
|
437
|
+
* <ul>
|
|
438
|
+
* <li>
|
|
439
|
+
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
|
|
440
|
+
* </li>
|
|
441
|
+
* <li>
|
|
442
|
+
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
443
|
+
* </li>
|
|
444
|
+
* </ul>
|
|
445
|
+
* <p>To get the recommender status, call <a>DescribeRecommender</a>.</p>
|
|
446
|
+
* <note>
|
|
447
|
+
* <p>Wait until the <code>status</code> of the recommender
|
|
448
|
+
* is <code>ACTIVE</code> before asking the recommender for recommendations.</p>
|
|
449
|
+
* </note>
|
|
450
|
+
* <p class="title">
|
|
451
|
+
* <b>Related APIs</b>
|
|
452
|
+
* </p>
|
|
453
|
+
* <ul>
|
|
454
|
+
* <li>
|
|
455
|
+
* <p>
|
|
456
|
+
* <a>ListRecommenders</a>
|
|
457
|
+
* </p>
|
|
458
|
+
* </li>
|
|
459
|
+
* <li>
|
|
460
|
+
* <p>
|
|
461
|
+
* <a>DescribeRecommender</a>
|
|
462
|
+
* </p>
|
|
463
|
+
* </li>
|
|
464
|
+
* <li>
|
|
465
|
+
* <p>
|
|
466
|
+
* <a>UpdateRecommender</a>
|
|
467
|
+
* </p>
|
|
468
|
+
* </li>
|
|
469
|
+
* <li>
|
|
470
|
+
* <p>
|
|
471
|
+
* <a>DeleteRecommender</a>
|
|
472
|
+
* </p>
|
|
473
|
+
* </li>
|
|
474
|
+
* </ul>
|
|
475
|
+
*/
|
|
476
|
+
createRecommender(args: CreateRecommenderCommandInput, options?: __HttpHandlerOptions): Promise<CreateRecommenderCommandOutput>;
|
|
477
|
+
createRecommender(args: CreateRecommenderCommandInput, cb: (err: any, data?: CreateRecommenderCommandOutput) => void): void;
|
|
478
|
+
createRecommender(args: CreateRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRecommenderCommandOutput) => void): void;
|
|
406
479
|
/**
|
|
407
480
|
* <p>Creates an Amazon Personalize schema from the specified schema string. The schema you create
|
|
408
481
|
* must be in Avro JSON format.</p>
|
|
409
482
|
* <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.
|
|
483
|
+
* type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you
|
|
484
|
+
* provide the domain of the Domain dataset group.
|
|
411
485
|
* You specify a schema when you call <a>CreateDataset</a>.</p>
|
|
412
486
|
*
|
|
413
487
|
* <p class="title">
|
|
@@ -513,7 +587,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
513
587
|
createSolution(args: CreateSolutionCommandInput, cb: (err: any, data?: CreateSolutionCommandOutput) => void): void;
|
|
514
588
|
createSolution(args: CreateSolutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSolutionCommandOutput) => void): void;
|
|
515
589
|
/**
|
|
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
|
|
590
|
+
* <p>Trains or retrains an active solution in a Custom dataset group. A solution is created using the <a>CreateSolution</a> operation and must be in the ACTIVE state before calling
|
|
517
591
|
* <code>CreateSolutionVersion</code>. A new version of the solution is created every time you
|
|
518
592
|
* call this operation.</p>
|
|
519
593
|
* <p>
|
|
@@ -636,6 +710,13 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
636
710
|
deleteFilter(args: DeleteFilterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteFilterCommandOutput>;
|
|
637
711
|
deleteFilter(args: DeleteFilterCommandInput, cb: (err: any, data?: DeleteFilterCommandOutput) => void): void;
|
|
638
712
|
deleteFilter(args: DeleteFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFilterCommandOutput) => void): void;
|
|
713
|
+
/**
|
|
714
|
+
* <p>Deactivates and removes a recommender. A deleted recommender can no longer be specified in a <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
|
|
715
|
+
* request.</p>
|
|
716
|
+
*/
|
|
717
|
+
deleteRecommender(args: DeleteRecommenderCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRecommenderCommandOutput>;
|
|
718
|
+
deleteRecommender(args: DeleteRecommenderCommandInput, cb: (err: any, data?: DeleteRecommenderCommandOutput) => void): void;
|
|
719
|
+
deleteRecommender(args: DeleteRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRecommenderCommandOutput) => void): void;
|
|
639
720
|
/**
|
|
640
721
|
* <p>Deletes a schema. Before deleting a schema, you must delete all
|
|
641
722
|
* datasets referencing the schema. For more information on schemas, see
|
|
@@ -670,6 +751,14 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
670
751
|
describeBatchInferenceJob(args: DescribeBatchInferenceJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBatchInferenceJobCommandOutput>;
|
|
671
752
|
describeBatchInferenceJob(args: DescribeBatchInferenceJobCommandInput, cb: (err: any, data?: DescribeBatchInferenceJobCommandOutput) => void): void;
|
|
672
753
|
describeBatchInferenceJob(args: DescribeBatchInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBatchInferenceJobCommandOutput) => void): void;
|
|
754
|
+
/**
|
|
755
|
+
* <p>Gets the properties of a batch segment job including name, Amazon Resource Name (ARN),
|
|
756
|
+
* status, input and output configurations, and the ARN of the solution version used to generate
|
|
757
|
+
* segments.</p>
|
|
758
|
+
*/
|
|
759
|
+
describeBatchSegmentJob(args: DescribeBatchSegmentJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBatchSegmentJobCommandOutput>;
|
|
760
|
+
describeBatchSegmentJob(args: DescribeBatchSegmentJobCommandInput, cb: (err: any, data?: DescribeBatchSegmentJobCommandOutput) => void): void;
|
|
761
|
+
describeBatchSegmentJob(args: DescribeBatchSegmentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBatchSegmentJobCommandOutput) => void): void;
|
|
673
762
|
/**
|
|
674
763
|
* <p>Describes the given campaign, including its status.</p>
|
|
675
764
|
* <p>A campaign can be in one of the following states:</p>
|
|
@@ -758,6 +847,24 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
758
847
|
describeRecipe(args: DescribeRecipeCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRecipeCommandOutput>;
|
|
759
848
|
describeRecipe(args: DescribeRecipeCommandInput, cb: (err: any, data?: DescribeRecipeCommandOutput) => void): void;
|
|
760
849
|
describeRecipe(args: DescribeRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecipeCommandOutput) => void): void;
|
|
850
|
+
/**
|
|
851
|
+
* <p>Describes the given recommender, including its status.</p>
|
|
852
|
+
* <p>A recommender can be in one of the following states:</p>
|
|
853
|
+
* <ul>
|
|
854
|
+
* <li>
|
|
855
|
+
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
|
|
856
|
+
* </li>
|
|
857
|
+
* <li>
|
|
858
|
+
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
859
|
+
* </li>
|
|
860
|
+
* </ul>
|
|
861
|
+
* <p>When the <code>status</code> is <code>CREATE FAILED</code>, the response includes the
|
|
862
|
+
* <code>failureReason</code> key, which describes why.</p>
|
|
863
|
+
* <p>For more information on recommenders, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html">CreateRecommender</a>.</p>
|
|
864
|
+
*/
|
|
865
|
+
describeRecommender(args: DescribeRecommenderCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRecommenderCommandOutput>;
|
|
866
|
+
describeRecommender(args: DescribeRecommenderCommandInput, cb: (err: any, data?: DescribeRecommenderCommandOutput) => void): void;
|
|
867
|
+
describeRecommender(args: DescribeRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecommenderCommandOutput) => void): void;
|
|
761
868
|
/**
|
|
762
869
|
* <p>Describes a schema. For more information on schemas, see
|
|
763
870
|
* <a>CreateSchema</a>.</p>
|
|
@@ -791,6 +898,13 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
791
898
|
listBatchInferenceJobs(args: ListBatchInferenceJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListBatchInferenceJobsCommandOutput>;
|
|
792
899
|
listBatchInferenceJobs(args: ListBatchInferenceJobsCommandInput, cb: (err: any, data?: ListBatchInferenceJobsCommandOutput) => void): void;
|
|
793
900
|
listBatchInferenceJobs(args: ListBatchInferenceJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBatchInferenceJobsCommandOutput) => void): void;
|
|
901
|
+
/**
|
|
902
|
+
* <p>Gets a list of the batch segment jobs that have been performed off of a solution
|
|
903
|
+
* version that you specify.</p>
|
|
904
|
+
*/
|
|
905
|
+
listBatchSegmentJobs(args: ListBatchSegmentJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListBatchSegmentJobsCommandOutput>;
|
|
906
|
+
listBatchSegmentJobs(args: ListBatchSegmentJobsCommandInput, cb: (err: any, data?: ListBatchSegmentJobsCommandOutput) => void): void;
|
|
907
|
+
listBatchSegmentJobs(args: ListBatchSegmentJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBatchSegmentJobsCommandOutput) => void): void;
|
|
794
908
|
/**
|
|
795
909
|
* <p>Returns a list of campaigns that use the given solution.
|
|
796
910
|
* When a solution is not specified, all the campaigns associated with the account are listed.
|
|
@@ -858,6 +972,15 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
858
972
|
listRecipes(args: ListRecipesCommandInput, options?: __HttpHandlerOptions): Promise<ListRecipesCommandOutput>;
|
|
859
973
|
listRecipes(args: ListRecipesCommandInput, cb: (err: any, data?: ListRecipesCommandOutput) => void): void;
|
|
860
974
|
listRecipes(args: ListRecipesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecipesCommandOutput) => void): void;
|
|
975
|
+
/**
|
|
976
|
+
* <p>Returns a list of recommenders in a given Domain dataset group.
|
|
977
|
+
* When a Domain dataset group is not specified, all the recommenders associated with the account are listed.
|
|
978
|
+
* The response provides the properties for each recommender, including the Amazon Resource Name (ARN).
|
|
979
|
+
* For more information on recommenders, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html">CreateRecommender</a>.</p>
|
|
980
|
+
*/
|
|
981
|
+
listRecommenders(args: ListRecommendersCommandInput, options?: __HttpHandlerOptions): Promise<ListRecommendersCommandOutput>;
|
|
982
|
+
listRecommenders(args: ListRecommendersCommandInput, cb: (err: any, data?: ListRecommendersCommandOutput) => void): void;
|
|
983
|
+
listRecommenders(args: ListRecommendersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecommendersCommandOutput) => void): void;
|
|
861
984
|
/**
|
|
862
985
|
* <p>Returns the list of schemas associated with the account. The response provides the
|
|
863
986
|
* properties for each schema, including the Amazon Resource Name (ARN).
|
|
@@ -917,4 +1040,10 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
917
1040
|
updateCampaign(args: UpdateCampaignCommandInput, options?: __HttpHandlerOptions): Promise<UpdateCampaignCommandOutput>;
|
|
918
1041
|
updateCampaign(args: UpdateCampaignCommandInput, cb: (err: any, data?: UpdateCampaignCommandOutput) => void): void;
|
|
919
1042
|
updateCampaign(args: UpdateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCampaignCommandOutput) => void): void;
|
|
1043
|
+
/**
|
|
1044
|
+
* <p>Updates the recommender to modify the recommender configuration.</p>
|
|
1045
|
+
*/
|
|
1046
|
+
updateRecommender(args: UpdateRecommenderCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRecommenderCommandOutput>;
|
|
1047
|
+
updateRecommender(args: UpdateRecommenderCommandInput, cb: (err: any, data?: UpdateRecommenderCommandOutput) => void): void;
|
|
1048
|
+
updateRecommender(args: UpdateRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRecommenderCommandOutput) => void): void;
|
|
920
1049
|
}
|
|
@@ -7,6 +7,7 @@ import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
|
|
|
7
7
|
import { Client as __Client, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
|
|
8
8
|
import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
9
9
|
import { CreateBatchInferenceJobCommandInput, CreateBatchInferenceJobCommandOutput } from "./commands/CreateBatchInferenceJobCommand";
|
|
10
|
+
import { CreateBatchSegmentJobCommandInput, CreateBatchSegmentJobCommandOutput } from "./commands/CreateBatchSegmentJobCommand";
|
|
10
11
|
import { CreateCampaignCommandInput, CreateCampaignCommandOutput } from "./commands/CreateCampaignCommand";
|
|
11
12
|
import { CreateDatasetCommandInput, CreateDatasetCommandOutput } from "./commands/CreateDatasetCommand";
|
|
12
13
|
import { CreateDatasetExportJobCommandInput, CreateDatasetExportJobCommandOutput } from "./commands/CreateDatasetExportJobCommand";
|
|
@@ -14,6 +15,7 @@ import { CreateDatasetGroupCommandInput, CreateDatasetGroupCommandOutput } from
|
|
|
14
15
|
import { CreateDatasetImportJobCommandInput, CreateDatasetImportJobCommandOutput } from "./commands/CreateDatasetImportJobCommand";
|
|
15
16
|
import { CreateEventTrackerCommandInput, CreateEventTrackerCommandOutput } from "./commands/CreateEventTrackerCommand";
|
|
16
17
|
import { CreateFilterCommandInput, CreateFilterCommandOutput } from "./commands/CreateFilterCommand";
|
|
18
|
+
import { CreateRecommenderCommandInput, CreateRecommenderCommandOutput } from "./commands/CreateRecommenderCommand";
|
|
17
19
|
import { CreateSchemaCommandInput, CreateSchemaCommandOutput } from "./commands/CreateSchemaCommand";
|
|
18
20
|
import { CreateSolutionCommandInput, CreateSolutionCommandOutput } from "./commands/CreateSolutionCommand";
|
|
19
21
|
import { CreateSolutionVersionCommandInput, CreateSolutionVersionCommandOutput } from "./commands/CreateSolutionVersionCommand";
|
|
@@ -22,10 +24,12 @@ import { DeleteDatasetCommandInput, DeleteDatasetCommandOutput } from "./command
|
|
|
22
24
|
import { DeleteDatasetGroupCommandInput, DeleteDatasetGroupCommandOutput } from "./commands/DeleteDatasetGroupCommand";
|
|
23
25
|
import { DeleteEventTrackerCommandInput, DeleteEventTrackerCommandOutput } from "./commands/DeleteEventTrackerCommand";
|
|
24
26
|
import { DeleteFilterCommandInput, DeleteFilterCommandOutput } from "./commands/DeleteFilterCommand";
|
|
27
|
+
import { DeleteRecommenderCommandInput, DeleteRecommenderCommandOutput } from "./commands/DeleteRecommenderCommand";
|
|
25
28
|
import { DeleteSchemaCommandInput, DeleteSchemaCommandOutput } from "./commands/DeleteSchemaCommand";
|
|
26
29
|
import { DeleteSolutionCommandInput, DeleteSolutionCommandOutput } from "./commands/DeleteSolutionCommand";
|
|
27
30
|
import { DescribeAlgorithmCommandInput, DescribeAlgorithmCommandOutput } from "./commands/DescribeAlgorithmCommand";
|
|
28
31
|
import { DescribeBatchInferenceJobCommandInput, DescribeBatchInferenceJobCommandOutput } from "./commands/DescribeBatchInferenceJobCommand";
|
|
32
|
+
import { DescribeBatchSegmentJobCommandInput, DescribeBatchSegmentJobCommandOutput } from "./commands/DescribeBatchSegmentJobCommand";
|
|
29
33
|
import { DescribeCampaignCommandInput, DescribeCampaignCommandOutput } from "./commands/DescribeCampaignCommand";
|
|
30
34
|
import { DescribeDatasetCommandInput, DescribeDatasetCommandOutput } from "./commands/DescribeDatasetCommand";
|
|
31
35
|
import { DescribeDatasetExportJobCommandInput, DescribeDatasetExportJobCommandOutput } from "./commands/DescribeDatasetExportJobCommand";
|
|
@@ -35,11 +39,13 @@ import { DescribeEventTrackerCommandInput, DescribeEventTrackerCommandOutput } f
|
|
|
35
39
|
import { DescribeFeatureTransformationCommandInput, DescribeFeatureTransformationCommandOutput } from "./commands/DescribeFeatureTransformationCommand";
|
|
36
40
|
import { DescribeFilterCommandInput, DescribeFilterCommandOutput } from "./commands/DescribeFilterCommand";
|
|
37
41
|
import { DescribeRecipeCommandInput, DescribeRecipeCommandOutput } from "./commands/DescribeRecipeCommand";
|
|
42
|
+
import { DescribeRecommenderCommandInput, DescribeRecommenderCommandOutput } from "./commands/DescribeRecommenderCommand";
|
|
38
43
|
import { DescribeSchemaCommandInput, DescribeSchemaCommandOutput } from "./commands/DescribeSchemaCommand";
|
|
39
44
|
import { DescribeSolutionCommandInput, DescribeSolutionCommandOutput } from "./commands/DescribeSolutionCommand";
|
|
40
45
|
import { DescribeSolutionVersionCommandInput, DescribeSolutionVersionCommandOutput } from "./commands/DescribeSolutionVersionCommand";
|
|
41
46
|
import { GetSolutionMetricsCommandInput, GetSolutionMetricsCommandOutput } from "./commands/GetSolutionMetricsCommand";
|
|
42
47
|
import { ListBatchInferenceJobsCommandInput, ListBatchInferenceJobsCommandOutput } from "./commands/ListBatchInferenceJobsCommand";
|
|
48
|
+
import { ListBatchSegmentJobsCommandInput, ListBatchSegmentJobsCommandOutput } from "./commands/ListBatchSegmentJobsCommand";
|
|
43
49
|
import { ListCampaignsCommandInput, ListCampaignsCommandOutput } from "./commands/ListCampaignsCommand";
|
|
44
50
|
import { ListDatasetExportJobsCommandInput, ListDatasetExportJobsCommandOutput } from "./commands/ListDatasetExportJobsCommand";
|
|
45
51
|
import { ListDatasetGroupsCommandInput, ListDatasetGroupsCommandOutput } from "./commands/ListDatasetGroupsCommand";
|
|
@@ -48,13 +54,15 @@ import { ListDatasetsCommandInput, ListDatasetsCommandOutput } from "./commands/
|
|
|
48
54
|
import { ListEventTrackersCommandInput, ListEventTrackersCommandOutput } from "./commands/ListEventTrackersCommand";
|
|
49
55
|
import { ListFiltersCommandInput, ListFiltersCommandOutput } from "./commands/ListFiltersCommand";
|
|
50
56
|
import { ListRecipesCommandInput, ListRecipesCommandOutput } from "./commands/ListRecipesCommand";
|
|
57
|
+
import { ListRecommendersCommandInput, ListRecommendersCommandOutput } from "./commands/ListRecommendersCommand";
|
|
51
58
|
import { ListSchemasCommandInput, ListSchemasCommandOutput } from "./commands/ListSchemasCommand";
|
|
52
59
|
import { ListSolutionsCommandInput, ListSolutionsCommandOutput } from "./commands/ListSolutionsCommand";
|
|
53
60
|
import { ListSolutionVersionsCommandInput, ListSolutionVersionsCommandOutput } from "./commands/ListSolutionVersionsCommand";
|
|
54
61
|
import { StopSolutionVersionCreationCommandInput, StopSolutionVersionCreationCommandOutput } from "./commands/StopSolutionVersionCreationCommand";
|
|
55
62
|
import { UpdateCampaignCommandInput, UpdateCampaignCommandOutput } from "./commands/UpdateCampaignCommand";
|
|
56
|
-
|
|
57
|
-
export declare type
|
|
63
|
+
import { UpdateRecommenderCommandInput, UpdateRecommenderCommandOutput } from "./commands/UpdateRecommenderCommand";
|
|
64
|
+
export declare type ServiceInputTypes = CreateBatchInferenceJobCommandInput | CreateBatchSegmentJobCommandInput | CreateCampaignCommandInput | CreateDatasetCommandInput | CreateDatasetExportJobCommandInput | CreateDatasetGroupCommandInput | CreateDatasetImportJobCommandInput | CreateEventTrackerCommandInput | CreateFilterCommandInput | CreateRecommenderCommandInput | CreateSchemaCommandInput | CreateSolutionCommandInput | CreateSolutionVersionCommandInput | DeleteCampaignCommandInput | DeleteDatasetCommandInput | DeleteDatasetGroupCommandInput | DeleteEventTrackerCommandInput | DeleteFilterCommandInput | DeleteRecommenderCommandInput | DeleteSchemaCommandInput | DeleteSolutionCommandInput | DescribeAlgorithmCommandInput | DescribeBatchInferenceJobCommandInput | DescribeBatchSegmentJobCommandInput | DescribeCampaignCommandInput | DescribeDatasetCommandInput | DescribeDatasetExportJobCommandInput | DescribeDatasetGroupCommandInput | DescribeDatasetImportJobCommandInput | DescribeEventTrackerCommandInput | DescribeFeatureTransformationCommandInput | DescribeFilterCommandInput | DescribeRecipeCommandInput | DescribeRecommenderCommandInput | DescribeSchemaCommandInput | DescribeSolutionCommandInput | DescribeSolutionVersionCommandInput | GetSolutionMetricsCommandInput | ListBatchInferenceJobsCommandInput | ListBatchSegmentJobsCommandInput | ListCampaignsCommandInput | ListDatasetExportJobsCommandInput | ListDatasetGroupsCommandInput | ListDatasetImportJobsCommandInput | ListDatasetsCommandInput | ListEventTrackersCommandInput | ListFiltersCommandInput | ListRecipesCommandInput | ListRecommendersCommandInput | ListSchemasCommandInput | ListSolutionVersionsCommandInput | ListSolutionsCommandInput | StopSolutionVersionCreationCommandInput | UpdateCampaignCommandInput | UpdateRecommenderCommandInput;
|
|
65
|
+
export declare type ServiceOutputTypes = CreateBatchInferenceJobCommandOutput | CreateBatchSegmentJobCommandOutput | CreateCampaignCommandOutput | CreateDatasetCommandOutput | CreateDatasetExportJobCommandOutput | CreateDatasetGroupCommandOutput | CreateDatasetImportJobCommandOutput | CreateEventTrackerCommandOutput | CreateFilterCommandOutput | CreateRecommenderCommandOutput | CreateSchemaCommandOutput | CreateSolutionCommandOutput | CreateSolutionVersionCommandOutput | DeleteCampaignCommandOutput | DeleteDatasetCommandOutput | DeleteDatasetGroupCommandOutput | DeleteEventTrackerCommandOutput | DeleteFilterCommandOutput | DeleteRecommenderCommandOutput | DeleteSchemaCommandOutput | DeleteSolutionCommandOutput | DescribeAlgorithmCommandOutput | DescribeBatchInferenceJobCommandOutput | DescribeBatchSegmentJobCommandOutput | DescribeCampaignCommandOutput | DescribeDatasetCommandOutput | DescribeDatasetExportJobCommandOutput | DescribeDatasetGroupCommandOutput | DescribeDatasetImportJobCommandOutput | DescribeEventTrackerCommandOutput | DescribeFeatureTransformationCommandOutput | DescribeFilterCommandOutput | DescribeRecipeCommandOutput | DescribeRecommenderCommandOutput | DescribeSchemaCommandOutput | DescribeSolutionCommandOutput | DescribeSolutionVersionCommandOutput | GetSolutionMetricsCommandOutput | ListBatchInferenceJobsCommandOutput | ListBatchSegmentJobsCommandOutput | ListCampaignsCommandOutput | ListDatasetExportJobsCommandOutput | ListDatasetGroupsCommandOutput | ListDatasetImportJobsCommandOutput | ListDatasetsCommandOutput | ListEventTrackersCommandOutput | ListFiltersCommandOutput | ListRecipesCommandOutput | ListRecommendersCommandOutput | ListSchemasCommandOutput | ListSolutionVersionsCommandOutput | ListSolutionsCommandOutput | StopSolutionVersionCreationCommandOutput | UpdateCampaignCommandOutput | UpdateRecommenderCommandOutput;
|
|
58
66
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
59
67
|
/**
|
|
60
68
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
@@ -21,7 +21,7 @@ export interface CreateBatchInferenceJobCommandOutput extends CreateBatchInferen
|
|
|
21
21
|
*
|
|
22
22
|
* @see {@link CreateBatchInferenceJobCommandInput} for command's `input` shape.
|
|
23
23
|
* @see {@link CreateBatchInferenceJobCommandOutput} for command's `response` shape.
|
|
24
|
-
* @see {@link PersonalizeClientResolvedConfig | config} for
|
|
24
|
+
* @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
|
|
25
25
|
*
|
|
26
26
|
*/
|
|
27
27
|
export declare class CreateBatchInferenceJobCommand extends $Command<CreateBatchInferenceJobCommandInput, CreateBatchInferenceJobCommandOutput, PersonalizeClientResolvedConfig> {
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { CreateBatchSegmentJobRequest, CreateBatchSegmentJobResponse } from "../models/models_0";
|
|
4
|
+
import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
|
|
5
|
+
export interface CreateBatchSegmentJobCommandInput extends CreateBatchSegmentJobRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface CreateBatchSegmentJobCommandOutput extends CreateBatchSegmentJobResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Creates a batch segment job. The operation can handle up to 50 million records and the
|
|
11
|
+
* input file must be in JSON format. For more information, see <a>recommendations-batch</a>.</p>
|
|
12
|
+
* @example
|
|
13
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
14
|
+
* ```javascript
|
|
15
|
+
* import { PersonalizeClient, CreateBatchSegmentJobCommand } from "@aws-sdk/client-personalize"; // ES Modules import
|
|
16
|
+
* // const { PersonalizeClient, CreateBatchSegmentJobCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
|
|
17
|
+
* const client = new PersonalizeClient(config);
|
|
18
|
+
* const command = new CreateBatchSegmentJobCommand(input);
|
|
19
|
+
* const response = await client.send(command);
|
|
20
|
+
* ```
|
|
21
|
+
*
|
|
22
|
+
* @see {@link CreateBatchSegmentJobCommandInput} for command's `input` shape.
|
|
23
|
+
* @see {@link CreateBatchSegmentJobCommandOutput} for command's `response` shape.
|
|
24
|
+
* @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
|
|
25
|
+
*
|
|
26
|
+
*/
|
|
27
|
+
export declare class CreateBatchSegmentJobCommand extends $Command<CreateBatchSegmentJobCommandInput, CreateBatchSegmentJobCommandOutput, PersonalizeClientResolvedConfig> {
|
|
28
|
+
readonly input: CreateBatchSegmentJobCommandInput;
|
|
29
|
+
constructor(input: CreateBatchSegmentJobCommandInput);
|
|
30
|
+
/**
|
|
31
|
+
* @internal
|
|
32
|
+
*/
|
|
33
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBatchSegmentJobCommandInput, CreateBatchSegmentJobCommandOutput>;
|
|
34
|
+
private serialize;
|
|
35
|
+
private deserialize;
|
|
36
|
+
}
|
|
@@ -7,7 +7,7 @@ export interface CreateCampaignCommandInput extends CreateCampaignRequest {
|
|
|
7
7
|
export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a campaign
|
|
10
|
+
* <p>Creates a campaign that deploys a solution version. When a client calls the
|
|
11
11
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
|
|
12
12
|
* and
|
|
13
13
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html">GetPersonalizedRanking</a>
|
|
@@ -90,7 +90,7 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
90
90
|
*
|
|
91
91
|
* @see {@link CreateCampaignCommandInput} for command's `input` shape.
|
|
92
92
|
* @see {@link CreateCampaignCommandOutput} for command's `response` shape.
|
|
93
|
-
* @see {@link PersonalizeClientResolvedConfig | config} for
|
|
93
|
+
* @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
|
|
94
94
|
*
|
|
95
95
|
*/
|
|
96
96
|
export declare class CreateCampaignCommand extends $Command<CreateCampaignCommandInput, CreateCampaignCommandOutput, PersonalizeClientResolvedConfig> {
|
|
@@ -70,7 +70,7 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
|
|
|
70
70
|
*
|
|
71
71
|
* @see {@link CreateDatasetCommandInput} for command's `input` shape.
|
|
72
72
|
* @see {@link CreateDatasetCommandOutput} for command's `response` shape.
|
|
73
|
-
* @see {@link PersonalizeClientResolvedConfig | config} for
|
|
73
|
+
* @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
|
|
74
74
|
*
|
|
75
75
|
*/
|
|
76
76
|
export declare class CreateDatasetCommand extends $Command<CreateDatasetCommandInput, CreateDatasetCommandOutput, PersonalizeClientResolvedConfig> {
|
|
@@ -41,7 +41,7 @@ export interface CreateDatasetExportJobCommandOutput extends CreateDatasetExport
|
|
|
41
41
|
*
|
|
42
42
|
* @see {@link CreateDatasetExportJobCommandInput} for command's `input` shape.
|
|
43
43
|
* @see {@link CreateDatasetExportJobCommandOutput} for command's `response` shape.
|
|
44
|
-
* @see {@link PersonalizeClientResolvedConfig | config} for
|
|
44
|
+
* @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
|
|
45
45
|
*
|
|
46
46
|
*/
|
|
47
47
|
export declare class CreateDatasetExportJobCommand extends $Command<CreateDatasetExportJobCommandInput, CreateDatasetExportJobCommandOutput, PersonalizeClientResolvedConfig> {
|
|
@@ -7,8 +7,8 @@ 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
|
|
11
|
-
*
|
|
10
|
+
* <p>Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources.
|
|
11
|
+
* A dataset group can contain at most three datasets, one for each type of
|
|
12
12
|
* dataset:</p>
|
|
13
13
|
* <ul>
|
|
14
14
|
* <li>
|
|
@@ -21,9 +21,12 @@ export interface CreateDatasetGroupCommandOutput extends CreateDatasetGroupRespo
|
|
|
21
21
|
* <p>Users</p>
|
|
22
22
|
* </li>
|
|
23
23
|
* </ul>
|
|
24
|
-
* <p>
|
|
25
|
-
*
|
|
26
|
-
* dataset
|
|
24
|
+
* <p>
|
|
25
|
+
* A dataset group can be a Domain dataset group, where you specify a domain and use
|
|
26
|
+
* pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that
|
|
27
|
+
* you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as
|
|
28
|
+
* solutions and solution versions trained with recipes for custom use cases and deployed with campaigns.
|
|
29
|
+
* </p>
|
|
27
30
|
* <p>A dataset group can be in one of the following states:</p>
|
|
28
31
|
* <ul>
|
|
29
32
|
* <li>
|
|
@@ -95,7 +98,7 @@ export interface CreateDatasetGroupCommandOutput extends CreateDatasetGroupRespo
|
|
|
95
98
|
*
|
|
96
99
|
* @see {@link CreateDatasetGroupCommandInput} for command's `input` shape.
|
|
97
100
|
* @see {@link CreateDatasetGroupCommandOutput} for command's `response` shape.
|
|
98
|
-
* @see {@link PersonalizeClientResolvedConfig | config} for
|
|
101
|
+
* @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
|
|
99
102
|
*
|
|
100
103
|
*/
|
|
101
104
|
export declare class CreateDatasetGroupCommand extends $Command<CreateDatasetGroupCommandInput, CreateDatasetGroupCommandOutput, PersonalizeClientResolvedConfig> {
|
|
@@ -61,7 +61,7 @@ export interface CreateDatasetImportJobCommandOutput extends CreateDatasetImport
|
|
|
61
61
|
*
|
|
62
62
|
* @see {@link CreateDatasetImportJobCommandInput} for command's `input` shape.
|
|
63
63
|
* @see {@link CreateDatasetImportJobCommandOutput} for command's `response` shape.
|
|
64
|
-
* @see {@link PersonalizeClientResolvedConfig | config} for
|
|
64
|
+
* @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
|
|
65
65
|
*
|
|
66
66
|
*/
|
|
67
67
|
export declare class CreateDatasetImportJobCommand extends $Command<CreateDatasetImportJobCommandInput, CreateDatasetImportJobCommandOutput, PersonalizeClientResolvedConfig> {
|
|
@@ -65,7 +65,7 @@ export interface CreateEventTrackerCommandOutput extends CreateEventTrackerRespo
|
|
|
65
65
|
*
|
|
66
66
|
* @see {@link CreateEventTrackerCommandInput} for command's `input` shape.
|
|
67
67
|
* @see {@link CreateEventTrackerCommandOutput} for command's `response` shape.
|
|
68
|
-
* @see {@link PersonalizeClientResolvedConfig | config} for
|
|
68
|
+
* @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
|
|
69
69
|
*
|
|
70
70
|
*/
|
|
71
71
|
export declare class CreateEventTrackerCommand extends $Command<CreateEventTrackerCommandInput, CreateEventTrackerCommandOutput, PersonalizeClientResolvedConfig> {
|
|
@@ -20,7 +20,7 @@ export interface CreateFilterCommandOutput extends CreateFilterResponse, __Metad
|
|
|
20
20
|
*
|
|
21
21
|
* @see {@link CreateFilterCommandInput} for command's `input` shape.
|
|
22
22
|
* @see {@link CreateFilterCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link PersonalizeClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
export declare class CreateFilterCommand extends $Command<CreateFilterCommandInput, CreateFilterCommandOutput, PersonalizeClientResolvedConfig> {
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { CreateRecommenderRequest, CreateRecommenderResponse } from "../models/models_0";
|
|
4
|
+
import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
|
|
5
|
+
export interface CreateRecommenderCommandInput extends CreateRecommenderRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface CreateRecommenderCommandOutput extends CreateRecommenderResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Creates a recommender with the recipe (a Domain dataset group use case) you specify.
|
|
11
|
+
* You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a
|
|
12
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
|
|
13
|
+
* request.
|
|
14
|
+
* </p>
|
|
15
|
+
*
|
|
16
|
+
*
|
|
17
|
+
*
|
|
18
|
+
* <p>
|
|
19
|
+
* <b>Status</b>
|
|
20
|
+
* </p>
|
|
21
|
+
* <p>A recommender can be in one of the following states:</p>
|
|
22
|
+
* <ul>
|
|
23
|
+
* <li>
|
|
24
|
+
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
|
|
25
|
+
* </li>
|
|
26
|
+
* <li>
|
|
27
|
+
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
28
|
+
* </li>
|
|
29
|
+
* </ul>
|
|
30
|
+
* <p>To get the recommender status, call <a>DescribeRecommender</a>.</p>
|
|
31
|
+
* <note>
|
|
32
|
+
* <p>Wait until the <code>status</code> of the recommender
|
|
33
|
+
* is <code>ACTIVE</code> before asking the recommender for recommendations.</p>
|
|
34
|
+
* </note>
|
|
35
|
+
* <p class="title">
|
|
36
|
+
* <b>Related APIs</b>
|
|
37
|
+
* </p>
|
|
38
|
+
* <ul>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>
|
|
41
|
+
* <a>ListRecommenders</a>
|
|
42
|
+
* </p>
|
|
43
|
+
* </li>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>
|
|
46
|
+
* <a>DescribeRecommender</a>
|
|
47
|
+
* </p>
|
|
48
|
+
* </li>
|
|
49
|
+
* <li>
|
|
50
|
+
* <p>
|
|
51
|
+
* <a>UpdateRecommender</a>
|
|
52
|
+
* </p>
|
|
53
|
+
* </li>
|
|
54
|
+
* <li>
|
|
55
|
+
* <p>
|
|
56
|
+
* <a>DeleteRecommender</a>
|
|
57
|
+
* </p>
|
|
58
|
+
* </li>
|
|
59
|
+
* </ul>
|
|
60
|
+
* @example
|
|
61
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
62
|
+
* ```javascript
|
|
63
|
+
* import { PersonalizeClient, CreateRecommenderCommand } from "@aws-sdk/client-personalize"; // ES Modules import
|
|
64
|
+
* // const { PersonalizeClient, CreateRecommenderCommand } = require("@aws-sdk/client-personalize"); // CommonJS import
|
|
65
|
+
* const client = new PersonalizeClient(config);
|
|
66
|
+
* const command = new CreateRecommenderCommand(input);
|
|
67
|
+
* const response = await client.send(command);
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
70
|
+
* @see {@link CreateRecommenderCommandInput} for command's `input` shape.
|
|
71
|
+
* @see {@link CreateRecommenderCommandOutput} for command's `response` shape.
|
|
72
|
+
* @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
|
|
73
|
+
*
|
|
74
|
+
*/
|
|
75
|
+
export declare class CreateRecommenderCommand extends $Command<CreateRecommenderCommandInput, CreateRecommenderCommandOutput, PersonalizeClientResolvedConfig> {
|
|
76
|
+
readonly input: CreateRecommenderCommandInput;
|
|
77
|
+
constructor(input: CreateRecommenderCommandInput);
|
|
78
|
+
/**
|
|
79
|
+
* @internal
|
|
80
|
+
*/
|
|
81
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateRecommenderCommandInput, CreateRecommenderCommandOutput>;
|
|
82
|
+
private serialize;
|
|
83
|
+
private deserialize;
|
|
84
|
+
}
|
|
@@ -10,7 +10,8 @@ export interface CreateSchemaCommandOutput extends CreateSchemaResponse, __Metad
|
|
|
10
10
|
* <p>Creates an Amazon Personalize schema from the specified schema string. The schema you create
|
|
11
11
|
* must be in Avro JSON format.</p>
|
|
12
12
|
* <p>Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset
|
|
13
|
-
* type and has a set of required field and keywords.
|
|
13
|
+
* type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you
|
|
14
|
+
* provide the domain of the Domain dataset group.
|
|
14
15
|
* You specify a schema when you call <a>CreateDataset</a>.</p>
|
|
15
16
|
*
|
|
16
17
|
* <p class="title">
|
|
@@ -45,7 +46,7 @@ export interface CreateSchemaCommandOutput extends CreateSchemaResponse, __Metad
|
|
|
45
46
|
*
|
|
46
47
|
* @see {@link CreateSchemaCommandInput} for command's `input` shape.
|
|
47
48
|
* @see {@link CreateSchemaCommandOutput} for command's `response` shape.
|
|
48
|
-
* @see {@link PersonalizeClientResolvedConfig | config} for
|
|
49
|
+
* @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
|
|
49
50
|
*
|
|
50
51
|
*/
|
|
51
52
|
export declare class CreateSchemaCommand extends $Command<CreateSchemaCommandInput, CreateSchemaCommandOutput, PersonalizeClientResolvedConfig> {
|