@aws-sdk/client-lookoutequipment 3.296.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.
Files changed (48) hide show
  1. package/dist-types/LookoutEquipment.d.ts +34 -0
  2. package/dist-types/LookoutEquipmentClient.d.ts +24 -4
  3. package/dist-types/commands/CreateDatasetCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateInferenceSchedulerCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateLabelCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateLabelGroupCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateModelCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteDatasetCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteInferenceSchedulerCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteLabelCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteLabelGroupCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteModelCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeDataIngestionJobCommand.d.ts +16 -0
  14. package/dist-types/commands/DescribeDatasetCommand.d.ts +16 -0
  15. package/dist-types/commands/DescribeInferenceSchedulerCommand.d.ts +16 -0
  16. package/dist-types/commands/DescribeLabelCommand.d.ts +16 -0
  17. package/dist-types/commands/DescribeLabelGroupCommand.d.ts +16 -0
  18. package/dist-types/commands/DescribeModelCommand.d.ts +16 -0
  19. package/dist-types/commands/ListDataIngestionJobsCommand.d.ts +16 -0
  20. package/dist-types/commands/ListDatasetsCommand.d.ts +16 -0
  21. package/dist-types/commands/ListInferenceEventsCommand.d.ts +16 -0
  22. package/dist-types/commands/ListInferenceExecutionsCommand.d.ts +16 -0
  23. package/dist-types/commands/ListInferenceSchedulersCommand.d.ts +16 -0
  24. package/dist-types/commands/ListLabelGroupsCommand.d.ts +16 -0
  25. package/dist-types/commands/ListLabelsCommand.d.ts +16 -0
  26. package/dist-types/commands/ListModelsCommand.d.ts +16 -0
  27. package/dist-types/commands/ListSensorStatisticsCommand.d.ts +16 -0
  28. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  29. package/dist-types/commands/StartDataIngestionJobCommand.d.ts +16 -0
  30. package/dist-types/commands/StartInferenceSchedulerCommand.d.ts +16 -0
  31. package/dist-types/commands/StopInferenceSchedulerCommand.d.ts +16 -0
  32. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  33. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  34. package/dist-types/commands/UpdateInferenceSchedulerCommand.d.ts +16 -0
  35. package/dist-types/commands/UpdateLabelGroupCommand.d.ts +16 -0
  36. package/dist-types/models/LookoutEquipmentServiceException.d.ts +2 -0
  37. package/dist-types/models/models_0.d.ts +254 -1
  38. package/dist-types/pagination/Interfaces.d.ts +3 -0
  39. package/dist-types/pagination/ListDataIngestionJobsPaginator.d.ts +3 -0
  40. package/dist-types/pagination/ListDatasetsPaginator.d.ts +3 -0
  41. package/dist-types/pagination/ListInferenceEventsPaginator.d.ts +3 -0
  42. package/dist-types/pagination/ListInferenceExecutionsPaginator.d.ts +3 -0
  43. package/dist-types/pagination/ListInferenceSchedulersPaginator.d.ts +3 -0
  44. package/dist-types/pagination/ListLabelGroupsPaginator.d.ts +3 -0
  45. package/dist-types/pagination/ListLabelsPaginator.d.ts +3 -0
  46. package/dist-types/pagination/ListModelsPaginator.d.ts +3 -0
  47. package/dist-types/pagination/ListSensorStatisticsPaginator.d.ts +3 -0
  48. package/package.json +3 -3
