@aws-sdk/client-personalize 3.321.1 → 3.326.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. package/dist-types/commands/CreateBatchInferenceJobCommand.d.ts +6 -0
  2. package/dist-types/commands/CreateBatchSegmentJobCommand.d.ts +6 -0
  3. package/dist-types/commands/CreateCampaignCommand.d.ts +6 -0
  4. package/dist-types/commands/CreateDatasetCommand.d.ts +6 -0
  5. package/dist-types/commands/CreateDatasetExportJobCommand.d.ts +6 -0
  6. package/dist-types/commands/CreateDatasetGroupCommand.d.ts +7 -0
  7. package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +6 -0
  8. package/dist-types/commands/CreateEventTrackerCommand.d.ts +7 -0
  9. package/dist-types/commands/CreateFilterCommand.d.ts +6 -0
  10. package/dist-types/commands/CreateMetricAttributionCommand.d.ts +6 -0
  11. package/dist-types/commands/CreateRecommenderCommand.d.ts +6 -0
  12. package/dist-types/commands/CreateSchemaCommand.d.ts +6 -0
  13. package/dist-types/commands/CreateSolutionCommand.d.ts +6 -0
  14. package/dist-types/commands/CreateSolutionVersionCommand.d.ts +6 -0
  15. package/dist-types/commands/DeleteCampaignCommand.d.ts +4 -0
  16. package/dist-types/commands/DeleteDatasetCommand.d.ts +4 -0
  17. package/dist-types/commands/DeleteDatasetGroupCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteEventTrackerCommand.d.ts +4 -0
  19. package/dist-types/commands/DeleteFilterCommand.d.ts +4 -0
  20. package/dist-types/commands/DeleteMetricAttributionCommand.d.ts +4 -0
  21. package/dist-types/commands/DeleteRecommenderCommand.d.ts +4 -0
  22. package/dist-types/commands/DeleteSchemaCommand.d.ts +4 -0
  23. package/dist-types/commands/DeleteSolutionCommand.d.ts +4 -0
  24. package/dist-types/commands/DescribeAlgorithmCommand.d.ts +50 -0
  25. package/dist-types/commands/DescribeBatchInferenceJobCommand.d.ts +34 -0
  26. package/dist-types/commands/DescribeBatchSegmentJobCommand.d.ts +29 -0
  27. package/dist-types/commands/DescribeCampaignCommand.d.ts +33 -0
  28. package/dist-types/commands/DescribeDatasetCommand.d.ts +15 -0
  29. package/dist-types/commands/DescribeDatasetExportJobCommand.d.ts +22 -0
  30. package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +16 -0
  31. package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +20 -0
  32. package/dist-types/commands/DescribeEventTrackerCommand.d.ts +15 -0
  33. package/dist-types/commands/DescribeFeatureTransformationCommand.d.ts +15 -0
  34. package/dist-types/commands/DescribeFilterCommand.d.ts +15 -0
  35. package/dist-types/commands/DescribeMetricAttributionCommand.d.ts +21 -0
  36. package/dist-types/commands/DescribeRecipeCommand.d.ts +16 -0
  37. package/dist-types/commands/DescribeRecommenderCommand.d.ts +36 -0
  38. package/dist-types/commands/DescribeSchemaCommand.d.ts +13 -0
  39. package/dist-types/commands/DescribeSolutionCommand.d.ts +81 -0
  40. package/dist-types/commands/DescribeSolutionVersionCommand.d.ts +80 -0
  41. package/dist-types/commands/GetSolutionMetricsCommand.d.ts +9 -0
  42. package/dist-types/commands/ListBatchInferenceJobsCommand.d.ts +17 -0
  43. package/dist-types/commands/ListBatchSegmentJobsCommand.d.ts +17 -0
  44. package/dist-types/commands/ListCampaignsCommand.d.ts +16 -0
  45. package/dist-types/commands/ListDatasetExportJobsCommand.d.ts +16 -0
  46. package/dist-types/commands/ListDatasetGroupsCommand.d.ts +17 -0
  47. package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +17 -0
  48. package/dist-types/commands/ListDatasetsCommand.d.ts +16 -0
  49. package/dist-types/commands/ListEventTrackersCommand.d.ts +15 -0
  50. package/dist-types/commands/ListFiltersCommand.d.ts +17 -0
  51. package/dist-types/commands/ListMetricAttributionMetricsCommand.d.ts +13 -0
  52. package/dist-types/commands/ListMetricAttributionsCommand.d.ts +16 -0
  53. package/dist-types/commands/ListRecipesCommand.d.ts +16 -0
  54. package/dist-types/commands/ListRecommendersCommand.d.ts +23 -0
  55. package/dist-types/commands/ListSchemasCommand.d.ts +15 -0
  56. package/dist-types/commands/ListSolutionVersionsCommand.d.ts +15 -0
  57. package/dist-types/commands/ListSolutionsCommand.d.ts +16 -0
  58. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  59. package/dist-types/commands/StartRecommenderCommand.d.ts +6 -0
  60. package/dist-types/commands/StopRecommenderCommand.d.ts +6 -0
  61. package/dist-types/commands/StopSolutionVersionCreationCommand.d.ts +4 -0
  62. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  63. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  64. package/dist-types/commands/UpdateCampaignCommand.d.ts +6 -0
  65. package/dist-types/commands/UpdateMetricAttributionCommand.d.ts +6 -0
  66. package/dist-types/commands/UpdateRecommenderCommand.d.ts +6 -0
  67. package/package.json +16 -16
