@aws-sdk/client-personalize 3.295.0 → 3.297.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/Personalize.d.ts +67 -0
- package/dist-types/PersonalizeClient.d.ts +24 -4
- package/dist-types/commands/CreateBatchInferenceJobCommand.d.ts +16 -0
- package/dist-types/commands/CreateBatchSegmentJobCommand.d.ts +16 -0
- package/dist-types/commands/CreateCampaignCommand.d.ts +16 -0
- package/dist-types/commands/CreateDatasetCommand.d.ts +16 -0
- package/dist-types/commands/CreateDatasetExportJobCommand.d.ts +16 -0
- package/dist-types/commands/CreateDatasetGroupCommand.d.ts +16 -0
- package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +16 -0
- package/dist-types/commands/CreateEventTrackerCommand.d.ts +16 -0
- package/dist-types/commands/CreateFilterCommand.d.ts +16 -0
- package/dist-types/commands/CreateMetricAttributionCommand.d.ts +16 -0
- package/dist-types/commands/CreateRecommenderCommand.d.ts +16 -0
- package/dist-types/commands/CreateSchemaCommand.d.ts +16 -0
- package/dist-types/commands/CreateSolutionCommand.d.ts +16 -0
- package/dist-types/commands/CreateSolutionVersionCommand.d.ts +16 -0
- package/dist-types/commands/DeleteCampaignCommand.d.ts +16 -0
- package/dist-types/commands/DeleteDatasetCommand.d.ts +16 -0
- package/dist-types/commands/DeleteDatasetGroupCommand.d.ts +16 -0
- package/dist-types/commands/DeleteEventTrackerCommand.d.ts +16 -0
- package/dist-types/commands/DeleteFilterCommand.d.ts +16 -0
- package/dist-types/commands/DeleteMetricAttributionCommand.d.ts +16 -0
- package/dist-types/commands/DeleteRecommenderCommand.d.ts +16 -0
- package/dist-types/commands/DeleteSchemaCommand.d.ts +16 -0
- package/dist-types/commands/DeleteSolutionCommand.d.ts +16 -0
- package/dist-types/commands/DescribeAlgorithmCommand.d.ts +16 -0
- package/dist-types/commands/DescribeBatchInferenceJobCommand.d.ts +16 -0
- package/dist-types/commands/DescribeBatchSegmentJobCommand.d.ts +16 -0
- package/dist-types/commands/DescribeCampaignCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDatasetCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDatasetExportJobCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +16 -0
- package/dist-types/commands/DescribeEventTrackerCommand.d.ts +16 -0
- package/dist-types/commands/DescribeFeatureTransformationCommand.d.ts +16 -0
- package/dist-types/commands/DescribeFilterCommand.d.ts +16 -0
- package/dist-types/commands/DescribeMetricAttributionCommand.d.ts +16 -0
- package/dist-types/commands/DescribeRecipeCommand.d.ts +16 -0
- package/dist-types/commands/DescribeRecommenderCommand.d.ts +16 -0
- package/dist-types/commands/DescribeSchemaCommand.d.ts +16 -0
- package/dist-types/commands/DescribeSolutionCommand.d.ts +16 -0
- package/dist-types/commands/DescribeSolutionVersionCommand.d.ts +16 -0
- package/dist-types/commands/GetSolutionMetricsCommand.d.ts +16 -0
- package/dist-types/commands/ListBatchInferenceJobsCommand.d.ts +16 -0
- package/dist-types/commands/ListBatchSegmentJobsCommand.d.ts +16 -0
- package/dist-types/commands/ListCampaignsCommand.d.ts +16 -0
- package/dist-types/commands/ListDatasetExportJobsCommand.d.ts +16 -0
- package/dist-types/commands/ListDatasetGroupsCommand.d.ts +16 -0
- package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +16 -0
- package/dist-types/commands/ListDatasetsCommand.d.ts +16 -0
- package/dist-types/commands/ListEventTrackersCommand.d.ts +16 -0
- package/dist-types/commands/ListFiltersCommand.d.ts +16 -0
- package/dist-types/commands/ListMetricAttributionMetricsCommand.d.ts +16 -0
- package/dist-types/commands/ListMetricAttributionsCommand.d.ts +16 -0
- package/dist-types/commands/ListRecipesCommand.d.ts +16 -0
- package/dist-types/commands/ListRecommendersCommand.d.ts +16 -0
- package/dist-types/commands/ListSchemasCommand.d.ts +16 -0
- package/dist-types/commands/ListSolutionVersionsCommand.d.ts +16 -0
- package/dist-types/commands/ListSolutionsCommand.d.ts +16 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
- package/dist-types/commands/StartRecommenderCommand.d.ts +16 -0
- package/dist-types/commands/StopRecommenderCommand.d.ts +16 -0
- package/dist-types/commands/StopSolutionVersionCreationCommand.d.ts +16 -0
- package/dist-types/commands/TagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateCampaignCommand.d.ts +16 -0
- package/dist-types/commands/UpdateMetricAttributionCommand.d.ts +16 -0
- package/dist-types/commands/UpdateRecommenderCommand.d.ts +16 -0
- package/dist-types/models/PersonalizeServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +456 -0
- package/dist-types/pagination/Interfaces.d.ts +3 -0
- package/dist-types/pagination/ListBatchInferenceJobsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListBatchSegmentJobsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListCampaignsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListDatasetExportJobsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListDatasetGroupsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListDatasetImportJobsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListDatasetsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListEventTrackersPaginator.d.ts +3 -0
- package/dist-types/pagination/ListFiltersPaginator.d.ts +3 -0
- package/dist-types/pagination/ListMetricAttributionMetricsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListMetricAttributionsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListRecipesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListRecommendersPaginator.d.ts +3 -0
- package/dist-types/pagination/ListSchemasPaginator.d.ts +3 -0
- package/dist-types/pagination/ListSolutionVersionsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListSolutionsPaginator.d.ts +3 -0
- package/package.json +29 -29
|
@@ -67,11 +67,13 @@ import { UpdateMetricAttributionCommandInput, UpdateMetricAttributionCommandOutp
|
|
|
67
67
|
import { UpdateRecommenderCommandInput, UpdateRecommenderCommandOutput } from "./commands/UpdateRecommenderCommand";
|
|
68
68
|
import { PersonalizeClient } from "./PersonalizeClient";
|
|
69
69
|
/**
|
|
70
|
+
* @public
|
|
70
71
|
* <p>Amazon Personalize is a machine learning service that makes it easy to add individualized
|
|
71
72
|
* recommendations to customers.</p>
|
|
72
73
|
*/
|
|
73
74
|
export declare class Personalize extends PersonalizeClient {
|
|
74
75
|
/**
|
|
76
|
+
* @public
|
|
75
77
|
* <p>Creates a batch inference job. The operation can handle up to 50 million records and the
|
|
76
78
|
* input file must be in JSON format. For more information, see
|
|
77
79
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/creating-batch-inference-job.html">Creating a batch inference job</a>.
|
|
@@ -81,6 +83,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
81
83
|
createBatchInferenceJob(args: CreateBatchInferenceJobCommandInput, cb: (err: any, data?: CreateBatchInferenceJobCommandOutput) => void): void;
|
|
82
84
|
createBatchInferenceJob(args: CreateBatchInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBatchInferenceJobCommandOutput) => void): void;
|
|
83
85
|
/**
|
|
86
|
+
* @public
|
|
84
87
|
* <p>Creates a batch segment job. The operation can handle up to 50 million records and the
|
|
85
88
|
* input file must be in JSON format. For more information, see
|
|
86
89
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/recommendations-batch.html">Getting batch recommendations and user segments</a>.</p>
|
|
@@ -89,6 +92,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
89
92
|
createBatchSegmentJob(args: CreateBatchSegmentJobCommandInput, cb: (err: any, data?: CreateBatchSegmentJobCommandOutput) => void): void;
|
|
90
93
|
createBatchSegmentJob(args: CreateBatchSegmentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBatchSegmentJobCommandOutput) => void): void;
|
|
91
94
|
/**
|
|
95
|
+
* @public
|
|
92
96
|
* <p>Creates a campaign that deploys a solution version. When a client calls the
|
|
93
97
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
|
|
94
98
|
* and
|
|
@@ -164,6 +168,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
164
168
|
createCampaign(args: CreateCampaignCommandInput, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void;
|
|
165
169
|
createCampaign(args: CreateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void;
|
|
166
170
|
/**
|
|
171
|
+
* @public
|
|
167
172
|
* <p>Creates an empty dataset and adds it to the specified dataset group.
|
|
168
173
|
* Use <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> to import your training data to a
|
|
169
174
|
* dataset.</p>
|
|
@@ -224,6 +229,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
224
229
|
createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
|
|
225
230
|
createDataset(args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
|
|
226
231
|
/**
|
|
232
|
+
* @public
|
|
227
233
|
* <p> Creates a job that exports data from your dataset to an Amazon S3 bucket.
|
|
228
234
|
* To allow Amazon Personalize to export the training data, you must specify an
|
|
229
235
|
* service-linked IAM role that gives Amazon Personalize <code>PutObject</code>
|
|
@@ -248,6 +254,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
248
254
|
createDatasetExportJob(args: CreateDatasetExportJobCommandInput, cb: (err: any, data?: CreateDatasetExportJobCommandOutput) => void): void;
|
|
249
255
|
createDatasetExportJob(args: CreateDatasetExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetExportJobCommandOutput) => void): void;
|
|
250
256
|
/**
|
|
257
|
+
* @public
|
|
251
258
|
* <p>Creates an empty dataset group. A dataset group is a container for
|
|
252
259
|
* Amazon Personalize resources. A dataset group can contain at most three datasets, one
|
|
253
260
|
* for each type of dataset:</p>
|
|
@@ -334,6 +341,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
334
341
|
createDatasetGroup(args: CreateDatasetGroupCommandInput, cb: (err: any, data?: CreateDatasetGroupCommandOutput) => void): void;
|
|
335
342
|
createDatasetGroup(args: CreateDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetGroupCommandOutput) => void): void;
|
|
336
343
|
/**
|
|
344
|
+
* @public
|
|
337
345
|
* <p>Creates a job that imports training data from your data source (an
|
|
338
346
|
* Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the
|
|
339
347
|
* training data, you must specify an IAM service role that has permission to
|
|
@@ -387,6 +395,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
387
395
|
createDatasetImportJob(args: CreateDatasetImportJobCommandInput, cb: (err: any, data?: CreateDatasetImportJobCommandOutput) => void): void;
|
|
388
396
|
createDatasetImportJob(args: CreateDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetImportJobCommandOutput) => void): void;
|
|
389
397
|
/**
|
|
398
|
+
* @public
|
|
390
399
|
* <p>Creates an event tracker that you use when adding event data to a specified dataset
|
|
391
400
|
* group using the
|
|
392
401
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html">PutEvents</a> API.</p>
|
|
@@ -438,12 +447,14 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
438
447
|
createEventTracker(args: CreateEventTrackerCommandInput, cb: (err: any, data?: CreateEventTrackerCommandOutput) => void): void;
|
|
439
448
|
createEventTracker(args: CreateEventTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventTrackerCommandOutput) => void): void;
|
|
440
449
|
/**
|
|
450
|
+
* @public
|
|
441
451
|
* <p>Creates a recommendation filter. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering recommendations and user segments</a>.</p>
|
|
442
452
|
*/
|
|
443
453
|
createFilter(args: CreateFilterCommandInput, options?: __HttpHandlerOptions): Promise<CreateFilterCommandOutput>;
|
|
444
454
|
createFilter(args: CreateFilterCommandInput, cb: (err: any, data?: CreateFilterCommandOutput) => void): void;
|
|
445
455
|
createFilter(args: CreateFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFilterCommandOutput) => void): void;
|
|
446
456
|
/**
|
|
457
|
+
* @public
|
|
447
458
|
* <p>Creates a metric attribution.
|
|
448
459
|
* A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3.
|
|
449
460
|
* For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html">Measuring impact of recommendations</a>.</p>
|
|
@@ -452,6 +463,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
452
463
|
createMetricAttribution(args: CreateMetricAttributionCommandInput, cb: (err: any, data?: CreateMetricAttributionCommandOutput) => void): void;
|
|
453
464
|
createMetricAttribution(args: CreateMetricAttributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMetricAttributionCommandOutput) => void): void;
|
|
454
465
|
/**
|
|
466
|
+
* @public
|
|
455
467
|
* <p>Creates a recommender with the recipe (a Domain dataset group use case) you specify.
|
|
456
468
|
* You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a
|
|
457
469
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
|
|
@@ -533,6 +545,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
533
545
|
createRecommender(args: CreateRecommenderCommandInput, cb: (err: any, data?: CreateRecommenderCommandOutput) => void): void;
|
|
534
546
|
createRecommender(args: CreateRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRecommenderCommandOutput) => void): void;
|
|
535
547
|
/**
|
|
548
|
+
* @public
|
|
536
549
|
* <p>Creates an Amazon Personalize schema from the specified schema string. The schema you create
|
|
537
550
|
* must be in Avro JSON format.</p>
|
|
538
551
|
* <p>Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset
|
|
@@ -565,6 +578,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
565
578
|
createSchema(args: CreateSchemaCommandInput, cb: (err: any, data?: CreateSchemaCommandOutput) => void): void;
|
|
566
579
|
createSchema(args: CreateSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSchemaCommandOutput) => void): void;
|
|
567
580
|
/**
|
|
581
|
+
* @public
|
|
568
582
|
* <p>Creates the configuration for training a model. A trained model is known as
|
|
569
583
|
* a solution. After the configuration is created, you train the model (create a solution)
|
|
570
584
|
* by calling the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html">CreateSolutionVersion</a> operation. Every time you call
|
|
@@ -643,6 +657,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
643
657
|
createSolution(args: CreateSolutionCommandInput, cb: (err: any, data?: CreateSolutionCommandOutput) => void): void;
|
|
644
658
|
createSolution(args: CreateSolutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSolutionCommandOutput) => void): void;
|
|
645
659
|
/**
|
|
660
|
+
* @public
|
|
646
661
|
* <p>Trains or retrains an active solution in a Custom dataset group. A solution is created using the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>
|
|
647
662
|
* operation and must be in the ACTIVE state before calling
|
|
648
663
|
* <code>CreateSolutionVersion</code>. A new version of the solution is created every time you
|
|
@@ -715,6 +730,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
715
730
|
createSolutionVersion(args: CreateSolutionVersionCommandInput, cb: (err: any, data?: CreateSolutionVersionCommandOutput) => void): void;
|
|
716
731
|
createSolutionVersion(args: CreateSolutionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSolutionVersionCommandOutput) => void): void;
|
|
717
732
|
/**
|
|
733
|
+
* @public
|
|
718
734
|
* <p>Removes a campaign by deleting the solution deployment. The solution that
|
|
719
735
|
* the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no
|
|
720
736
|
* longer be specified in a
|
|
@@ -726,6 +742,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
726
742
|
deleteCampaign(args: DeleteCampaignCommandInput, cb: (err: any, data?: DeleteCampaignCommandOutput) => void): void;
|
|
727
743
|
deleteCampaign(args: DeleteCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCampaignCommandOutput) => void): void;
|
|
728
744
|
/**
|
|
745
|
+
* @public
|
|
729
746
|
* <p>Deletes a dataset. You can't delete a dataset if an associated
|
|
730
747
|
* <code>DatasetImportJob</code> or <code>SolutionVersion</code> is in the
|
|
731
748
|
* CREATE PENDING or IN PROGRESS state. For more information on datasets, see
|
|
@@ -735,6 +752,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
735
752
|
deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
|
|
736
753
|
deleteDataset(args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
|
|
737
754
|
/**
|
|
755
|
+
* @public
|
|
738
756
|
* <p>Deletes a dataset group. Before you delete a dataset group, you must
|
|
739
757
|
* delete the following:</p>
|
|
740
758
|
* <ul>
|
|
@@ -753,6 +771,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
753
771
|
deleteDatasetGroup(args: DeleteDatasetGroupCommandInput, cb: (err: any, data?: DeleteDatasetGroupCommandOutput) => void): void;
|
|
754
772
|
deleteDatasetGroup(args: DeleteDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetGroupCommandOutput) => void): void;
|
|
755
773
|
/**
|
|
774
|
+
* @public
|
|
756
775
|
* <p>Deletes the event tracker. Does not delete the event-interactions dataset from
|
|
757
776
|
* the associated dataset group. For more
|
|
758
777
|
* information on event trackers, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>.</p>
|
|
@@ -761,18 +780,21 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
761
780
|
deleteEventTracker(args: DeleteEventTrackerCommandInput, cb: (err: any, data?: DeleteEventTrackerCommandOutput) => void): void;
|
|
762
781
|
deleteEventTracker(args: DeleteEventTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventTrackerCommandOutput) => void): void;
|
|
763
782
|
/**
|
|
783
|
+
* @public
|
|
764
784
|
* <p>Deletes a filter.</p>
|
|
765
785
|
*/
|
|
766
786
|
deleteFilter(args: DeleteFilterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteFilterCommandOutput>;
|
|
767
787
|
deleteFilter(args: DeleteFilterCommandInput, cb: (err: any, data?: DeleteFilterCommandOutput) => void): void;
|
|
768
788
|
deleteFilter(args: DeleteFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFilterCommandOutput) => void): void;
|
|
769
789
|
/**
|
|
790
|
+
* @public
|
|
770
791
|
* <p>Deletes a metric attribution.</p>
|
|
771
792
|
*/
|
|
772
793
|
deleteMetricAttribution(args: DeleteMetricAttributionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMetricAttributionCommandOutput>;
|
|
773
794
|
deleteMetricAttribution(args: DeleteMetricAttributionCommandInput, cb: (err: any, data?: DeleteMetricAttributionCommandOutput) => void): void;
|
|
774
795
|
deleteMetricAttribution(args: DeleteMetricAttributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMetricAttributionCommandOutput) => void): void;
|
|
775
796
|
/**
|
|
797
|
+
* @public
|
|
776
798
|
* <p>Deactivates and removes a recommender. A deleted recommender can no longer be specified in a <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
|
|
777
799
|
* request.</p>
|
|
778
800
|
*/
|
|
@@ -780,6 +802,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
780
802
|
deleteRecommender(args: DeleteRecommenderCommandInput, cb: (err: any, data?: DeleteRecommenderCommandOutput) => void): void;
|
|
781
803
|
deleteRecommender(args: DeleteRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRecommenderCommandOutput) => void): void;
|
|
782
804
|
/**
|
|
805
|
+
* @public
|
|
783
806
|
* <p>Deletes a schema. Before deleting a schema, you must delete all
|
|
784
807
|
* datasets referencing the schema. For more information on schemas, see
|
|
785
808
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html">CreateSchema</a>.</p>
|
|
@@ -788,6 +811,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
788
811
|
deleteSchema(args: DeleteSchemaCommandInput, cb: (err: any, data?: DeleteSchemaCommandOutput) => void): void;
|
|
789
812
|
deleteSchema(args: DeleteSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSchemaCommandOutput) => void): void;
|
|
790
813
|
/**
|
|
814
|
+
* @public
|
|
791
815
|
* <p>Deletes all versions of a solution and the <code>Solution</code> object itself.
|
|
792
816
|
* Before deleting a solution, you must delete all campaigns based on
|
|
793
817
|
* the solution. To determine what campaigns are using the solution, call
|
|
@@ -800,12 +824,14 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
800
824
|
deleteSolution(args: DeleteSolutionCommandInput, cb: (err: any, data?: DeleteSolutionCommandOutput) => void): void;
|
|
801
825
|
deleteSolution(args: DeleteSolutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSolutionCommandOutput) => void): void;
|
|
802
826
|
/**
|
|
827
|
+
* @public
|
|
803
828
|
* <p>Describes the given algorithm.</p>
|
|
804
829
|
*/
|
|
805
830
|
describeAlgorithm(args: DescribeAlgorithmCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAlgorithmCommandOutput>;
|
|
806
831
|
describeAlgorithm(args: DescribeAlgorithmCommandInput, cb: (err: any, data?: DescribeAlgorithmCommandOutput) => void): void;
|
|
807
832
|
describeAlgorithm(args: DescribeAlgorithmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAlgorithmCommandOutput) => void): void;
|
|
808
833
|
/**
|
|
834
|
+
* @public
|
|
809
835
|
* <p>Gets the properties of a batch inference job including name, Amazon Resource Name (ARN),
|
|
810
836
|
* status, input and output configurations, and the ARN of the solution version used to generate
|
|
811
837
|
* the recommendations.</p>
|
|
@@ -814,6 +840,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
814
840
|
describeBatchInferenceJob(args: DescribeBatchInferenceJobCommandInput, cb: (err: any, data?: DescribeBatchInferenceJobCommandOutput) => void): void;
|
|
815
841
|
describeBatchInferenceJob(args: DescribeBatchInferenceJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBatchInferenceJobCommandOutput) => void): void;
|
|
816
842
|
/**
|
|
843
|
+
* @public
|
|
817
844
|
* <p>Gets the properties of a batch segment job including name, Amazon Resource Name (ARN),
|
|
818
845
|
* status, input and output configurations, and the ARN of the solution version used to generate
|
|
819
846
|
* segments.</p>
|
|
@@ -822,6 +849,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
822
849
|
describeBatchSegmentJob(args: DescribeBatchSegmentJobCommandInput, cb: (err: any, data?: DescribeBatchSegmentJobCommandOutput) => void): void;
|
|
823
850
|
describeBatchSegmentJob(args: DescribeBatchSegmentJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBatchSegmentJobCommandOutput) => void): void;
|
|
824
851
|
/**
|
|
852
|
+
* @public
|
|
825
853
|
* <p>Describes the given campaign, including its status.</p>
|
|
826
854
|
* <p>A campaign can be in one of the following states:</p>
|
|
827
855
|
* <ul>
|
|
@@ -840,6 +868,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
840
868
|
describeCampaign(args: DescribeCampaignCommandInput, cb: (err: any, data?: DescribeCampaignCommandOutput) => void): void;
|
|
841
869
|
describeCampaign(args: DescribeCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCampaignCommandOutput) => void): void;
|
|
842
870
|
/**
|
|
871
|
+
* @public
|
|
843
872
|
* <p>Describes the given dataset. For more information on datasets, see
|
|
844
873
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
845
874
|
*/
|
|
@@ -847,12 +876,14 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
847
876
|
describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
|
|
848
877
|
describeDataset(args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
|
|
849
878
|
/**
|
|
879
|
+
* @public
|
|
850
880
|
* <p>Describes the dataset export job created by <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html">CreateDatasetExportJob</a>, including the export job status.</p>
|
|
851
881
|
*/
|
|
852
882
|
describeDatasetExportJob(args: DescribeDatasetExportJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetExportJobCommandOutput>;
|
|
853
883
|
describeDatasetExportJob(args: DescribeDatasetExportJobCommandInput, cb: (err: any, data?: DescribeDatasetExportJobCommandOutput) => void): void;
|
|
854
884
|
describeDatasetExportJob(args: DescribeDatasetExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetExportJobCommandOutput) => void): void;
|
|
855
885
|
/**
|
|
886
|
+
* @public
|
|
856
887
|
* <p>Describes the given dataset group. For more information on dataset
|
|
857
888
|
* groups, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>.</p>
|
|
858
889
|
*/
|
|
@@ -860,12 +891,14 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
860
891
|
describeDatasetGroup(args: DescribeDatasetGroupCommandInput, cb: (err: any, data?: DescribeDatasetGroupCommandOutput) => void): void;
|
|
861
892
|
describeDatasetGroup(args: DescribeDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetGroupCommandOutput) => void): void;
|
|
862
893
|
/**
|
|
894
|
+
* @public
|
|
863
895
|
* <p>Describes the dataset import job created by <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>, including the import job status.</p>
|
|
864
896
|
*/
|
|
865
897
|
describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetImportJobCommandOutput>;
|
|
866
898
|
describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, cb: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void): void;
|
|
867
899
|
describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void): void;
|
|
868
900
|
/**
|
|
901
|
+
* @public
|
|
869
902
|
* <p>Describes an event tracker. The response includes the <code>trackingId</code> and
|
|
870
903
|
* <code>status</code> of the event tracker.
|
|
871
904
|
* For more information on event trackers, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html">CreateEventTracker</a>.</p>
|
|
@@ -874,24 +907,28 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
874
907
|
describeEventTracker(args: DescribeEventTrackerCommandInput, cb: (err: any, data?: DescribeEventTrackerCommandOutput) => void): void;
|
|
875
908
|
describeEventTracker(args: DescribeEventTrackerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventTrackerCommandOutput) => void): void;
|
|
876
909
|
/**
|
|
910
|
+
* @public
|
|
877
911
|
* <p>Describes the given feature transformation.</p>
|
|
878
912
|
*/
|
|
879
913
|
describeFeatureTransformation(args: DescribeFeatureTransformationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFeatureTransformationCommandOutput>;
|
|
880
914
|
describeFeatureTransformation(args: DescribeFeatureTransformationCommandInput, cb: (err: any, data?: DescribeFeatureTransformationCommandOutput) => void): void;
|
|
881
915
|
describeFeatureTransformation(args: DescribeFeatureTransformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFeatureTransformationCommandOutput) => void): void;
|
|
882
916
|
/**
|
|
917
|
+
* @public
|
|
883
918
|
* <p>Describes a filter's properties.</p>
|
|
884
919
|
*/
|
|
885
920
|
describeFilter(args: DescribeFilterCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFilterCommandOutput>;
|
|
886
921
|
describeFilter(args: DescribeFilterCommandInput, cb: (err: any, data?: DescribeFilterCommandOutput) => void): void;
|
|
887
922
|
describeFilter(args: DescribeFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFilterCommandOutput) => void): void;
|
|
888
923
|
/**
|
|
924
|
+
* @public
|
|
889
925
|
* <p>Describes a metric attribution.</p>
|
|
890
926
|
*/
|
|
891
927
|
describeMetricAttribution(args: DescribeMetricAttributionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeMetricAttributionCommandOutput>;
|
|
892
928
|
describeMetricAttribution(args: DescribeMetricAttributionCommandInput, cb: (err: any, data?: DescribeMetricAttributionCommandOutput) => void): void;
|
|
893
929
|
describeMetricAttribution(args: DescribeMetricAttributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMetricAttributionCommandOutput) => void): void;
|
|
894
930
|
/**
|
|
931
|
+
* @public
|
|
895
932
|
* <p>Describes a recipe.</p>
|
|
896
933
|
* <p>A recipe contains three items:</p>
|
|
897
934
|
* <ul>
|
|
@@ -916,6 +953,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
916
953
|
describeRecipe(args: DescribeRecipeCommandInput, cb: (err: any, data?: DescribeRecipeCommandOutput) => void): void;
|
|
917
954
|
describeRecipe(args: DescribeRecipeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecipeCommandOutput) => void): void;
|
|
918
955
|
/**
|
|
956
|
+
* @public
|
|
919
957
|
* <p>Describes the given recommender, including its status.</p>
|
|
920
958
|
* <p>A recommender can be in one of the following states:</p>
|
|
921
959
|
* <ul>
|
|
@@ -939,6 +977,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
939
977
|
describeRecommender(args: DescribeRecommenderCommandInput, cb: (err: any, data?: DescribeRecommenderCommandOutput) => void): void;
|
|
940
978
|
describeRecommender(args: DescribeRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRecommenderCommandOutput) => void): void;
|
|
941
979
|
/**
|
|
980
|
+
* @public
|
|
942
981
|
* <p>Describes a schema. For more information on schemas, see
|
|
943
982
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html">CreateSchema</a>.</p>
|
|
944
983
|
*/
|
|
@@ -946,6 +985,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
946
985
|
describeSchema(args: DescribeSchemaCommandInput, cb: (err: any, data?: DescribeSchemaCommandOutput) => void): void;
|
|
947
986
|
describeSchema(args: DescribeSchemaCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSchemaCommandOutput) => void): void;
|
|
948
987
|
/**
|
|
988
|
+
* @public
|
|
949
989
|
* <p>Describes a solution.
|
|
950
990
|
* For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>.</p>
|
|
951
991
|
*/
|
|
@@ -953,6 +993,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
953
993
|
describeSolution(args: DescribeSolutionCommandInput, cb: (err: any, data?: DescribeSolutionCommandOutput) => void): void;
|
|
954
994
|
describeSolution(args: DescribeSolutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSolutionCommandOutput) => void): void;
|
|
955
995
|
/**
|
|
996
|
+
* @public
|
|
956
997
|
* <p>Describes a specific version of a solution. For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>
|
|
957
998
|
* </p>
|
|
958
999
|
*/
|
|
@@ -960,12 +1001,14 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
960
1001
|
describeSolutionVersion(args: DescribeSolutionVersionCommandInput, cb: (err: any, data?: DescribeSolutionVersionCommandOutput) => void): void;
|
|
961
1002
|
describeSolutionVersion(args: DescribeSolutionVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSolutionVersionCommandOutput) => void): void;
|
|
962
1003
|
/**
|
|
1004
|
+
* @public
|
|
963
1005
|
* <p>Gets the metrics for the specified solution version.</p>
|
|
964
1006
|
*/
|
|
965
1007
|
getSolutionMetrics(args: GetSolutionMetricsCommandInput, options?: __HttpHandlerOptions): Promise<GetSolutionMetricsCommandOutput>;
|
|
966
1008
|
getSolutionMetrics(args: GetSolutionMetricsCommandInput, cb: (err: any, data?: GetSolutionMetricsCommandOutput) => void): void;
|
|
967
1009
|
getSolutionMetrics(args: GetSolutionMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSolutionMetricsCommandOutput) => void): void;
|
|
968
1010
|
/**
|
|
1011
|
+
* @public
|
|
969
1012
|
* <p>Gets a list of the batch inference jobs that have been performed off of a solution
|
|
970
1013
|
* version.</p>
|
|
971
1014
|
*/
|
|
@@ -973,6 +1016,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
973
1016
|
listBatchInferenceJobs(args: ListBatchInferenceJobsCommandInput, cb: (err: any, data?: ListBatchInferenceJobsCommandOutput) => void): void;
|
|
974
1017
|
listBatchInferenceJobs(args: ListBatchInferenceJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBatchInferenceJobsCommandOutput) => void): void;
|
|
975
1018
|
/**
|
|
1019
|
+
* @public
|
|
976
1020
|
* <p>Gets a list of the batch segment jobs that have been performed off of a solution
|
|
977
1021
|
* version that you specify.</p>
|
|
978
1022
|
*/
|
|
@@ -980,6 +1024,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
980
1024
|
listBatchSegmentJobs(args: ListBatchSegmentJobsCommandInput, cb: (err: any, data?: ListBatchSegmentJobsCommandOutput) => void): void;
|
|
981
1025
|
listBatchSegmentJobs(args: ListBatchSegmentJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBatchSegmentJobsCommandOutput) => void): void;
|
|
982
1026
|
/**
|
|
1027
|
+
* @public
|
|
983
1028
|
* <p>Returns a list of campaigns that use the given solution.
|
|
984
1029
|
* When a solution is not specified, all the campaigns associated with the account are listed.
|
|
985
1030
|
* The response provides the properties for each campaign, including the Amazon Resource Name (ARN).
|
|
@@ -989,6 +1034,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
989
1034
|
listCampaigns(args: ListCampaignsCommandInput, cb: (err: any, data?: ListCampaignsCommandOutput) => void): void;
|
|
990
1035
|
listCampaigns(args: ListCampaignsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCampaignsCommandOutput) => void): void;
|
|
991
1036
|
/**
|
|
1037
|
+
* @public
|
|
992
1038
|
* <p>Returns a list of dataset export jobs that use the given dataset. When
|
|
993
1039
|
* a dataset is not specified, all the dataset export jobs associated with
|
|
994
1040
|
* the account are listed. The response provides the properties for each
|
|
@@ -1000,6 +1046,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
1000
1046
|
listDatasetExportJobs(args: ListDatasetExportJobsCommandInput, cb: (err: any, data?: ListDatasetExportJobsCommandOutput) => void): void;
|
|
1001
1047
|
listDatasetExportJobs(args: ListDatasetExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetExportJobsCommandOutput) => void): void;
|
|
1002
1048
|
/**
|
|
1049
|
+
* @public
|
|
1003
1050
|
* <p>Returns a list of dataset groups. The response provides the properties
|
|
1004
1051
|
* for each dataset group, including the Amazon Resource Name (ARN). For more
|
|
1005
1052
|
* information on dataset groups, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>.</p>
|
|
@@ -1008,6 +1055,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
1008
1055
|
listDatasetGroups(args: ListDatasetGroupsCommandInput, cb: (err: any, data?: ListDatasetGroupsCommandOutput) => void): void;
|
|
1009
1056
|
listDatasetGroups(args: ListDatasetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetGroupsCommandOutput) => void): void;
|
|
1010
1057
|
/**
|
|
1058
|
+
* @public
|
|
1011
1059
|
* <p>Returns a list of dataset import jobs that use the given dataset. When
|
|
1012
1060
|
* a dataset is not specified, all the dataset import jobs associated with
|
|
1013
1061
|
* the account are listed. The response provides the properties for each
|
|
@@ -1019,6 +1067,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
1019
1067
|
listDatasetImportJobs(args: ListDatasetImportJobsCommandInput, cb: (err: any, data?: ListDatasetImportJobsCommandOutput) => void): void;
|
|
1020
1068
|
listDatasetImportJobs(args: ListDatasetImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetImportJobsCommandOutput) => void): void;
|
|
1021
1069
|
/**
|
|
1070
|
+
* @public
|
|
1022
1071
|
* <p>Returns the list of datasets contained in the given dataset group. The
|
|
1023
1072
|
* response provides the properties for each dataset, including the Amazon
|
|
1024
1073
|
* Resource Name (ARN). For more information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
@@ -1027,6 +1076,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
1027
1076
|
listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
|
|
1028
1077
|
listDatasets(args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
|
|
1029
1078
|
/**
|
|
1079
|
+
* @public
|
|
1030
1080
|
* <p>Returns the list of event trackers associated with the account.
|
|
1031
1081
|
* The response provides the properties for each event tracker, including the Amazon Resource
|
|
1032
1082
|
* Name (ARN) and tracking ID. For more
|
|
@@ -1036,24 +1086,28 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
1036
1086
|
listEventTrackers(args: ListEventTrackersCommandInput, cb: (err: any, data?: ListEventTrackersCommandOutput) => void): void;
|
|
1037
1087
|
listEventTrackers(args: ListEventTrackersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventTrackersCommandOutput) => void): void;
|
|
1038
1088
|
/**
|
|
1089
|
+
* @public
|
|
1039
1090
|
* <p>Lists all filters that belong to a given dataset group.</p>
|
|
1040
1091
|
*/
|
|
1041
1092
|
listFilters(args: ListFiltersCommandInput, options?: __HttpHandlerOptions): Promise<ListFiltersCommandOutput>;
|
|
1042
1093
|
listFilters(args: ListFiltersCommandInput, cb: (err: any, data?: ListFiltersCommandOutput) => void): void;
|
|
1043
1094
|
listFilters(args: ListFiltersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFiltersCommandOutput) => void): void;
|
|
1044
1095
|
/**
|
|
1096
|
+
* @public
|
|
1045
1097
|
* <p>Lists the metrics for the metric attribution.</p>
|
|
1046
1098
|
*/
|
|
1047
1099
|
listMetricAttributionMetrics(args: ListMetricAttributionMetricsCommandInput, options?: __HttpHandlerOptions): Promise<ListMetricAttributionMetricsCommandOutput>;
|
|
1048
1100
|
listMetricAttributionMetrics(args: ListMetricAttributionMetricsCommandInput, cb: (err: any, data?: ListMetricAttributionMetricsCommandOutput) => void): void;
|
|
1049
1101
|
listMetricAttributionMetrics(args: ListMetricAttributionMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMetricAttributionMetricsCommandOutput) => void): void;
|
|
1050
1102
|
/**
|
|
1103
|
+
* @public
|
|
1051
1104
|
* <p>Lists metric attributions.</p>
|
|
1052
1105
|
*/
|
|
1053
1106
|
listMetricAttributions(args: ListMetricAttributionsCommandInput, options?: __HttpHandlerOptions): Promise<ListMetricAttributionsCommandOutput>;
|
|
1054
1107
|
listMetricAttributions(args: ListMetricAttributionsCommandInput, cb: (err: any, data?: ListMetricAttributionsCommandOutput) => void): void;
|
|
1055
1108
|
listMetricAttributions(args: ListMetricAttributionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMetricAttributionsCommandOutput) => void): void;
|
|
1056
1109
|
/**
|
|
1110
|
+
* @public
|
|
1057
1111
|
* <p>Returns a list of available recipes. The response provides the properties
|
|
1058
1112
|
* for each recipe, including the recipe's Amazon Resource Name (ARN).</p>
|
|
1059
1113
|
*/
|
|
@@ -1061,6 +1115,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
1061
1115
|
listRecipes(args: ListRecipesCommandInput, cb: (err: any, data?: ListRecipesCommandOutput) => void): void;
|
|
1062
1116
|
listRecipes(args: ListRecipesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecipesCommandOutput) => void): void;
|
|
1063
1117
|
/**
|
|
1118
|
+
* @public
|
|
1064
1119
|
* <p>Returns a list of recommenders in a given Domain dataset group.
|
|
1065
1120
|
* When a Domain dataset group is not specified, all the recommenders associated with the account are listed.
|
|
1066
1121
|
* The response provides the properties for each recommender, including the Amazon Resource Name (ARN).
|
|
@@ -1070,6 +1125,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
1070
1125
|
listRecommenders(args: ListRecommendersCommandInput, cb: (err: any, data?: ListRecommendersCommandOutput) => void): void;
|
|
1071
1126
|
listRecommenders(args: ListRecommendersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecommendersCommandOutput) => void): void;
|
|
1072
1127
|
/**
|
|
1128
|
+
* @public
|
|
1073
1129
|
* <p>Returns the list of schemas associated with the account. The response provides the
|
|
1074
1130
|
* properties for each schema, including the Amazon Resource Name (ARN).
|
|
1075
1131
|
* For more information on schemas, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html">CreateSchema</a>.</p>
|
|
@@ -1078,6 +1134,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
1078
1134
|
listSchemas(args: ListSchemasCommandInput, cb: (err: any, data?: ListSchemasCommandOutput) => void): void;
|
|
1079
1135
|
listSchemas(args: ListSchemasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSchemasCommandOutput) => void): void;
|
|
1080
1136
|
/**
|
|
1137
|
+
* @public
|
|
1081
1138
|
* <p>Returns a list of solutions that use the given dataset group.
|
|
1082
1139
|
* When a dataset group is not specified, all the solutions associated with the account are listed.
|
|
1083
1140
|
* The response provides the properties for each solution, including the Amazon Resource Name (ARN).
|
|
@@ -1087,6 +1144,7 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
1087
1144
|
listSolutions(args: ListSolutionsCommandInput, cb: (err: any, data?: ListSolutionsCommandOutput) => void): void;
|
|
1088
1145
|
listSolutions(args: ListSolutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSolutionsCommandOutput) => void): void;
|
|
1089
1146
|
/**
|
|
1147
|
+
* @public
|
|
1090
1148
|
* <p>Returns a list of solution versions for the given solution. When a solution is not
|
|
1091
1149
|
* specified, all the solution versions associated with the account are listed. The response
|
|
1092
1150
|
* provides the properties for each solution version, including the Amazon Resource Name (ARN).</p>
|
|
@@ -1095,12 +1153,14 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
1095
1153
|
listSolutionVersions(args: ListSolutionVersionsCommandInput, cb: (err: any, data?: ListSolutionVersionsCommandOutput) => void): void;
|
|
1096
1154
|
listSolutionVersions(args: ListSolutionVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSolutionVersionsCommandOutput) => void): void;
|
|
1097
1155
|
/**
|
|
1156
|
+
* @public
|
|
1098
1157
|
* <p>Get a list of <a href="https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html">tags</a> attached to a resource.</p>
|
|
1099
1158
|
*/
|
|
1100
1159
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
1101
1160
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
1102
1161
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
1103
1162
|
/**
|
|
1163
|
+
* @public
|
|
1104
1164
|
* <p>Starts a recommender that is INACTIVE. Starting a recommender does not
|
|
1105
1165
|
* create any new models, but resumes billing and automatic retraining for the recommender.</p>
|
|
1106
1166
|
*/
|
|
@@ -1108,12 +1168,14 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
1108
1168
|
startRecommender(args: StartRecommenderCommandInput, cb: (err: any, data?: StartRecommenderCommandOutput) => void): void;
|
|
1109
1169
|
startRecommender(args: StartRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartRecommenderCommandOutput) => void): void;
|
|
1110
1170
|
/**
|
|
1171
|
+
* @public
|
|
1111
1172
|
* <p>Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.</p>
|
|
1112
1173
|
*/
|
|
1113
1174
|
stopRecommender(args: StopRecommenderCommandInput, options?: __HttpHandlerOptions): Promise<StopRecommenderCommandOutput>;
|
|
1114
1175
|
stopRecommender(args: StopRecommenderCommandInput, cb: (err: any, data?: StopRecommenderCommandOutput) => void): void;
|
|
1115
1176
|
stopRecommender(args: StopRecommenderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopRecommenderCommandOutput) => void): void;
|
|
1116
1177
|
/**
|
|
1178
|
+
* @public
|
|
1117
1179
|
* <p>Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
|
|
1118
1180
|
* </p>
|
|
1119
1181
|
* <p>Depending on the current state of the solution version, the solution version state changes as follows:</p>
|
|
@@ -1133,18 +1195,21 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
1133
1195
|
stopSolutionVersionCreation(args: StopSolutionVersionCreationCommandInput, cb: (err: any, data?: StopSolutionVersionCreationCommandOutput) => void): void;
|
|
1134
1196
|
stopSolutionVersionCreation(args: StopSolutionVersionCreationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopSolutionVersionCreationCommandOutput) => void): void;
|
|
1135
1197
|
/**
|
|
1198
|
+
* @public
|
|
1136
1199
|
* <p>Add a list of tags to a resource.</p>
|
|
1137
1200
|
*/
|
|
1138
1201
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
1139
1202
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1140
1203
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1141
1204
|
/**
|
|
1205
|
+
* @public
|
|
1142
1206
|
* <p>Remove <a href="https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html">tags</a> that are attached to a resource.</p>
|
|
1143
1207
|
*/
|
|
1144
1208
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
1145
1209
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1146
1210
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1147
1211
|
/**
|
|
1212
|
+
* @public
|
|
1148
1213
|
* <p>Updates a campaign by either deploying a new solution or changing the value of the
|
|
1149
1214
|
* campaign's <code>minProvisionedTPS</code> parameter.</p>
|
|
1150
1215
|
* <p>To update a campaign, the campaign status must be ACTIVE or CREATE FAILED.
|
|
@@ -1162,12 +1227,14 @@ export declare class Personalize extends PersonalizeClient {
|
|
|
1162
1227
|
updateCampaign(args: UpdateCampaignCommandInput, cb: (err: any, data?: UpdateCampaignCommandOutput) => void): void;
|
|
1163
1228
|
updateCampaign(args: UpdateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCampaignCommandOutput) => void): void;
|
|
1164
1229
|
/**
|
|
1230
|
+
* @public
|
|
1165
1231
|
* <p>Updates a metric attribution.</p>
|
|
1166
1232
|
*/
|
|
1167
1233
|
updateMetricAttribution(args: UpdateMetricAttributionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateMetricAttributionCommandOutput>;
|
|
1168
1234
|
updateMetricAttribution(args: UpdateMetricAttributionCommandInput, cb: (err: any, data?: UpdateMetricAttributionCommandOutput) => void): void;
|
|
1169
1235
|
updateMetricAttribution(args: UpdateMetricAttributionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMetricAttributionCommandOutput) => void): void;
|
|
1170
1236
|
/**
|
|
1237
|
+
* @public
|
|
1171
1238
|
* <p>Updates the recommender to modify the recommender configuration.</p>
|
|
1172
1239
|
*/
|
|
1173
1240
|
updateRecommender(args: UpdateRecommenderCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRecommenderCommandOutput>;
|
|
@@ -74,15 +74,24 @@ import { UpdateCampaignCommandInput, UpdateCampaignCommandOutput } from "./comma
|
|
|
74
74
|
import { UpdateMetricAttributionCommandInput, UpdateMetricAttributionCommandOutput } from "./commands/UpdateMetricAttributionCommand";
|
|
75
75
|
import { UpdateRecommenderCommandInput, UpdateRecommenderCommandOutput } from "./commands/UpdateRecommenderCommand";
|
|
76
76
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
77
|
+
/**
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
77
80
|
export type ServiceInputTypes = CreateBatchInferenceJobCommandInput | CreateBatchSegmentJobCommandInput | CreateCampaignCommandInput | CreateDatasetCommandInput | CreateDatasetExportJobCommandInput | CreateDatasetGroupCommandInput | CreateDatasetImportJobCommandInput | CreateEventTrackerCommandInput | CreateFilterCommandInput | CreateMetricAttributionCommandInput | CreateRecommenderCommandInput | CreateSchemaCommandInput | CreateSolutionCommandInput | CreateSolutionVersionCommandInput | DeleteCampaignCommandInput | DeleteDatasetCommandInput | DeleteDatasetGroupCommandInput | DeleteEventTrackerCommandInput | DeleteFilterCommandInput | DeleteMetricAttributionCommandInput | DeleteRecommenderCommandInput | DeleteSchemaCommandInput | DeleteSolutionCommandInput | DescribeAlgorithmCommandInput | DescribeBatchInferenceJobCommandInput | DescribeBatchSegmentJobCommandInput | DescribeCampaignCommandInput | DescribeDatasetCommandInput | DescribeDatasetExportJobCommandInput | DescribeDatasetGroupCommandInput | DescribeDatasetImportJobCommandInput | DescribeEventTrackerCommandInput | DescribeFeatureTransformationCommandInput | DescribeFilterCommandInput | DescribeMetricAttributionCommandInput | DescribeRecipeCommandInput | DescribeRecommenderCommandInput | DescribeSchemaCommandInput | DescribeSolutionCommandInput | DescribeSolutionVersionCommandInput | GetSolutionMetricsCommandInput | ListBatchInferenceJobsCommandInput | ListBatchSegmentJobsCommandInput | ListCampaignsCommandInput | ListDatasetExportJobsCommandInput | ListDatasetGroupsCommandInput | ListDatasetImportJobsCommandInput | ListDatasetsCommandInput | ListEventTrackersCommandInput | ListFiltersCommandInput | ListMetricAttributionMetricsCommandInput | ListMetricAttributionsCommandInput | ListRecipesCommandInput | ListRecommendersCommandInput | ListSchemasCommandInput | ListSolutionVersionsCommandInput | ListSolutionsCommandInput | ListTagsForResourceCommandInput | StartRecommenderCommandInput | StopRecommenderCommandInput | StopSolutionVersionCreationCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCampaignCommandInput | UpdateMetricAttributionCommandInput | UpdateRecommenderCommandInput;
|
|
81
|
+
/**
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
78
84
|
export type ServiceOutputTypes = CreateBatchInferenceJobCommandOutput | CreateBatchSegmentJobCommandOutput | CreateCampaignCommandOutput | CreateDatasetCommandOutput | CreateDatasetExportJobCommandOutput | CreateDatasetGroupCommandOutput | CreateDatasetImportJobCommandOutput | CreateEventTrackerCommandOutput | CreateFilterCommandOutput | CreateMetricAttributionCommandOutput | CreateRecommenderCommandOutput | CreateSchemaCommandOutput | CreateSolutionCommandOutput | CreateSolutionVersionCommandOutput | DeleteCampaignCommandOutput | DeleteDatasetCommandOutput | DeleteDatasetGroupCommandOutput | DeleteEventTrackerCommandOutput | DeleteFilterCommandOutput | DeleteMetricAttributionCommandOutput | DeleteRecommenderCommandOutput | DeleteSchemaCommandOutput | DeleteSolutionCommandOutput | DescribeAlgorithmCommandOutput | DescribeBatchInferenceJobCommandOutput | DescribeBatchSegmentJobCommandOutput | DescribeCampaignCommandOutput | DescribeDatasetCommandOutput | DescribeDatasetExportJobCommandOutput | DescribeDatasetGroupCommandOutput | DescribeDatasetImportJobCommandOutput | DescribeEventTrackerCommandOutput | DescribeFeatureTransformationCommandOutput | DescribeFilterCommandOutput | DescribeMetricAttributionCommandOutput | DescribeRecipeCommandOutput | DescribeRecommenderCommandOutput | DescribeSchemaCommandOutput | DescribeSolutionCommandOutput | DescribeSolutionVersionCommandOutput | GetSolutionMetricsCommandOutput | ListBatchInferenceJobsCommandOutput | ListBatchSegmentJobsCommandOutput | ListCampaignsCommandOutput | ListDatasetExportJobsCommandOutput | ListDatasetGroupsCommandOutput | ListDatasetImportJobsCommandOutput | ListDatasetsCommandOutput | ListEventTrackersCommandOutput | ListFiltersCommandOutput | ListMetricAttributionMetricsCommandOutput | ListMetricAttributionsCommandOutput | ListRecipesCommandOutput | ListRecommendersCommandOutput | ListSchemasCommandOutput | ListSolutionVersionsCommandOutput | ListSolutionsCommandOutput | ListTagsForResourceCommandOutput | StartRecommenderCommandOutput | StopRecommenderCommandOutput | StopSolutionVersionCreationCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCampaignCommandOutput | UpdateMetricAttributionCommandOutput | UpdateRecommenderCommandOutput;
|
|
85
|
+
/**
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
79
88
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
80
89
|
/**
|
|
81
90
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
82
91
|
*/
|
|
83
92
|
requestHandler?: __HttpHandler;
|
|
84
93
|
/**
|
|
85
|
-
* A constructor for a class implementing the {@link
|
|
94
|
+
* A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
|
|
86
95
|
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
87
96
|
* @internal
|
|
88
97
|
*/
|
|
@@ -172,23 +181,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
172
181
|
*/
|
|
173
182
|
logger?: __Logger;
|
|
174
183
|
/**
|
|
175
|
-
* The {@link
|
|
184
|
+
* The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
176
185
|
*/
|
|
177
186
|
defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
|
|
178
187
|
}
|
|
188
|
+
/**
|
|
189
|
+
* @public
|
|
190
|
+
*/
|
|
179
191
|
type PersonalizeClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
|
|
180
192
|
/**
|
|
181
|
-
*
|
|
193
|
+
* @public
|
|
194
|
+
*
|
|
195
|
+
* The configuration interface of PersonalizeClient class constructor that set the region, credentials and other options.
|
|
182
196
|
*/
|
|
183
197
|
export interface PersonalizeClientConfig extends PersonalizeClientConfigType {
|
|
184
198
|
}
|
|
199
|
+
/**
|
|
200
|
+
* @public
|
|
201
|
+
*/
|
|
185
202
|
type PersonalizeClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
186
203
|
/**
|
|
187
|
-
*
|
|
204
|
+
* @public
|
|
205
|
+
*
|
|
206
|
+
* The resolved configuration interface of PersonalizeClient class. This is resolved and normalized from the {@link PersonalizeClientConfig | constructor configuration interface}.
|
|
188
207
|
*/
|
|
189
208
|
export interface PersonalizeClientResolvedConfig extends PersonalizeClientResolvedConfigType {
|
|
190
209
|
}
|
|
191
210
|
/**
|
|
211
|
+
* @public
|
|
192
212
|
* <p>Amazon Personalize is a machine learning service that makes it easy to add individualized
|
|
193
213
|
* recommendations to customers.</p>
|
|
194
214
|
*/
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { CreateBatchInferenceJobRequest, CreateBatchInferenceJobResponse } from "../models/models_0";
|
|
5
5
|
import { PersonalizeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeClient";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link CreateBatchInferenceJobCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface CreateBatchInferenceJobCommandInput extends CreateBatchInferenceJobRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link CreateBatchInferenceJobCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface CreateBatchInferenceJobCommandOutput extends CreateBatchInferenceJobResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Creates a batch inference job. The operation can handle up to 50 million records and the
|
|
18
23
|
* input file must be in JSON format. For more information, see
|
|
19
24
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/creating-batch-inference-job.html">Creating a batch inference job</a>.
|
|
@@ -28,6 +33,8 @@ export interface CreateBatchInferenceJobCommandOutput extends CreateBatchInferen
|
|
|
28
33
|
* const response = await client.send(command);
|
|
29
34
|
* ```
|
|
30
35
|
*
|
|
36
|
+
* @param CreateBatchInferenceJobCommandInput - {@link CreateBatchInferenceJobCommandInput}
|
|
37
|
+
* @returns {@link CreateBatchInferenceJobCommandOutput}
|
|
31
38
|
* @see {@link CreateBatchInferenceJobCommandInput} for command's `input` shape.
|
|
32
39
|
* @see {@link CreateBatchInferenceJobCommandOutput} for command's `response` shape.
|
|
33
40
|
* @see {@link PersonalizeClientResolvedConfig | config} for PersonalizeClient's `config` shape.
|
|
@@ -55,11 +62,20 @@ export interface CreateBatchInferenceJobCommandOutput extends CreateBatchInferen
|
|
|
55
62
|
export declare class CreateBatchInferenceJobCommand extends $Command<CreateBatchInferenceJobCommandInput, CreateBatchInferenceJobCommandOutput, PersonalizeClientResolvedConfig> {
|
|
56
63
|
readonly input: CreateBatchInferenceJobCommandInput;
|
|
57
64
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
65
|
+
/**
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
58
68
|
constructor(input: CreateBatchInferenceJobCommandInput);
|
|
59
69
|
/**
|
|
60
70
|
* @internal
|
|
61
71
|
*/
|
|
62
72
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBatchInferenceJobCommandInput, CreateBatchInferenceJobCommandOutput>;
|
|
73
|
+
/**
|
|
74
|
+
* @internal
|
|
75
|
+
*/
|
|
63
76
|
private serialize;
|
|
77
|
+
/**
|
|
78
|
+
* @internal
|
|
79
|
+
*/
|
|
64
80
|
private deserialize;
|
|
65
81
|
}
|