@@ -34,11 +34,13 @@ import { UpdateInferenceSchedulerCommandInput, UpdateInferenceSchedulerCommandOu
34
34
  import { UpdateLabelGroupCommandInput, UpdateLabelGroupCommandOutput } from "./commands/UpdateLabelGroupCommand";
35
35
  import { LookoutEquipmentClient } from "./LookoutEquipmentClient";
36
36
  /**
37
+ * @public
37
38
  * <p>Amazon Lookout for Equipment is a machine learning service that uses advanced analytics to identify
38
39
  * anomalies in machines from sensor data for use in predictive maintenance. </p>
39
40
  */
40
41
  export declare class LookoutEquipment extends LookoutEquipmentClient {
41
42
  /**
43
+ * @public
42
44
  * <p>Creates a container for a collection of data being ingested for analysis. The dataset
43
45
  * contains the metadata describing where the data is and what the data actually looks like.
44
46
  * In other words, it contains the location of the data source, the data schema, and other
@@ -48,6 +50,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
48
50
  createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
49
51
  createDataset(args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
50
52
  /**
53
+ * @public
51
54
  * <p> Creates a scheduled inference. Scheduling an inference is setting up a continuous
52
55
  * real-time inference plan to analyze new measurement data. When setting up the schedule, you
53
56
  * provide an S3 bucket location for the input data, assign it a delimiter between separate
@@ -58,6 +61,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
58
61
  createInferenceScheduler(args: CreateInferenceSchedulerCommandInput, cb: (err: any, data?: CreateInferenceSchedulerCommandOutput) => void): void;
59
62
  createInferenceScheduler(args: CreateInferenceSchedulerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateInferenceSchedulerCommandOutput) => void): void;
60
63
  /**
64
+ * @public
61
65
  * <p>
62
66
  * Creates a label for an event.
63
67
  * </p>
@@ -66,6 +70,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
66
70
  createLabel(args: CreateLabelCommandInput, cb: (err: any, data?: CreateLabelCommandOutput) => void): void;
67
71
  createLabel(args: CreateLabelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLabelCommandOutput) => void): void;
68
72
  /**
73
+ * @public
69
74
  * <p>
70
75
  * Creates a group of labels.
71
76
  * </p>
@@ -74,6 +79,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
74
79
  createLabelGroup(args: CreateLabelGroupCommandInput, cb: (err: any, data?: CreateLabelGroupCommandOutput) => void): void;
75
80
  createLabelGroup(args: CreateLabelGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLabelGroupCommandOutput) => void): void;
76
81
  /**
82
+ * @public
77
83
  * <p>Creates an ML model for data inference. </p>
78
84
  * <p>A machine-learning (ML) model is a mathematical model that finds patterns in your data.
79
85
  * In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and
@@ -88,6 +94,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
88
94
  createModel(args: CreateModelCommandInput, cb: (err: any, data?: CreateModelCommandOutput) => void): void;
89
95
  createModel(args: CreateModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateModelCommandOutput) => void): void;
90
96
  /**
97
+ * @public
91
98
  * <p> Deletes a dataset and associated artifacts. The operation will check to see if any
92
99
  * inference scheduler or data ingestion job is currently using the dataset, and if there
93
100
  * isn't, the dataset, its metadata, and any associated data stored in S3 will be deleted.
@@ -98,6 +105,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
98
105
  deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
99
106
  deleteDataset(args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
100
107
  /**
108
+ * @public
101
109
  * <p>Deletes an inference scheduler that has been set up. Already processed output results
102
110
  * are not affected. </p>
103
111
  */
@@ -105,6 +113,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
105
113
  deleteInferenceScheduler(args: DeleteInferenceSchedulerCommandInput, cb: (err: any, data?: DeleteInferenceSchedulerCommandOutput) => void): void;
106
114
  deleteInferenceScheduler(args: DeleteInferenceSchedulerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInferenceSchedulerCommandOutput) => void): void;
107
115
  /**
116
+ * @public
108
117
  * <p>
109
118
  * Deletes a label.
110
119
  * </p>
@@ -113,6 +122,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
113
122
  deleteLabel(args: DeleteLabelCommandInput, cb: (err: any, data?: DeleteLabelCommandOutput) => void): void;
114
123
  deleteLabel(args: DeleteLabelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLabelCommandOutput) => void): void;
115
124
  /**
125
+ * @public
116
126
  * <p>
117
127
  * Deletes a group of labels.
118
128
  * </p>
@@ -121,6 +131,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
121
131
  deleteLabelGroup(args: DeleteLabelGroupCommandInput, cb: (err: any, data?: DeleteLabelGroupCommandOutput) => void): void;
122
132
  deleteLabelGroup(args: DeleteLabelGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLabelGroupCommandOutput) => void): void;
123
133
  /**
134
+ * @public
124
135
  * <p>Deletes an ML model currently available for Amazon Lookout for Equipment. This will
125
136
  * prevent it from being used with an inference scheduler, even one that is already set up.
126
137
  * </p>
@@ -129,6 +140,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
129
140
  deleteModel(args: DeleteModelCommandInput, cb: (err: any, data?: DeleteModelCommandOutput) => void): void;
130
141
  deleteModel(args: DeleteModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteModelCommandOutput) => void): void;
131
142
  /**
143
+ * @public
132
144
  * <p>Provides information on a specific data ingestion job such as creation time, dataset
133
145
  * ARN, and status.</p>
134
146
  */
@@ -136,6 +148,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
136
148
  describeDataIngestionJob(args: DescribeDataIngestionJobCommandInput, cb: (err: any, data?: DescribeDataIngestionJobCommandOutput) => void): void;
137
149
  describeDataIngestionJob(args: DescribeDataIngestionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataIngestionJobCommandOutput) => void): void;
138
150
  /**
151
+ * @public
139
152
  * <p>Provides a JSON description of the data in each time series dataset, including names,
140
153
  * column names, and data types.</p>
141
154
  */
@@ -143,6 +156,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
143
156
  describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
144
157
  describeDataset(args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
145
158
  /**
159
+ * @public
146
160
  * <p> Specifies information about the inference scheduler being used, including name, model,
147
161
  * status, and associated metadata </p>
148
162
  */
@@ -150,6 +164,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
150
164
  describeInferenceScheduler(args: DescribeInferenceSchedulerCommandInput, cb: (err: any, data?: DescribeInferenceSchedulerCommandOutput) => void): void;
151
165
  describeInferenceScheduler(args: DescribeInferenceSchedulerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInferenceSchedulerCommandOutput) => void): void;
152
166
  /**
167
+ * @public
153
168
  * <p>
154
169
  * Returns the name of the label.
155
170
  * </p>
@@ -158,6 +173,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
158
173
  describeLabel(args: DescribeLabelCommandInput, cb: (err: any, data?: DescribeLabelCommandOutput) => void): void;
159
174
  describeLabel(args: DescribeLabelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLabelCommandOutput) => void): void;
160
175
  /**
176
+ * @public
161
177
  * <p>
162
178
  * Returns information about the label group.
163
179
  * </p>
@@ -166,6 +182,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
166
182
  describeLabelGroup(args: DescribeLabelGroupCommandInput, cb: (err: any, data?: DescribeLabelGroupCommandOutput) => void): void;
167
183
  describeLabelGroup(args: DescribeLabelGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLabelGroupCommandOutput) => void): void;
168
184
  /**
185
+ * @public
169
186
  * <p>Provides a JSON containing the overall information about a specific ML model, including
170
187
  * model name and ARN, dataset, training and evaluation information, status, and so on.
171
188
  * </p>
@@ -174,6 +191,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
174
191
  describeModel(args: DescribeModelCommandInput, cb: (err: any, data?: DescribeModelCommandOutput) => void): void;
175
192
  describeModel(args: DescribeModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeModelCommandOutput) => void): void;
176
193
  /**
194
+ * @public
177
195
  * <p>Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location
178
196
  * of the input data, status, and so on. </p>
179
197
  */
@@ -181,6 +199,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
181
199
  listDataIngestionJobs(args: ListDataIngestionJobsCommandInput, cb: (err: any, data?: ListDataIngestionJobsCommandOutput) => void): void;
182
200
  listDataIngestionJobs(args: ListDataIngestionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataIngestionJobsCommandOutput) => void): void;
183
201
  /**
202
+ * @public
184
203
  * <p>Lists all datasets currently available in your account, filtering on the dataset name.
185
204
  * </p>
186
205
  */
@@ -188,6 +207,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
188
207
  listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
189
208
  listDatasets(args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
190
209
  /**
210
+ * @public
191
211
  * <p> Lists all inference events that have been found for the specified inference scheduler.
192
212
  * </p>
193
213
  */
@@ -195,6 +215,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
195
215
  listInferenceEvents(args: ListInferenceEventsCommandInput, cb: (err: any, data?: ListInferenceEventsCommandOutput) => void): void;
196
216
  listInferenceEvents(args: ListInferenceEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInferenceEventsCommandOutput) => void): void;
197
217
  /**
218
+ * @public
198
219
  * <p> Lists all inference executions that have been performed by the specified inference
199
220
  * scheduler. </p>
200
221
  */
@@ -202,6 +223,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
202
223
  listInferenceExecutions(args: ListInferenceExecutionsCommandInput, cb: (err: any, data?: ListInferenceExecutionsCommandOutput) => void): void;
203
224
  listInferenceExecutions(args: ListInferenceExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInferenceExecutionsCommandOutput) => void): void;
204
225
  /**
226
+ * @public
205
227
  * <p>Retrieves a list of all inference schedulers currently available for your account.
206
228
  * </p>
207
229
  */
@@ -209,6 +231,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
209
231
  listInferenceSchedulers(args: ListInferenceSchedulersCommandInput, cb: (err: any, data?: ListInferenceSchedulersCommandOutput) => void): void;
210
232
  listInferenceSchedulers(args: ListInferenceSchedulersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInferenceSchedulersCommandOutput) => void): void;
211
233
  /**
234
+ * @public
212
235
  * <p>
213
236
  * Returns a list of the label groups.
214
237
  * </p>
@@ -217,6 +240,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
217
240
  listLabelGroups(args: ListLabelGroupsCommandInput, cb: (err: any, data?: ListLabelGroupsCommandOutput) => void): void;
218
241
  listLabelGroups(args: ListLabelGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLabelGroupsCommandOutput) => void): void;
219
242
  /**
243
+ * @public
220
244
  * <p>
221
245
  * Provides a list of labels.
222
246
  * </p>
@@ -225,6 +249,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
225
249
  listLabels(args: ListLabelsCommandInput, cb: (err: any, data?: ListLabelsCommandOutput) => void): void;
226
250
  listLabels(args: ListLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLabelsCommandOutput) => void): void;
227
251
  /**
252
+ * @public
228
253
  * <p>Generates a list of all models in the account, including model name and ARN, dataset,
229
254
  * and status. </p>
230
255
  */
@@ -232,6 +257,7 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
232
257
  listModels(args: ListModelsCommandInput, cb: (err: any, data?: ListModelsCommandOutput) => void): void;
233
258
  listModels(args: ListModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListModelsCommandOutput) => void): void;
234
259
  /**
260
+ * @public
235
261
  * <p> Lists statistics about the data collected for each of the sensors that have been
236
262
  * successfully ingested in the particular dataset. Can also be used to retreive Sensor
237
263
  * Statistics for a previous ingestion job. </p>
@@ -240,12 +266,14 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
240
266
  listSensorStatistics(args: ListSensorStatisticsCommandInput, cb: (err: any, data?: ListSensorStatisticsCommandOutput) => void): void;
241
267
  listSensorStatistics(args: ListSensorStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSensorStatisticsCommandOutput) => void): void;
242
268
  /**
269
+ * @public
243
270
  * <p>Lists all the tags for a specified resource, including key and value. </p>
244
271
  */
245
272
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
246
273
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
247
274
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
248
275
  /**
276
+ * @public
249
277
  * <p>Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.
250
278
  * </p>
251
279
  */
@@ -253,18 +281,21 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
253
281
  startDataIngestionJob(args: StartDataIngestionJobCommandInput, cb: (err: any, data?: StartDataIngestionJobCommandOutput) => void): void;
254
282
  startDataIngestionJob(args: StartDataIngestionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDataIngestionJobCommandOutput) => void): void;
255
283
  /**
284
+ * @public
256
285
  * <p>Starts an inference scheduler. </p>
257
286
  */
258
287
  startInferenceScheduler(args: StartInferenceSchedulerCommandInput, options?: __HttpHandlerOptions): Promise<StartInferenceSchedulerCommandOutput>;
259
288
  startInferenceScheduler(args: StartInferenceSchedulerCommandInput, cb: (err: any, data?: StartInferenceSchedulerCommandOutput) => void): void;
260
289
  startInferenceScheduler(args: StartInferenceSchedulerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartInferenceSchedulerCommandOutput) => void): void;
261
290
  /**
291
+ * @public
262
292
  * <p>Stops an inference scheduler. </p>
263
293
  */