@@ -61,6 +61,10 @@ export interface CreateBatchInferenceJobCommandOutput extends CreateBatchInferen
61
61
  * };
62
62
  * const command = new CreateBatchInferenceJobCommand(input);
63
63
  * const response = await client.send(command);
64
+ * // { // CreateBatchInferenceJobResponse
65
+ * // batchInferenceJobArn: "STRING_VALUE",
66
+ * // };
67
+ *
64
68
  * ```
65
69
  *
66
70
  * @param CreateBatchInferenceJobCommandInput - {@link CreateBatchInferenceJobCommandInput}
@@ -87,6 +91,8 @@ export interface CreateBatchInferenceJobCommandOutput extends CreateBatchInferen
87
91
  * @throws {@link TooManyTagsException} (client fault)
88
92
  * <p>You have exceeded the maximum number of tags you can apply to this resource. </p>
89
93
  *
94
+ * @throws {@link PersonalizeServiceException}
95
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
90
96
  *
91
97
  */
92
98
  export declare class CreateBatchInferenceJobCommand extends $Command<CreateBatchInferenceJobCommandInput, CreateBatchInferenceJobCommandOutput, PersonalizeClientResolvedConfig> {
@@ -55,6 +55,10 @@ export interface CreateBatchSegmentJobCommandOutput extends CreateBatchSegmentJo
55
55
  * };
56
56
  * const command = new CreateBatchSegmentJobCommand(input);
57
57
  * const response = await client.send(command);
58
+ * // { // CreateBatchSegmentJobResponse
59
+ * // batchSegmentJobArn: "STRING_VALUE",
60
+ * // };
61
+ *
58
62
  * ```
59
63
  *
60
64
  * @param CreateBatchSegmentJobCommandInput - {@link CreateBatchSegmentJobCommandInput}
@@ -81,6 +85,8 @@ export interface CreateBatchSegmentJobCommandOutput extends CreateBatchSegmentJo
81
85
  * @throws {@link TooManyTagsException} (client fault)
82
86
  * <p>You have exceeded the maximum number of tags you can apply to this resource. </p>
83
87
  *
88
+ * @throws {@link PersonalizeServiceException}
89
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
84
90
  *
85
91
  */
86
92
  export declare class CreateBatchSegmentJobCommand extends $Command<CreateBatchSegmentJobCommandInput, CreateBatchSegmentJobCommandOutput, PersonalizeClientResolvedConfig> {
@@ -113,6 +113,10 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
113
113
  * };
114
114
  * const command = new CreateCampaignCommand(input);
115
115
  * const response = await client.send(command);
116
+ * // { // CreateCampaignResponse
117
+ * // campaignArn: "STRING_VALUE",
118
+ * // };
119
+ *
116
120
  * ```
117
121
  *
118
122
  * @param CreateCampaignCommandInput - {@link CreateCampaignCommandInput}
@@ -139,6 +143,8 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
139
143
  * @throws {@link TooManyTagsException} (client fault)
140
144
  * <p>You have exceeded the maximum number of tags you can apply to this resource. </p>
141
145
  *
146
+ * @throws {@link PersonalizeServiceException}
147
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
142
148
  *
143
149
  */
144
150
  export declare class CreateCampaignCommand extends $Command<CreateCampaignCommandInput, CreateCampaignCommandOutput, PersonalizeClientResolvedConfig> {
@@ -94,6 +94,10 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
94
94
  * };
95
95
  * const command = new CreateDatasetCommand(input);
96
96
  * const response = await client.send(command);
97
+ * // { // CreateDatasetResponse
98
+ * // datasetArn: "STRING_VALUE",
99
+ * // };
100
+ *
97
101
  * ```
98
102
  *
99
103
  * @param CreateDatasetCommandInput - {@link CreateDatasetCommandInput}
@@ -120,6 +124,8 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
120
124
  * @throws {@link TooManyTagsException} (client fault)
121
125
  * <p>You have exceeded the maximum number of tags you can apply to this resource. </p>
122
126
  *
127
+ * @throws {@link PersonalizeServiceException}
128
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
123
129
  *
124
130
  */
125
131
  export declare class CreateDatasetCommand extends $Command<CreateDatasetCommandInput, CreateDatasetCommandOutput, PersonalizeClientResolvedConfig> {
@@ -64,6 +64,10 @@ export interface CreateDatasetExportJobCommandOutput extends CreateDatasetExport
64
64
  * };
65
65
  * const command = new CreateDatasetExportJobCommand(input);
66
66
  * const response = await client.send(command);
67
+ * // { // CreateDatasetExportJobResponse
68
+ * // datasetExportJobArn: "STRING_VALUE",
69
+ * // };
70
+ *
67
71
  * ```
68
72
  *
69
73
  * @param CreateDatasetExportJobCommandInput - {@link CreateDatasetExportJobCommandInput}
@@ -90,6 +94,8 @@ export interface CreateDatasetExportJobCommandOutput extends CreateDatasetExport
90
94
  * @throws {@link TooManyTagsException} (client fault)
91
95
  * <p>You have exceeded the maximum number of tags you can apply to this resource. </p>
92
96
  *
97
+ * @throws {@link PersonalizeServiceException}
98
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
93
99
  *
94
100
  */
95
101
  export declare class CreateDatasetExportJobCommand extends $Command<CreateDatasetExportJobCommandInput, CreateDatasetExportJobCommandOutput, PersonalizeClientResolvedConfig> {
@@ -120,6 +120,11 @@ export interface CreateDatasetGroupCommandOutput extends CreateDatasetGroupRespo
120
120
  * };
121
121
  * const command = new CreateDatasetGroupCommand(input);
122
122
  * const response = await client.send(command);
123
+ * // { // CreateDatasetGroupResponse
124
+ * // datasetGroupArn: "STRING_VALUE",
125
+ * // domain: "ECOMMERCE" || "VIDEO_ON_DEMAND",
126
+ * // };
127
+ *
123
128
  * ```
124
129
  *
125
130
  * @param CreateDatasetGroupCommandInput - {@link CreateDatasetGroupCommandInput}
@@ -140,6 +145,8 @@ export interface CreateDatasetGroupCommandOutput extends CreateDatasetGroupRespo
140
145
  * @throws {@link TooManyTagsException} (client fault)
141
146
  * <p>You have exceeded the maximum number of tags you can apply to this resource. </p>
142
147
  *
148
+ * @throws {@link PersonalizeServiceException}
149
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
143
150
  *
144
151
  */
145
152
  export declare class CreateDatasetGroupCommand extends $Command<CreateDatasetGroupCommandInput, CreateDatasetGroupCommandOutput, PersonalizeClientResolvedConfig> {
@@ -91,6 +91,10 @@ export interface CreateDatasetImportJobCommandOutput extends CreateDatasetImport
91
91
  * };
92
92
  * const command = new CreateDatasetImportJobCommand(input);
93
93
  * const response = await client.send(command);
94
+ * // { // CreateDatasetImportJobResponse
95
+ * // datasetImportJobArn: "STRING_VALUE",
96
+ * // };
97
+ *
94
98
  * ```
95
99
  *
96
100
  * @param CreateDatasetImportJobCommandInput - {@link CreateDatasetImportJobCommandInput}
@@ -117,6 +121,8 @@ export interface CreateDatasetImportJobCommandOutput extends CreateDatasetImport
117
121
  * @throws {@link TooManyTagsException} (client fault)
118
122
  * <p>You have exceeded the maximum number of tags you can apply to this resource. </p>
119
123
  *
124
+ * @throws {@link PersonalizeServiceException}
125
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
120
126
  *
121
127
  */
122
128
  export declare class CreateDatasetImportJobCommand extends $Command<CreateDatasetImportJobCommandInput, CreateDatasetImportJobCommandOutput, PersonalizeClientResolvedConfig> {
@@ -83,6 +83,11 @@ export interface CreateEventTrackerCommandOutput extends CreateEventTrackerRespo
83
83
  * };
84
84
  * const command = new CreateEventTrackerCommand(input);
85
85
  * const response = await client.send(command);
86
+ * // { // CreateEventTrackerResponse
87
+ * // eventTrackerArn: "STRING_VALUE",
88
+ * // trackingId: "STRING_VALUE",
89
+ * // };
90
+ *
86
91
  * ```