264
294
  stopInferenceScheduler(args: StopInferenceSchedulerCommandInput, options?: __HttpHandlerOptions): Promise<StopInferenceSchedulerCommandOutput>;
265
295
  stopInferenceScheduler(args: StopInferenceSchedulerCommandInput, cb: (err: any, data?: StopInferenceSchedulerCommandOutput) => void): void;
266
296
  stopInferenceScheduler(args: StopInferenceSchedulerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopInferenceSchedulerCommandOutput) => void): void;
267
297
  /**
298
+ * @public
268
299
  * <p>Associates a given tag to a resource in your account. A tag is a key-value pair which
269
300
  * can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for
270
301
  * organizing your resources as well as helping you to search and filter by tag. Multiple tags
@@ -275,18 +306,21 @@ export declare class LookoutEquipment extends LookoutEquipmentClient {
275
306
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
276
307
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
277
308
  /**
309
+ * @public
278
310
  * <p>Removes a specific tag from a given resource. The tag is specified by its key. </p>
279
311
  */
280
312
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
281
313
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
282
314
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
283
315
  /**
316
+ * @public
284
317
  * <p>Updates an inference scheduler. </p>
285
318
  */
286
319
  updateInferenceScheduler(args: UpdateInferenceSchedulerCommandInput, options?: __HttpHandlerOptions): Promise<UpdateInferenceSchedulerCommandOutput>;
287
320
  updateInferenceScheduler(args: UpdateInferenceSchedulerCommandInput, cb: (err: any, data?: UpdateInferenceSchedulerCommandOutput) => void): void;
288
321
  updateInferenceScheduler(args: UpdateInferenceSchedulerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateInferenceSchedulerCommandOutput) => void): void;
289
322
  /**
323
+ * @public
290
324
  * <p>
291
325
  * Updates the label group.
292
326
  * </p>
@@ -41,15 +41,24 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
41
41
  import { UpdateInferenceSchedulerCommandInput, UpdateInferenceSchedulerCommandOutput } from "./commands/UpdateInferenceSchedulerCommand";
42
42
  import { UpdateLabelGroupCommandInput, UpdateLabelGroupCommandOutput } from "./commands/UpdateLabelGroupCommand";
43
43
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
44
+ /**
45
+ * @public
46
+ */
44
47
  export type ServiceInputTypes = CreateDatasetCommandInput | CreateInferenceSchedulerCommandInput | CreateLabelCommandInput | CreateLabelGroupCommandInput | CreateModelCommandInput | DeleteDatasetCommandInput | DeleteInferenceSchedulerCommandInput | DeleteLabelCommandInput | DeleteLabelGroupCommandInput | DeleteModelCommandInput | DescribeDataIngestionJobCommandInput | DescribeDatasetCommandInput | DescribeInferenceSchedulerCommandInput | DescribeLabelCommandInput | DescribeLabelGroupCommandInput | DescribeModelCommandInput | ListDataIngestionJobsCommandInput | ListDatasetsCommandInput | ListInferenceEventsCommandInput | ListInferenceExecutionsCommandInput | ListInferenceSchedulersCommandInput | ListLabelGroupsCommandInput | ListLabelsCommandInput | ListModelsCommandInput | ListSensorStatisticsCommandInput | ListTagsForResourceCommandInput | StartDataIngestionJobCommandInput | StartInferenceSchedulerCommandInput | StopInferenceSchedulerCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateInferenceSchedulerCommandInput | UpdateLabelGroupCommandInput;
48
+ /**
49
+ * @public
50
+ */
45
51
  export type ServiceOutputTypes = CreateDatasetCommandOutput | CreateInferenceSchedulerCommandOutput | CreateLabelCommandOutput | CreateLabelGroupCommandOutput | CreateModelCommandOutput | DeleteDatasetCommandOutput | DeleteInferenceSchedulerCommandOutput | DeleteLabelCommandOutput | DeleteLabelGroupCommandOutput | DeleteModelCommandOutput | DescribeDataIngestionJobCommandOutput | DescribeDatasetCommandOutput | DescribeInferenceSchedulerCommandOutput | DescribeLabelCommandOutput | DescribeLabelGroupCommandOutput | DescribeModelCommandOutput | ListDataIngestionJobsCommandOutput | ListDatasetsCommandOutput | ListInferenceEventsCommandOutput | ListInferenceExecutionsCommandOutput | ListInferenceSchedulersCommandOutput | ListLabelGroupsCommandOutput | ListLabelsCommandOutput | ListModelsCommandOutput | ListSensorStatisticsCommandOutput | ListTagsForResourceCommandOutput | StartDataIngestionJobCommandOutput | StartInferenceSchedulerCommandOutput | StopInferenceSchedulerCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateInferenceSchedulerCommandOutput | UpdateLabelGroupCommandOutput;
52
+ /**
53
+ * @public
54
+ */
46
55
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
47
56
  /**
48
57
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
49
58
  */
50
59
  requestHandler?: __HttpHandler;
51
60
  /**
52
- * A constructor for a class implementing the {@link __Checksum} interface
61
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
53
62
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
54
63
  * @internal
55
64
  */
@@ -139,23 +148,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
139
148
  */
140
149
  logger?: __Logger;
141
150
  /**
142
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
151
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
143
152
  */
144
153
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
145
154
  }
155
+ /**
156
+ * @public
157
+ */
146
158
  type LookoutEquipmentClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
147
159
  /**
148
- * The configuration interface of LookoutEquipmentClient class constructor that set the region, credentials and other options.
160
+ * @public
161
+ *
162
+ * The configuration interface of LookoutEquipmentClient class constructor that set the region, credentials and other options.
149
163
  */
150
164
  export interface LookoutEquipmentClientConfig extends LookoutEquipmentClientConfigType {
151
165
  }
166
+ /**
167
+ * @public
168
+ */
152
169
  type LookoutEquipmentClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
153
170
  /**
154
- * The resolved configuration interface of LookoutEquipmentClient class. This is resolved and normalized from the {@link LookoutEquipmentClientConfig | constructor configuration interface}.
171
+ * @public
172
+ *
173
+ * The resolved configuration interface of LookoutEquipmentClient class. This is resolved and normalized from the {@link LookoutEquipmentClientConfig | constructor configuration interface}.
155
174
  */
156
175
  export interface LookoutEquipmentClientResolvedConfig extends LookoutEquipmentClientResolvedConfigType {
157
176
  }
158
177
  /**
178
+ * @public
159
179
  * <p>Amazon Lookout for Equipment is a machine learning service that uses advanced analytics to identify
160
180
  * anomalies in machines from sensor data for use in predictive maintenance. </p>
161
181
  */
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LookoutEquipmentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LookoutEquipmentClient";
5
5
  import { CreateDatasetRequest, CreateDatasetResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDatasetCommand}.
8
10
  */
9
11
  export interface CreateDatasetCommandInput extends CreateDatasetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDatasetCommand}.
13
17
  */
14
18
  export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a container for a collection of data being ingested for analysis. The dataset
18
23
  * contains the metadata describing where the data is and what the data actually looks like.
19
24
  * In other words, it contains the location of the data source, the data schema, and other
@@ -28,6 +33,8 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param CreateDatasetCommandInput - {@link CreateDatasetCommandInput}
37
+ * @returns {@link CreateDatasetCommandOutput}
31
38
  * @see {@link CreateDatasetCommandInput} for command's `input` shape.
32
39
  * @see {@link CreateDatasetCommandOutput} for command's `response` shape.
33
40
  * @see {@link LookoutEquipmentClientResolvedConfig | config} for LookoutEquipmentClient's `config` shape.
@@ -59,11 +66,20 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
59
66
  export declare class CreateDatasetCommand extends $Command<CreateDatasetCommandInput, CreateDatasetCommandOutput, LookoutEquipmentClientResolvedConfig> {
60
67
  readonly input: CreateDatasetCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: CreateDatasetCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LookoutEquipmentClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDatasetCommandInput, CreateDatasetCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LookoutEquipmentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LookoutEquipmentClient";
5
5
  import { CreateInferenceSchedulerRequest, CreateInferenceSchedulerResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateInferenceSchedulerCommand}.
8
10
  */
9
11
  export interface CreateInferenceSchedulerCommandInput extends CreateInferenceSchedulerRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateInferenceSchedulerCommand}.
13
17
  */
14
18
  export interface CreateInferenceSchedulerCommandOutput extends CreateInferenceSchedulerResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Creates a scheduled inference. Scheduling an inference is setting up a continuous
18
23
  * real-time inference plan to analyze new measurement data. When setting up the schedule, you
19
24
  * provide an S3 bucket location for the input data, assign it a delimiter between separate
@@ -29,6 +34,8 @@ export interface CreateInferenceSchedulerCommandOutput extends CreateInferenceSc
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param CreateInferenceSchedulerCommandInput - {@link CreateInferenceSchedulerCommandInput}
38
+ * @returns {@link CreateInferenceSchedulerCommandOutput}
32
39
  * @see {@link CreateInferenceSchedulerCommandInput} for command's `input` shape.
33
40
  * @see {@link CreateInferenceSchedulerCommandOutput} for command's `response` shape.
34
41
  * @see {@link LookoutEquipmentClientResolvedConfig | config} for LookoutEquipmentClient's `config` shape.
@@ -64,11 +71,20 @@ export interface CreateInferenceSchedulerCommandOutput extends CreateInferenceSc
64
71
  export declare class CreateInferenceSchedulerCommand extends $Command<CreateInferenceSchedulerCommandInput, CreateInferenceSchedulerCommandOutput, LookoutEquipmentClientResolvedConfig> {
65
72
  readonly input: CreateInferenceSchedulerCommandInput;
66
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
67
77
  constructor(input: CreateInferenceSchedulerCommandInput);
68
78
  /**
69
79
  * @internal
70
80
  */
71
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LookoutEquipmentClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateInferenceSchedulerCommandInput, CreateInferenceSchedulerCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
72
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
73
89
  private deserialize;
74
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LookoutEquipmentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LookoutEquipmentClient";
5
5
  import { CreateLabelRequest, CreateLabelResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateLabelCommand}.
8
10
  */
9
11
  export interface CreateLabelCommandInput extends CreateLabelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateLabelCommand}.
13
17
  */
14
18
  export interface CreateLabelCommandOutput extends CreateLabelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>
18
23
  * Creates a label for an event.
19
24
  * </p>
@@ -27,6 +32,8 @@ export interface CreateLabelCommandOutput extends CreateLabelResponse, __Metadat
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param CreateLabelCommandInput - {@link CreateLabelCommandInput}
36
+ * @returns {@link CreateLabelCommandOutput}
30
37
  * @see {@link CreateLabelCommandInput} for command's `input` shape.
31
38
  * @see {@link CreateLabelCommandOutput} for command's `response` shape.
32
39
  * @see {@link LookoutEquipmentClientResolvedConfig | config} for LookoutEquipmentClient's `config` shape.
@@ -62,11 +69,20 @@ export interface CreateLabelCommandOutput extends CreateLabelResponse, __Metadat
62
69
  export declare class CreateLabelCommand extends $Command<CreateLabelCommandInput, CreateLabelCommandOutput, LookoutEquipmentClientResolvedConfig> {
63
70
  readonly input: CreateLabelCommandInput;
64
71
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
65
75
  constructor(input: CreateLabelCommandInput);
66
76
  /**
67
77
  * @internal
68
78
  */
69
79
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LookoutEquipmentClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateLabelCommandInput, CreateLabelCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
70
83
  private serialize;
84
+ /**
85
+ * @internal
86
+ */
71
87
  private deserialize;
72
88
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LookoutEquipmentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LookoutEquipmentClient";
5
5
  import { CreateLabelGroupRequest, CreateLabelGroupResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateLabelGroupCommand}.
8
10
  */
9
11
  export interface CreateLabelGroupCommandInput extends CreateLabelGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateLabelGroupCommand}.
13
17
  */
14
18
  export interface CreateLabelGroupCommandOutput extends CreateLabelGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>
18
23
  * Creates a group of labels.
19
24
  * </p>
@@ -27,6 +32,8 @@ export interface CreateLabelGroupCommandOutput extends CreateLabelGroupResponse,
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param CreateLabelGroupCommandInput - {@link CreateLabelGroupCommandInput}
36
+ * @returns {@link CreateLabelGroupCommandOutput}
30
37
  * @see {@link CreateLabelGroupCommandInput} for command's `input` shape.