87
92
  *
88
93
  * @param CreateEventTrackerCommandInput - {@link CreateEventTrackerCommandInput}
@@ -109,6 +114,8 @@ export interface CreateEventTrackerCommandOutput extends CreateEventTrackerRespo
109
114
  * @throws {@link TooManyTagsException} (client fault)
110
115
  * <p>You have exceeded the maximum number of tags you can apply to this resource. </p>
111
116
  *
117
+ * @throws {@link PersonalizeServiceException}
118
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
112
119
  *
113
120
  */
114
121
  export declare class CreateEventTrackerCommand extends $Command<CreateEventTrackerCommandInput, CreateEventTrackerCommandOutput, PersonalizeClientResolvedConfig> {
@@ -39,6 +39,10 @@ export interface CreateFilterCommandOutput extends CreateFilterResponse, __Metad
39
39
  * };
40
40
  * const command = new CreateFilterCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // CreateFilterResponse
43
+ * // filterArn: "STRING_VALUE",
44
+ * // };
45
+ *
42
46
  * ```
43
47
  *
44
48
  * @param CreateFilterCommandInput - {@link CreateFilterCommandInput}
@@ -62,6 +66,8 @@ export interface CreateFilterCommandOutput extends CreateFilterResponse, __Metad
62
66
  * @throws {@link TooManyTagsException} (client fault)
63
67
  * <p>You have exceeded the maximum number of tags you can apply to this resource. </p>
64
68
  *
69
+ * @throws {@link PersonalizeServiceException}
70
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
65
71
  *
66
72
  */
67
73
  export declare class CreateFilterCommand extends $Command<CreateFilterCommandInput, CreateFilterCommandOutput, PersonalizeClientResolvedConfig> {
@@ -48,6 +48,10 @@ export interface CreateMetricAttributionCommandOutput extends CreateMetricAttrib
48
48
  * };
49
49
  * const command = new CreateMetricAttributionCommand(input);
50
50
  * const response = await client.send(command);
51
+ * // { // CreateMetricAttributionResponse
52
+ * // metricAttributionArn: "STRING_VALUE",
53
+ * // };
54
+ *
51
55
  * ```
52
56
  *
53
57
  * @param CreateMetricAttributionCommandInput - {@link CreateMetricAttributionCommandInput}
@@ -71,6 +75,8 @@ export interface CreateMetricAttributionCommandOutput extends CreateMetricAttrib
71
75
  * @throws {@link ResourceNotFoundException} (client fault)
72
76
  * <p>Could not find the specified resource.</p>
73
77
  *
78
+ * @throws {@link PersonalizeServiceException}
79
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
74
80
  *
75
81
  */
76
82
  export declare class CreateMetricAttributionCommand extends $Command<CreateMetricAttributionCommandInput, CreateMetricAttributionCommandOutput, PersonalizeClientResolvedConfig> {
@@ -120,6 +120,10 @@ export interface CreateRecommenderCommandOutput extends CreateRecommenderRespons
120
120
  * };
121
121
  * const command = new CreateRecommenderCommand(input);
122
122
  * const response = await client.send(command);
123
+ * // { // CreateRecommenderResponse
124
+ * // recommenderArn: "STRING_VALUE",
125
+ * // };
126
+ *
123
127
  * ```
124
128
  *
125
129
  * @param CreateRecommenderCommandInput - {@link CreateRecommenderCommandInput}
@@ -146,6 +150,8 @@ export interface CreateRecommenderCommandOutput extends CreateRecommenderRespons
146
150
  * @throws {@link TooManyTagsException} (client fault)
147
151
  * <p>You have exceeded the maximum number of tags you can apply to this resource. </p>
148
152
  *
153
+ * @throws {@link PersonalizeServiceException}
154
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
149
155
  *
150
156
  */
151
157
  export declare class CreateRecommenderCommand extends $Command<CreateRecommenderCommandInput, CreateRecommenderCommandOutput, PersonalizeClientResolvedConfig> {
@@ -59,6 +59,10 @@ export interface CreateSchemaCommandOutput extends CreateSchemaResponse, __Metad
59
59
  * };
60
60
  * const command = new CreateSchemaCommand(input);
61
61
  * const response = await client.send(command);
62
+ * // { // CreateSchemaResponse
63
+ * // schemaArn: "STRING_VALUE",
64
+ * // };
65
+ *
62
66
  * ```
63
67
  *
64
68
  * @param CreateSchemaCommandInput - {@link CreateSchemaCommandInput}
@@ -76,6 +80,8 @@ export interface CreateSchemaCommandOutput extends CreateSchemaResponse, __Metad
76
80
  * @throws {@link ResourceAlreadyExistsException} (client fault)
77
81
  * <p>The specified resource already exists.</p>
78
82
  *
83
+ * @throws {@link PersonalizeServiceException}
84
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
79
85
  *
80
86
  */
81
87
  export declare class CreateSchemaCommand extends $Command<CreateSchemaCommandInput, CreateSchemaCommandOutput, PersonalizeClientResolvedConfig> {
@@ -168,6 +168,10 @@ export interface CreateSolutionCommandOutput extends CreateSolutionResponse, __M
168
168
  * };
169
169
  * const command = new CreateSolutionCommand(input);
170
170
  * const response = await client.send(command);
171
+ * // { // CreateSolutionResponse
172
+ * // solutionArn: "STRING_VALUE",
173
+ * // };
174
+ *
171
175
  * ```
172
176
  *
173
177
  * @param CreateSolutionCommandInput - {@link CreateSolutionCommandInput}
@@ -194,6 +198,8 @@ export interface CreateSolutionCommandOutput extends CreateSolutionResponse, __M
194
198
  * @throws {@link TooManyTagsException} (client fault)
195
199
  * <p>You have exceeded the maximum number of tags you can apply to this resource. </p>
196
200
  *
201
+ * @throws {@link PersonalizeServiceException}
202
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
197
203
  *
198
204
  */
199
205
  export declare class CreateSolutionCommand extends $Command<CreateSolutionCommandInput, CreateSolutionCommandOutput, PersonalizeClientResolvedConfig> {
@@ -105,6 +105,10 @@ export interface CreateSolutionVersionCommandOutput extends CreateSolutionVersio
105
105
  * };
106
106
  * const command = new CreateSolutionVersionCommand(input);
107
107
  * const response = await client.send(command);
108
+ * // { // CreateSolutionVersionResponse
109
+ * // solutionVersionArn: "STRING_VALUE",
110
+ * // };
111
+ *
108
112
  * ```
109
113
  *
110
114
  * @param CreateSolutionVersionCommandInput - {@link CreateSolutionVersionCommandInput}
@@ -131,6 +135,8 @@ export interface CreateSolutionVersionCommandOutput extends CreateSolutionVersio
131
135
  * @throws {@link TooManyTagsException} (client fault)
132
136
  * <p>You have exceeded the maximum number of tags you can apply to this resource. </p>
133
137
  *
138
+ * @throws {@link PersonalizeServiceException}
139
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
134
140
  *
135
141
  */
136
142
  export declare class CreateSolutionVersionCommand extends $Command<CreateSolutionVersionCommandInput, CreateSolutionVersionCommandOutput, PersonalizeClientResolvedConfig> {
@@ -36,6 +36,8 @@ export interface DeleteCampaignCommandOutput extends __MetadataBearer {
36
36
  * };
37
37
  * const command = new DeleteCampaignCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // {};
40
+ *
39
41
  * ```
40
42
  *
41
43
  * @param DeleteCampaignCommandInput - {@link DeleteCampaignCommandInput}
@@ -53,6 +55,8 @@ export interface DeleteCampaignCommandOutput extends __MetadataBearer {
53
55
  * @throws {@link ResourceNotFoundException} (client fault)
54
56
  * <p>Could not find the specified resource.</p>
55
57
  *
58
+ * @throws {@link PersonalizeServiceException}
59
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
56
60
  *
57
61
  */
58
62
  export declare class DeleteCampaignCommand extends $Command<DeleteCampaignCommandInput, DeleteCampaignCommandOutput, PersonalizeClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface DeleteDatasetCommandOutput extends __MetadataBearer {
34
34
  * };
35
35
  * const command = new DeleteDatasetCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param DeleteDatasetCommandInput - {@link DeleteDatasetCommandInput}
@@ -51,6 +53,8 @@ export interface DeleteDatasetCommandOutput extends __MetadataBearer {
51
53
  * @throws {@link ResourceNotFoundException} (client fault)
52
54
  * <p>Could not find the specified resource.</p>
53
55
  *
56
+ * @throws {@link PersonalizeServiceException}
57
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
54
58
  *
55
59
  */
56
60
  export declare class DeleteDatasetCommand extends $Command<DeleteDatasetCommandInput, DeleteDatasetCommandOutput, PersonalizeClientResolvedConfig> {
@@ -43,6 +43,8 @@ export interface DeleteDatasetGroupCommandOutput extends __MetadataBearer {
43
43
  * };
44
44
  * const command = new DeleteDatasetGroupCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // {};
47
+ *
46
48
  * ```
47
49
  *
48
50
  * @param DeleteDatasetGroupCommandInput - {@link DeleteDatasetGroupCommandInput}
@@ -60,6 +62,8 @@ export interface DeleteDatasetGroupCommandOutput extends __MetadataBearer {
60
62
  * @throws {@link ResourceNotFoundException} (client fault)
61
63
  * <p>Could not find the specified resource.</p>
62
64
  *
65
+ * @throws {@link PersonalizeServiceException}
66
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
63
67
  *
64
68
  */
65
69
  export declare class DeleteDatasetGroupCommand extends $Command<DeleteDatasetGroupCommandInput, DeleteDatasetGroupCommandOutput, PersonalizeClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeleteEventTrackerCommandOutput extends __MetadataBearer {
33
33
  * };
34
34
  * const command = new DeleteEventTrackerCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteEventTrackerCommandInput - {@link DeleteEventTrackerCommandInput}
@@ -50,6 +52,8 @@ export interface DeleteEventTrackerCommandOutput extends __MetadataBearer {
50
52
  * @throws {@link ResourceNotFoundException} (client fault)
51
53
  * <p>Could not find the specified resource.</p>
52
54
  *
55
+ * @throws {@link PersonalizeServiceException}
56
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
53
57
  *
54
58
  */
55
59
  export declare class DeleteEventTrackerCommand extends $Command<DeleteEventTrackerCommandInput, DeleteEventTrackerCommandOutput, PersonalizeClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteFilterCommandOutput extends __MetadataBearer {
31
31
  * };
32
32
  * const command = new DeleteFilterCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteFilterCommandInput - {@link DeleteFilterCommandInput}
@@ -48,6 +50,8 @@ export interface DeleteFilterCommandOutput extends __MetadataBearer {
48
50
  * @throws {@link ResourceNotFoundException} (client fault)
49
51
  * <p>Could not find the specified resource.</p>
50
52
  *
53
+ * @throws {@link PersonalizeServiceException}
54
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
51
55
  *
52
56
  */
53
57
  export declare class DeleteFilterCommand extends $Command<DeleteFilterCommandInput, DeleteFilterCommandOutput, PersonalizeClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteMetricAttributionCommandOutput extends __MetadataBearer {
31
31
  * };
32
32
  * const command = new DeleteMetricAttributionCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteMetricAttributionCommandInput - {@link DeleteMetricAttributionCommandInput}
@@ -48,6 +50,8 @@ export interface DeleteMetricAttributionCommandOutput extends __MetadataBearer {
48
50
  * @throws {@link ResourceNotFoundException} (client fault)
49
51
  * <p>Could not find the specified resource.</p>
50
52
  *
53
+ * @throws {@link PersonalizeServiceException}
54
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
51
55
  *
52
56
  */
53
57
  export declare class DeleteMetricAttributionCommand extends $Command<DeleteMetricAttributionCommandInput, DeleteMetricAttributionCommandOutput, PersonalizeClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteRecommenderCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteRecommenderCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteRecommenderCommandInput - {@link DeleteRecommenderCommandInput}
@@ -49,6 +51,8 @@ export interface DeleteRecommenderCommandOutput extends __MetadataBearer {
49
51
  * @throws {@link ResourceNotFoundException} (client fault)
50
52
  * <p>Could not find the specified resource.</p>
51
53
  *
54
+ * @throws {@link PersonalizeServiceException}
55
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
52
56
  *
53
57
  */
54
58
  export declare class DeleteRecommenderCommand extends $Command<DeleteRecommenderCommandInput, DeleteRecommenderCommandOutput, PersonalizeClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeleteSchemaCommandOutput extends __MetadataBearer {
33
33
  * };
34
34
  * const command = new DeleteSchemaCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteSchemaCommandInput - {@link DeleteSchemaCommandInput}
@@ -50,6 +52,8 @@ export interface DeleteSchemaCommandOutput extends __MetadataBearer {
50
52
  * @throws {@link ResourceNotFoundException} (client fault)
51
53
  * <p>Could not find the specified resource.</p>
52
54
  *
55
+ * @throws {@link PersonalizeServiceException}
56
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
53
57
  *
54
58
  */
55
59
  export declare class DeleteSchemaCommand extends $Command<DeleteSchemaCommandInput, DeleteSchemaCommandOutput, PersonalizeClientResolvedConfig> {
@@ -37,6 +37,8 @@ export interface DeleteSolutionCommandOutput extends __MetadataBearer {
37
37
  * };
38
38
  * const command = new DeleteSolutionCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // {};
41
+ *
40
42
  * ```
41
43
  *
42
44
  * @param DeleteSolutionCommandInput - {@link DeleteSolutionCommandInput}
@@ -54,6 +56,8 @@ export interface DeleteSolutionCommandOutput extends __MetadataBearer {
54
56
  * @throws {@link ResourceNotFoundException} (client fault)
55
57
  * <p>Could not find the specified resource.</p>
56
58
  *
59
+ * @throws {@link PersonalizeServiceException}
60
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
57
61
  *
58
62
  */
59
63
  export declare class DeleteSolutionCommand extends $Command<DeleteSolutionCommandInput, DeleteSolutionCommandOutput, PersonalizeClientResolvedConfig> {
@@ -31,6 +31,54 @@ export interface DescribeAlgorithmCommandOutput extends DescribeAlgorithmRespons
31
31
  * };
32
32
  * const command = new DescribeAlgorithmCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeAlgorithmResponse
35
+ * // algorithm: { // Algorithm
36
+ * // name: "STRING_VALUE",
37
+ * // algorithmArn: "STRING_VALUE",
38
+ * // algorithmImage: { // AlgorithmImage
39
+ * // name: "STRING_VALUE",
40
+ * // dockerURI: "STRING_VALUE", // required
41
+ * // },
42
+ * // defaultHyperParameters: { // HyperParameters
43
+ * // "<keys>": "STRING_VALUE",
44
+ * // },
45
+ * // defaultHyperParameterRanges: { // DefaultHyperParameterRanges
46
+ * // integerHyperParameterRanges: [ // DefaultIntegerHyperParameterRanges
47
+ * // { // DefaultIntegerHyperParameterRange
48
+ * // name: "STRING_VALUE",
49
+ * // minValue: Number("int"),
50
+ * // maxValue: Number("int"),
51
+ * // isTunable: true || false,
52
+ * // },
53
+ * // ],
54
+ * // continuousHyperParameterRanges: [ // DefaultContinuousHyperParameterRanges
55
+ * // { // DefaultContinuousHyperParameterRange
56
+ * // name: "STRING_VALUE",
57
+ * // minValue: Number("double"),
58
+ * // maxValue: Number("double"),
59
+ * // isTunable: true || false,
60
+ * // },
61
+ * // ],
62
+ * // categoricalHyperParameterRanges: [ // DefaultCategoricalHyperParameterRanges
63
+ * // { // DefaultCategoricalHyperParameterRange
64
+ * // name: "STRING_VALUE",
65
+ * // values: [ // CategoricalValues
66
+ * // "STRING_VALUE",
67
+ * // ],
68
+ * // isTunable: true || false,
69
+ * // },
70
+ * // ],
71
+ * // },
72
+ * // defaultResourceConfig: { // ResourceConfig
73
+ * // "<keys>": "STRING_VALUE",
74
+ * // },
75
+ * // trainingInputMode: "STRING_VALUE",
76
+ * // roleArn: "STRING_VALUE",
77
+ * // creationDateTime: new Date("TIMESTAMP"),
78
+ * // lastUpdatedDateTime: new Date("TIMESTAMP"),
79
+ * // },
80
+ * // };
81
+ *
34
82
  * ```
35
83
  *
36
84
  * @param DescribeAlgorithmCommandInput - {@link DescribeAlgorithmCommandInput}
@@ -45,6 +93,8 @@ export interface DescribeAlgorithmCommandOutput extends DescribeAlgorithmRespons
45
93
  * @throws {@link ResourceNotFoundException} (client fault)
46
94
  * <p>Could not find the specified resource.</p>
47
95
  *
96
+ * @throws {@link PersonalizeServiceException}
97
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
48
98
  *
49
99
  */
50
100
  export declare class DescribeAlgorithmCommand extends $Command<DescribeAlgorithmCommandInput, DescribeAlgorithmCommandOutput, PersonalizeClientResolvedConfig> {
@@ -33,6 +33,38 @@ export interface DescribeBatchInferenceJobCommandOutput extends DescribeBatchInf
33
33
  * };
34
34
  * const command = new DescribeBatchInferenceJobCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeBatchInferenceJobResponse
37
+ * // batchInferenceJob: { // BatchInferenceJob
38
+ * // jobName: "STRING_VALUE",
39
+ * // batchInferenceJobArn: "STRING_VALUE",
40
+ * // filterArn: "STRING_VALUE",
41
+ * // failureReason: "STRING_VALUE",
42
+ * // solutionVersionArn: "STRING_VALUE",
43
+ * // numResults: Number("int"),
44
+ * // jobInput: { // BatchInferenceJobInput
45
+ * // s3DataSource: { // S3DataConfig
46
+ * // path: "STRING_VALUE", // required
47
+ * // kmsKeyArn: "STRING_VALUE",
48
+ * // },
49
+ * // },
50
+ * // jobOutput: { // BatchInferenceJobOutput
51
+ * // s3DataDestination: {
52
+ * // path: "STRING_VALUE", // required
53
+ * // kmsKeyArn: "STRING_VALUE",
54
+ * // },
55
+ * // },
56
+ * // batchInferenceJobConfig: { // BatchInferenceJobConfig
57
+ * // itemExplorationConfig: { // HyperParameters
58
+ * // "<keys>": "STRING_VALUE",
59
+ * // },
60
+ * // },
61
+ * // roleArn: "STRING_VALUE",
62
+ * // status: "STRING_VALUE",
63
+ * // creationDateTime: new Date("TIMESTAMP"),
64
+ * // lastUpdatedDateTime: new Date("TIMESTAMP"),
65
+ * // },
66
+ * // };
67
+ *
36
68
  * ```
37
69
  *
38
70
  * @param DescribeBatchInferenceJobCommandInput - {@link DescribeBatchInferenceJobCommandInput}
@@ -47,6 +79,8 @@ export interface DescribeBatchInferenceJobCommandOutput extends DescribeBatchInf
47
79
  * @throws {@link ResourceNotFoundException} (client fault)
48
80
  * <p>Could not find the specified resource.</p>
49
81
  *
82
+ * @throws {@link PersonalizeServiceException}
83
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
50
84
  *
51
85
  */
52
86
  export declare class DescribeBatchInferenceJobCommand extends $Command<DescribeBatchInferenceJobCommandInput, DescribeBatchInferenceJobCommandOutput, PersonalizeClientResolvedConfig> {
@@ -33,6 +33,33 @@ export interface DescribeBatchSegmentJobCommandOutput extends DescribeBatchSegme
33
33
  * };
34
34
  * const command = new DescribeBatchSegmentJobCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeBatchSegmentJobResponse
37
+ * // batchSegmentJob: { // BatchSegmentJob
38
+ * // jobName: "STRING_VALUE",
39
+ * // batchSegmentJobArn: "STRING_VALUE",
40
+ * // filterArn: "STRING_VALUE",
41
+ * // failureReason: "STRING_VALUE",
42
+ * // solutionVersionArn: "STRING_VALUE",
43
+ * // numResults: Number("int"),
44
+ * // jobInput: { // BatchSegmentJobInput
45
+ * // s3DataSource: { // S3DataConfig
46
+ * // path: "STRING_VALUE", // required
47
+ * // kmsKeyArn: "STRING_VALUE",
48
+ * // },
49
+ * // },
50
+ * // jobOutput: { // BatchSegmentJobOutput
51
+ * // s3DataDestination: {
52
+ * // path: "STRING_VALUE", // required
53
+ * // kmsKeyArn: "STRING_VALUE",
54
+ * // },
55
+ * // },
56
+ * // roleArn: "STRING_VALUE",
57
+ * // status: "STRING_VALUE",
58
+ * // creationDateTime: new Date("TIMESTAMP"),
59
+ * // lastUpdatedDateTime: new Date("TIMESTAMP"),
60
+ * // },
61
+ * // };
62
+ *
36
63
  * ```
37
64
  *
38
65
  * @param DescribeBatchSegmentJobCommandInput - {@link DescribeBatchSegmentJobCommandInput}
@@ -47,6 +74,8 @@ export interface DescribeBatchSegmentJobCommandOutput extends DescribeBatchSegme
47
74
  * @throws {@link ResourceNotFoundException} (client fault)
48
75
  * <p>Could not find the specified resource.</p>
49
76
  *
77
+ * @throws {@link PersonalizeServiceException}
78
+ * <p>Base exception class for all service exceptions from Personalize service.</p>
50
79
  *
51
80
  */
52
81
  export declare class DescribeBatchSegmentJobCommand extends $Command<DescribeBatchSegmentJobCommandInput, DescribeBatchSegmentJobCommandOutput, PersonalizeClientResolvedConfig> {