31
38
  * @see {@link CreateLabelGroupCommandOutput} for command's `response` shape.
32
39
  * @see {@link LookoutEquipmentClientResolvedConfig | config} for LookoutEquipmentClient's `config` shape.
@@ -58,11 +65,20 @@ export interface CreateLabelGroupCommandOutput extends CreateLabelGroupResponse,
58
65
  export declare class CreateLabelGroupCommand extends $Command<CreateLabelGroupCommandInput, CreateLabelGroupCommandOutput, LookoutEquipmentClientResolvedConfig> {
59
66
  readonly input: CreateLabelGroupCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: CreateLabelGroupCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LookoutEquipmentClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateLabelGroupCommandInput, CreateLabelGroupCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LookoutEquipmentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LookoutEquipmentClient";
5
5
  import { CreateModelRequest, CreateModelResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateModelCommand}.
8
10
  */
9
11
  export interface CreateModelCommandInput extends CreateModelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateModelCommand}.
13
17
  */
14
18
  export interface CreateModelCommandOutput extends CreateModelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an ML model for data inference. </p>
18
23
  * <p>A machine-learning (ML) model is a mathematical model that finds patterns in your data.
19
24
  * In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and
@@ -33,6 +38,8 @@ export interface CreateModelCommandOutput extends CreateModelResponse, __Metadat
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param CreateModelCommandInput - {@link CreateModelCommandInput}
42
+ * @returns {@link CreateModelCommandOutput}
36
43
  * @see {@link CreateModelCommandInput} for command's `input` shape.
37
44
  * @see {@link CreateModelCommandOutput} for command's `response` shape.
38
45
  * @see {@link LookoutEquipmentClientResolvedConfig | config} for LookoutEquipmentClient's `config` shape.
@@ -68,11 +75,20 @@ export interface CreateModelCommandOutput extends CreateModelResponse, __Metadat
68
75
  export declare class CreateModelCommand extends $Command<CreateModelCommandInput, CreateModelCommandOutput, LookoutEquipmentClientResolvedConfig> {
69
76
  readonly input: CreateModelCommandInput;
70
77
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
78
+ /**
79
+ * @public
80
+ */
71
81
  constructor(input: CreateModelCommandInput);
72
82
  /**
73
83
  * @internal
74
84
  */
75
85
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LookoutEquipmentClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateModelCommandInput, CreateModelCommandOutput>;
86
+ /**
87
+ * @internal
88
+ */
76
89
  private serialize;
90
+ /**
91
+ * @internal
92
+ */
77
93
  private deserialize;
78
94
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { LookoutEquipmentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LookoutEquipmentClient";
5
5
  import { DeleteDatasetRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDatasetCommand}.
8
10
  */
9
11
  export interface DeleteDatasetCommandInput extends DeleteDatasetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDatasetCommand}.
13
17
  */
14
18
  export interface DeleteDatasetCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Deletes a dataset and associated artifacts. The operation will check to see if any
18
23
  * inference scheduler or data ingestion job is currently using the dataset, and if there
19
24
  * isn't, the dataset, its metadata, and any associated data stored in S3 will be deleted.
@@ -29,6 +34,8 @@ export interface DeleteDatasetCommandOutput extends __MetadataBearer {
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeleteDatasetCommandInput - {@link DeleteDatasetCommandInput}
38
+ * @returns {@link DeleteDatasetCommandOutput}
32
39
  * @see {@link DeleteDatasetCommandInput} for command's `input` shape.
33
40
  * @see {@link DeleteDatasetCommandOutput} for command's `response` shape.
34
41
  * @see {@link LookoutEquipmentClientResolvedConfig | config} for LookoutEquipmentClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DeleteDatasetCommandOutput extends __MetadataBearer {
61
68
  export declare class DeleteDatasetCommand extends $Command<DeleteDatasetCommandInput, DeleteDatasetCommandOutput, LookoutEquipmentClientResolvedConfig> {
62
69
  readonly input: DeleteDatasetCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: DeleteDatasetCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LookoutEquipmentClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDatasetCommandInput, DeleteDatasetCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }