@aws-sdk/client-iotfleetwise 3.315.0 → 3.319.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.
@@ -50,510 +50,317 @@ import { UpdateModelManifestCommandInput, UpdateModelManifestCommandOutput } fro
50
50
  import { UpdateSignalCatalogCommandInput, UpdateSignalCatalogCommandOutput } from "./commands/UpdateSignalCatalogCommand";
51
51
  import { UpdateVehicleCommandInput, UpdateVehicleCommandOutput } from "./commands/UpdateVehicleCommand";
52
52
  import { IoTFleetWiseClient } from "./IoTFleetWiseClient";
53
- /**
54
- * @public
55
- * <p>Amazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer
56
- * vehicle data to the Amazon Web Services cloud at scale. With Amazon Web Services IoT FleetWise, you can standardize all of
57
- * your vehicle data models, independent of the in-vehicle communication architecture, and
58
- * define data collection rules to transfer only high-value data to the cloud.
59
- * </p>
60
- * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/">What is Amazon Web Services IoT FleetWise?</a> in the
61
- * <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
62
- */
63
- export declare class IoTFleetWise extends IoTFleetWiseClient {
53
+ export interface IoTFleetWise {
64
54
  /**
65
- * @public
66
- * <p> Adds, or associates, a vehicle with a fleet. </p>
55
+ * @see {@link AssociateVehicleFleetCommand}
67
56
  */
68
57
  associateVehicleFleet(args: AssociateVehicleFleetCommandInput, options?: __HttpHandlerOptions): Promise<AssociateVehicleFleetCommandOutput>;
69
58
  associateVehicleFleet(args: AssociateVehicleFleetCommandInput, cb: (err: any, data?: AssociateVehicleFleetCommandOutput) => void): void;
70
59
  associateVehicleFleet(args: AssociateVehicleFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateVehicleFleetCommandOutput) => void): void;
71
60
  /**
72
- * @public
73
- * <p> Creates a group, or batch, of vehicles. </p>
74
- * <note>
75
- * <p> You must specify a decoder manifest and a vehicle model (model manifest) for each
76
- * vehicle. </p>
77
- * </note>
78
- * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/create-vehicles-cli.html">Create multiple
79
- * vehicles (AWS CLI)</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>. </p>
61
+ * @see {@link BatchCreateVehicleCommand}
80
62
  */
81
63
  batchCreateVehicle(args: BatchCreateVehicleCommandInput, options?: __HttpHandlerOptions): Promise<BatchCreateVehicleCommandOutput>;
82
64
  batchCreateVehicle(args: BatchCreateVehicleCommandInput, cb: (err: any, data?: BatchCreateVehicleCommandOutput) => void): void;
83
65
  batchCreateVehicle(args: BatchCreateVehicleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateVehicleCommandOutput) => void): void;
84
66
  /**
85
- * @public
86
- * <p> Updates a group, or batch, of vehicles.</p>
87
- * <note>
88
- * <p> You must specify a decoder manifest and a vehicle model (model manifest) for each
89
- * vehicle. </p>
90
- * </note>
91
- * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/update-vehicles-cli.html">Update multiple
92
- * vehicles (AWS CLI)</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>. </p>
67
+ * @see {@link BatchUpdateVehicleCommand}
93
68
  */
94
69
  batchUpdateVehicle(args: BatchUpdateVehicleCommandInput, options?: __HttpHandlerOptions): Promise<BatchUpdateVehicleCommandOutput>;
95
70
  batchUpdateVehicle(args: BatchUpdateVehicleCommandInput, cb: (err: any, data?: BatchUpdateVehicleCommandOutput) => void): void;
96
71
  batchUpdateVehicle(args: BatchUpdateVehicleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdateVehicleCommandOutput) => void): void;
97
72
  /**
98
- * @public
99
- * <p>Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software
100
- * running in vehicles uses campaigns to decide how to collect and transfer data to the
101
- * cloud. You create campaigns in the cloud. After you or your team approve campaigns,
102
- * Amazon Web Services IoT FleetWise automatically deploys them to vehicles. </p>
103
- * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/campaigns.html">Collect and transfer data
104
- * with campaigns</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
73
+ * @see {@link CreateCampaignCommand}
105
74
  */
106
75
  createCampaign(args: CreateCampaignCommandInput, options?: __HttpHandlerOptions): Promise<CreateCampaignCommandOutput>;
107
76
  createCampaign(args: CreateCampaignCommandInput, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void;
108
77
  createCampaign(args: CreateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void;
109
78
  /**
110
- * @public
111
- * <p>Creates the decoder manifest associated with a model manifest. To create a decoder
112
- * manifest, the following must be true:</p>
113
- * <ul>
114
- * <li>
115
- * <p>Every signal decoder has a unique name.</p>
116
- * </li>
117
- * <li>
118
- * <p>Each signal decoder is associated with a network interface.</p>
119
- * </li>
120
- * <li>
121
- * <p>Each network interface has a unique ID.</p>
122
- * </li>
123
- * <li>
124
- * <p>The signal decoders are specified in the model manifest.</p>
125
- * </li>
126
- * </ul>
79
+ * @see {@link CreateDecoderManifestCommand}
127
80
  */
128
81
  createDecoderManifest(args: CreateDecoderManifestCommandInput, options?: __HttpHandlerOptions): Promise<CreateDecoderManifestCommandOutput>;
129
82
  createDecoderManifest(args: CreateDecoderManifestCommandInput, cb: (err: any, data?: CreateDecoderManifestCommandOutput) => void): void;
130
83
  createDecoderManifest(args: CreateDecoderManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDecoderManifestCommandOutput) => void): void;
131
84
  /**
132
- * @public
133
- * <p> Creates a fleet that represents a group of vehicles.
134
- * </p>
135
- * <note>
136
- * <p>You must create both a signal catalog and vehicles before you can create a fleet.
137
- * </p>
138
- * </note>
139
- * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleets.html">Fleets</a> in the
140
- * <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
85
+ * @see {@link CreateFleetCommand}
141
86
  */
142
87
  createFleet(args: CreateFleetCommandInput, options?: __HttpHandlerOptions): Promise<CreateFleetCommandOutput>;
143
88
  createFleet(args: CreateFleetCommandInput, cb: (err: any, data?: CreateFleetCommandOutput) => void): void;
144
89
  createFleet(args: CreateFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFleetCommandOutput) => void): void;
145
90
  /**
146
- * @public
147
- * <p> Creates a vehicle model (model manifest) that specifies signals (attributes,
148
- * branches, sensors, and actuators). </p>
149
- * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/vehicle-models.html">Vehicle models</a>
150
- * in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
91
+ * @see {@link CreateModelManifestCommand}
151
92
  */
152
93
  createModelManifest(args: CreateModelManifestCommandInput, options?: __HttpHandlerOptions): Promise<CreateModelManifestCommandOutput>;
153
94
  createModelManifest(args: CreateModelManifestCommandInput, cb: (err: any, data?: CreateModelManifestCommandOutput) => void): void;
154
95
  createModelManifest(args: CreateModelManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateModelManifestCommandOutput) => void): void;
155
96
  /**
156
- * @public
157
- * <p> Creates a collection of standardized signals that can be reused to create vehicle
158
- * models.</p>
97
+ * @see {@link CreateSignalCatalogCommand}
159
98
  */
160
99
  createSignalCatalog(args: CreateSignalCatalogCommandInput, options?: __HttpHandlerOptions): Promise<CreateSignalCatalogCommandOutput>;
161
100
  createSignalCatalog(args: CreateSignalCatalogCommandInput, cb: (err: any, data?: CreateSignalCatalogCommandOutput) => void): void;
162
101
  createSignalCatalog(args: CreateSignalCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSignalCatalogCommandOutput) => void): void;
163
102
  /**
164
- * @public
165
- * <p> Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles
166
- * created from the same vehicle model consist of the same signals inherited from the
167
- * vehicle model.</p>
168
- * <note>
169
- * <p> If you have an existing Amazon Web Services IoT Thing, you can use Amazon Web Services IoT FleetWise to create a
170
- * vehicle and collect data from your thing. </p>
171
- * </note>
172
- * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/create-vehicle-cli.html">Create a vehicle
173
- * (AWS CLI)</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
103
+ * @see {@link CreateVehicleCommand}
174
104
  */
175
105
  createVehicle(args: CreateVehicleCommandInput, options?: __HttpHandlerOptions): Promise<CreateVehicleCommandOutput>;
176
106
  createVehicle(args: CreateVehicleCommandInput, cb: (err: any, data?: CreateVehicleCommandOutput) => void): void;
177
107
  createVehicle(args: CreateVehicleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVehicleCommandOutput) => void): void;
178
108
  /**
179
- * @public
180
- * <p> Deletes a data collection campaign. Deleting a campaign suspends all data collection
181
- * and removes it from any vehicles. </p>
109
+ * @see {@link DeleteCampaignCommand}
182
110
  */
183
111
  deleteCampaign(args: DeleteCampaignCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCampaignCommandOutput>;
184
112
  deleteCampaign(args: DeleteCampaignCommandInput, cb: (err: any, data?: DeleteCampaignCommandOutput) => void): void;
185
113
  deleteCampaign(args: DeleteCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCampaignCommandOutput) => void): void;
186
114
  /**
187
- * @public
188
- * <p> Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles
189
- * associated with it. </p>
190
- * <note>
191
- * <p>If the decoder manifest is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200
192
- * response with an empty body.</p>
193
- * </note>
115
+ * @see {@link DeleteDecoderManifestCommand}
194
116
  */
195
117
  deleteDecoderManifest(args: DeleteDecoderManifestCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDecoderManifestCommandOutput>;
196
118
  deleteDecoderManifest(args: DeleteDecoderManifestCommandInput, cb: (err: any, data?: DeleteDecoderManifestCommandOutput) => void): void;
197
119
  deleteDecoderManifest(args: DeleteDecoderManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDecoderManifestCommandOutput) => void): void;
198
120
  /**
199
- * @public
200
- * <p> Deletes a fleet. Before you delete a fleet, all vehicles must be
201
- * dissociated from the fleet. For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/delete-fleet-cli.html">Delete a fleet (AWS
202
- * CLI)</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
203
- * <note>
204
- * <p>If the fleet is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response
205
- * with an empty body.</p>
206
- * </note>
121
+ * @see {@link DeleteFleetCommand}
207
122
  */
208
123
  deleteFleet(args: DeleteFleetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteFleetCommandOutput>;
209
124
  deleteFleet(args: DeleteFleetCommandInput, cb: (err: any, data?: DeleteFleetCommandOutput) => void): void;
210
125
  deleteFleet(args: DeleteFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFleetCommandOutput) => void): void;
211
126
  /**
212
- * @public
213
- * <p> Deletes a vehicle model (model manifest).</p>
214
- * <note>
215
- * <p>If the vehicle model is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200
216
- * response with an empty body.</p>
217
- * </note>
127
+ * @see {@link DeleteModelManifestCommand}
218
128
  */
219
129
  deleteModelManifest(args: DeleteModelManifestCommandInput, options?: __HttpHandlerOptions): Promise<DeleteModelManifestCommandOutput>;
220
130
  deleteModelManifest(args: DeleteModelManifestCommandInput, cb: (err: any, data?: DeleteModelManifestCommandOutput) => void): void;
221
131
  deleteModelManifest(args: DeleteModelManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteModelManifestCommandOutput) => void): void;
222
132
  /**
223
- * @public
224
- * <p> Deletes a signal catalog. </p>
225
- * <note>
226
- * <p>If the signal catalog is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200
227
- * response with an empty body.</p>
228
- * </note>
133
+ * @see {@link DeleteSignalCatalogCommand}
229
134
  */
230
135
  deleteSignalCatalog(args: DeleteSignalCatalogCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSignalCatalogCommandOutput>;
231
136
  deleteSignalCatalog(args: DeleteSignalCatalogCommandInput, cb: (err: any, data?: DeleteSignalCatalogCommandOutput) => void): void;
232
137
  deleteSignalCatalog(args: DeleteSignalCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSignalCatalogCommandOutput) => void): void;
233
138
  /**
234
- * @public
235
- * <p> Deletes a vehicle and removes it from any campaigns.</p>
236
- * <note>
237
- * <p>If the vehicle is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response
238
- * with an empty body.</p>
239
- * </note>
139
+ * @see {@link DeleteVehicleCommand}
240
140
  */
241
141
  deleteVehicle(args: DeleteVehicleCommandInput, options?: __HttpHandlerOptions): Promise<DeleteVehicleCommandOutput>;
242
142
  deleteVehicle(args: DeleteVehicleCommandInput, cb: (err: any, data?: DeleteVehicleCommandOutput) => void): void;
243
143
  deleteVehicle(args: DeleteVehicleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVehicleCommandOutput) => void): void;
244
144
  /**
245
- * @public
246
- * <p>Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a
247
- * fleet doesn't delete the vehicle.</p>
248
- * <note>
249
- * <p>If the vehicle is successfully dissociated from a fleet, Amazon Web Services IoT FleetWise sends back an
250
- * HTTP 200 response with an empty body.</p>
251
- * </note>
145
+ * @see {@link DisassociateVehicleFleetCommand}
252
146
  */
253
147
  disassociateVehicleFleet(args: DisassociateVehicleFleetCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateVehicleFleetCommandOutput>;
254
148
  disassociateVehicleFleet(args: DisassociateVehicleFleetCommandInput, cb: (err: any, data?: DisassociateVehicleFleetCommandOutput) => void): void;
255
149
  disassociateVehicleFleet(args: DisassociateVehicleFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateVehicleFleetCommandOutput) => void): void;
256
150
  /**
257
- * @public
258
- * <p> Retrieves information about a campaign. </p>
151
+ * @see {@link GetCampaignCommand}
259
152
  */
260
153
  getCampaign(args: GetCampaignCommandInput, options?: __HttpHandlerOptions): Promise<GetCampaignCommandOutput>;
261
154
  getCampaign(args: GetCampaignCommandInput, cb: (err: any, data?: GetCampaignCommandOutput) => void): void;
262
155
  getCampaign(args: GetCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCampaignCommandOutput) => void): void;
263
156
  /**
264
- * @public
265
- * <p> Retrieves information about a created decoder manifest. </p>
157
+ * @see {@link GetDecoderManifestCommand}
266
158
  */
267
159
  getDecoderManifest(args: GetDecoderManifestCommandInput, options?: __HttpHandlerOptions): Promise<GetDecoderManifestCommandOutput>;
268
160
  getDecoderManifest(args: GetDecoderManifestCommandInput, cb: (err: any, data?: GetDecoderManifestCommandOutput) => void): void;
269
161
  getDecoderManifest(args: GetDecoderManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDecoderManifestCommandOutput) => void): void;
270
162
  /**
271
- * @public
272
- * <p> Retrieves information about a fleet. </p>
163
+ * @see {@link GetFleetCommand}
273
164
  */
274
165
  getFleet(args: GetFleetCommandInput, options?: __HttpHandlerOptions): Promise<GetFleetCommandOutput>;
275
166
  getFleet(args: GetFleetCommandInput, cb: (err: any, data?: GetFleetCommandOutput) => void): void;
276
167
  getFleet(args: GetFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFleetCommandOutput) => void): void;
277
168
  /**
278
- * @public
279
- * <p>Retrieves the logging options.</p>
169
+ * @see {@link GetLoggingOptionsCommand}
280
170
  */
281
171
  getLoggingOptions(args: GetLoggingOptionsCommandInput, options?: __HttpHandlerOptions): Promise<GetLoggingOptionsCommandOutput>;
282
172
  getLoggingOptions(args: GetLoggingOptionsCommandInput, cb: (err: any, data?: GetLoggingOptionsCommandOutput) => void): void;
283
173
  getLoggingOptions(args: GetLoggingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLoggingOptionsCommandOutput) => void): void;
284
174
  /**
285
- * @public
286
- * <p> Retrieves information about a vehicle model (model manifest). </p>
175
+ * @see {@link GetModelManifestCommand}
287
176
  */
288
177
  getModelManifest(args: GetModelManifestCommandInput, options?: __HttpHandlerOptions): Promise<GetModelManifestCommandOutput>;
289
178
  getModelManifest(args: GetModelManifestCommandInput, cb: (err: any, data?: GetModelManifestCommandOutput) => void): void;
290
179
  getModelManifest(args: GetModelManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetModelManifestCommandOutput) => void): void;
291
180
  /**
292
- * @public
293
- * <p> Retrieves information about the status of registering your Amazon Web Services account, IAM, and
294
- * Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services
295
- * Cloud. </p>
296
- * <p>For more information, including step-by-step procedures, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/setting-up.html">Setting up Amazon Web Services IoT FleetWise</a>. </p>
297
- * <note>
298
- * <p>This API operation doesn't require input parameters.</p>
299
- * </note>
181
+ * @see {@link GetRegisterAccountStatusCommand}
300
182
  */
301
183
  getRegisterAccountStatus(args: GetRegisterAccountStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetRegisterAccountStatusCommandOutput>;
302
184
  getRegisterAccountStatus(args: GetRegisterAccountStatusCommandInput, cb: (err: any, data?: GetRegisterAccountStatusCommandOutput) => void): void;
303
185
  getRegisterAccountStatus(args: GetRegisterAccountStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegisterAccountStatusCommandOutput) => void): void;
304
186
  /**
305
- * @public
306
- * <p> Retrieves information about a signal catalog. </p>
187
+ * @see {@link GetSignalCatalogCommand}
307
188
  */
308
189
  getSignalCatalog(args: GetSignalCatalogCommandInput, options?: __HttpHandlerOptions): Promise<GetSignalCatalogCommandOutput>;
309
190
  getSignalCatalog(args: GetSignalCatalogCommandInput, cb: (err: any, data?: GetSignalCatalogCommandOutput) => void): void;
310
191
  getSignalCatalog(args: GetSignalCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSignalCatalogCommandOutput) => void): void;
311
192
  /**
312
- * @public
313
- * <p> Retrieves information about a vehicle. </p>
193
+ * @see {@link GetVehicleCommand}
314
194
  */
315
195
  getVehicle(args: GetVehicleCommandInput, options?: __HttpHandlerOptions): Promise<GetVehicleCommandOutput>;
316
196
  getVehicle(args: GetVehicleCommandInput, cb: (err: any, data?: GetVehicleCommandOutput) => void): void;
317
197
  getVehicle(args: GetVehicleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVehicleCommandOutput) => void): void;
318
198
  /**
319
- * @public
320
- * <p> Retrieves information about the status of a vehicle with any associated campaigns.
321
- * </p>
199
+ * @see {@link GetVehicleStatusCommand}
322
200
  */
323
201
  getVehicleStatus(args: GetVehicleStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetVehicleStatusCommandOutput>;
324
202
  getVehicleStatus(args: GetVehicleStatusCommandInput, cb: (err: any, data?: GetVehicleStatusCommandOutput) => void): void;
325
203
  getVehicleStatus(args: GetVehicleStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVehicleStatusCommandOutput) => void): void;
326
204
  /**
327
- * @public
328
- * <p> Creates a decoder manifest using your existing CAN DBC file from your local device.
329
- * </p>
205
+ * @see {@link ImportDecoderManifestCommand}
330
206
  */
331
207
  importDecoderManifest(args: ImportDecoderManifestCommandInput, options?: __HttpHandlerOptions): Promise<ImportDecoderManifestCommandOutput>;
332
208
  importDecoderManifest(args: ImportDecoderManifestCommandInput, cb: (err: any, data?: ImportDecoderManifestCommandOutput) => void): void;
333
209
  importDecoderManifest(args: ImportDecoderManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportDecoderManifestCommandOutput) => void): void;
334
210
  /**
335
- * @public
336
- * <p> Creates a signal catalog using your existing VSS formatted content from your local
337
- * device. </p>
211
+ * @see {@link ImportSignalCatalogCommand}
338
212
  */
339
213
  importSignalCatalog(args: ImportSignalCatalogCommandInput, options?: __HttpHandlerOptions): Promise<ImportSignalCatalogCommandOutput>;
340
214
  importSignalCatalog(args: ImportSignalCatalogCommandInput, cb: (err: any, data?: ImportSignalCatalogCommandOutput) => void): void;
341
215
  importSignalCatalog(args: ImportSignalCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportSignalCatalogCommandOutput) => void): void;
342
216
  /**
343
- * @public
344
- * <p> Lists information about created campaigns. </p>
345
- * <note>
346
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the request to return more results.</p>
347
- * </note>
217
+ * @see {@link ListCampaignsCommand}
348
218
  */
349
219
  listCampaigns(args: ListCampaignsCommandInput, options?: __HttpHandlerOptions): Promise<ListCampaignsCommandOutput>;
350
220
  listCampaigns(args: ListCampaignsCommandInput, cb: (err: any, data?: ListCampaignsCommandOutput) => void): void;
351
221
  listCampaigns(args: ListCampaignsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCampaignsCommandOutput) => void): void;
352
222
  /**
353
- * @public
354
- * <p> Lists the network interfaces specified in a decoder manifest. </p>
355
- * <note>
356
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the request to return more results.</p>
357
- * </note>
223
+ * @see {@link ListDecoderManifestNetworkInterfacesCommand}
358
224
  */
359
225
  listDecoderManifestNetworkInterfaces(args: ListDecoderManifestNetworkInterfacesCommandInput, options?: __HttpHandlerOptions): Promise<ListDecoderManifestNetworkInterfacesCommandOutput>;
360
226
  listDecoderManifestNetworkInterfaces(args: ListDecoderManifestNetworkInterfacesCommandInput, cb: (err: any, data?: ListDecoderManifestNetworkInterfacesCommandOutput) => void): void;
361
227
  listDecoderManifestNetworkInterfaces(args: ListDecoderManifestNetworkInterfacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDecoderManifestNetworkInterfacesCommandOutput) => void): void;
362
228
  /**
363
- * @public
364
- * <p> Lists decoder manifests. </p>
365
- * <note>
366
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the request to return more results.</p>
367
- * </note>
229
+ * @see {@link ListDecoderManifestsCommand}
368
230
  */
369
231
  listDecoderManifests(args: ListDecoderManifestsCommandInput, options?: __HttpHandlerOptions): Promise<ListDecoderManifestsCommandOutput>;
370
232
  listDecoderManifests(args: ListDecoderManifestsCommandInput, cb: (err: any, data?: ListDecoderManifestsCommandOutput) => void): void;
371
233
  listDecoderManifests(args: ListDecoderManifestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDecoderManifestsCommandOutput) => void): void;
372
234
  /**
373
- * @public
374
- * <p> A list of information about signal decoders specified in a decoder manifest. </p>
375
- * <note>
376
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the request to return more results.</p>
377
- * </note>
235
+ * @see {@link ListDecoderManifestSignalsCommand}
378
236
  */
379
237
  listDecoderManifestSignals(args: ListDecoderManifestSignalsCommandInput, options?: __HttpHandlerOptions): Promise<ListDecoderManifestSignalsCommandOutput>;
380
238
  listDecoderManifestSignals(args: ListDecoderManifestSignalsCommandInput, cb: (err: any, data?: ListDecoderManifestSignalsCommandOutput) => void): void;
381
239
  listDecoderManifestSignals(args: ListDecoderManifestSignalsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDecoderManifestSignalsCommandOutput) => void): void;
382
240
  /**
383
- * @public
384
- * <p> Retrieves information for each created fleet in an Amazon Web Services account. </p>
385
- * <note>
386
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the request to return more results.</p>
387
- * </note>
241
+ * @see {@link ListFleetsCommand}
388
242
  */
389
243
  listFleets(args: ListFleetsCommandInput, options?: __HttpHandlerOptions): Promise<ListFleetsCommandOutput>;
390
244
  listFleets(args: ListFleetsCommandInput, cb: (err: any, data?: ListFleetsCommandOutput) => void): void;
391
245
  listFleets(args: ListFleetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFleetsCommandOutput) => void): void;
392
246
  /**
393
- * @public
394
- * <p>Retrieves a list of IDs for all fleets that the vehicle is associated with.</p>
395
- * <note>
396
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the request to return more results.</p>
397
- * </note>
247
+ * @see {@link ListFleetsForVehicleCommand}
398
248
  */
399
249
  listFleetsForVehicle(args: ListFleetsForVehicleCommandInput, options?: __HttpHandlerOptions): Promise<ListFleetsForVehicleCommandOutput>;
400
250
  listFleetsForVehicle(args: ListFleetsForVehicleCommandInput, cb: (err: any, data?: ListFleetsForVehicleCommandOutput) => void): void;
401
251
  listFleetsForVehicle(args: ListFleetsForVehicleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFleetsForVehicleCommandOutput) => void): void;
402
252
  /**
403
- * @public
404
- * <p> Lists information about nodes specified in a vehicle model (model manifest). </p>
405
- * <note>
406
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the request to return more results.</p>
407
- * </note>
253
+ * @see {@link ListModelManifestNodesCommand}
408
254
  */
409
255
  listModelManifestNodes(args: ListModelManifestNodesCommandInput, options?: __HttpHandlerOptions): Promise<ListModelManifestNodesCommandOutput>;
410
256
  listModelManifestNodes(args: ListModelManifestNodesCommandInput, cb: (err: any, data?: ListModelManifestNodesCommandOutput) => void): void;
411
257
  listModelManifestNodes(args: ListModelManifestNodesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListModelManifestNodesCommandOutput) => void): void;
412
258
  /**
413
- * @public
414
- * <p> Retrieves a list of vehicle models (model manifests). </p>
415
- * <note>
416
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the request to return more results.</p>
417
- * </note>
259
+ * @see {@link ListModelManifestsCommand}
418
260
  */
419
261
  listModelManifests(args: ListModelManifestsCommandInput, options?: __HttpHandlerOptions): Promise<ListModelManifestsCommandOutput>;
420
262
  listModelManifests(args: ListModelManifestsCommandInput, cb: (err: any, data?: ListModelManifestsCommandOutput) => void): void;
421
263
  listModelManifests(args: ListModelManifestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListModelManifestsCommandOutput) => void): void;
422
264
  /**
423
- * @public
424
- * <p> Lists of information about the signals (nodes) specified in a signal catalog. </p>
425
- * <note>
426
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the request to return more results.</p>
427
- * </note>
265
+ * @see {@link ListSignalCatalogNodesCommand}
428
266
  */
429
267
  listSignalCatalogNodes(args: ListSignalCatalogNodesCommandInput, options?: __HttpHandlerOptions): Promise<ListSignalCatalogNodesCommandOutput>;
430
268
  listSignalCatalogNodes(args: ListSignalCatalogNodesCommandInput, cb: (err: any, data?: ListSignalCatalogNodesCommandOutput) => void): void;
431
269
  listSignalCatalogNodes(args: ListSignalCatalogNodesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSignalCatalogNodesCommandOutput) => void): void;
432
270
  /**
433
- * @public
434
- * <p> Lists all the created signal catalogs in an Amazon Web Services account. </p>
435
- * <p>You can use to list information about
436
- * each signal (node) specified in a signal catalog.</p>
437
- * <note>
438
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the request to return more results.</p>
439
- * </note>
271
+ * @see {@link ListSignalCatalogsCommand}
440
272
  */
441
273
  listSignalCatalogs(args: ListSignalCatalogsCommandInput, options?: __HttpHandlerOptions): Promise<ListSignalCatalogsCommandOutput>;
442
274
  listSignalCatalogs(args: ListSignalCatalogsCommandInput, cb: (err: any, data?: ListSignalCatalogsCommandOutput) => void): void;
443
275
  listSignalCatalogs(args: ListSignalCatalogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSignalCatalogsCommandOutput) => void): void;
444
276
  /**
445
- * @public
446
- * <p>Lists the tags (metadata) you have assigned to the resource.</p>
277
+ * @see {@link ListTagsForResourceCommand}
447
278
  */
448
279
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
449
280
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
450
281
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
451
282
  /**
452
- * @public
453
- * <p> Retrieves a list of summaries of created vehicles. </p>
454
- * <note>
455
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the request to return more results.</p>
456
- * </note>
283
+ * @see {@link ListVehiclesCommand}
457
284
  */
458
285
  listVehicles(args: ListVehiclesCommandInput, options?: __HttpHandlerOptions): Promise<ListVehiclesCommandOutput>;
459
286
  listVehicles(args: ListVehiclesCommandInput, cb: (err: any, data?: ListVehiclesCommandOutput) => void): void;
460
287
  listVehicles(args: ListVehiclesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVehiclesCommandOutput) => void): void;
461
288
  /**
462
- * @public
463
- * <p> Retrieves a list of summaries of all vehicles associated with a fleet. </p>
464
- * <note>
465
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the request to return more results.</p>
466
- * </note>
289
+ * @see {@link ListVehiclesInFleetCommand}
467
290
  */
468
291
  listVehiclesInFleet(args: ListVehiclesInFleetCommandInput, options?: __HttpHandlerOptions): Promise<ListVehiclesInFleetCommandOutput>;
469
292
  listVehiclesInFleet(args: ListVehiclesInFleetCommandInput, cb: (err: any, data?: ListVehiclesInFleetCommandOutput) => void): void;
470
293
  listVehiclesInFleet(args: ListVehiclesInFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVehiclesInFleetCommandOutput) => void): void;
471
294
  /**
472
- * @public
473
- * <p>Creates or updates the logging option.</p>
295
+ * @see {@link PutLoggingOptionsCommand}
474
296
  */
475
297
  putLoggingOptions(args: PutLoggingOptionsCommandInput, options?: __HttpHandlerOptions): Promise<PutLoggingOptionsCommandOutput>;
476
298
  putLoggingOptions(args: PutLoggingOptionsCommandInput, cb: (err: any, data?: PutLoggingOptionsCommandOutput) => void): void;
477
299
  putLoggingOptions(args: PutLoggingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLoggingOptionsCommandOutput) => void): void;
478
300
  /**
479
- * @public
480
- * <p>Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can
481
- * transfer your vehicle data to the Amazon Web Services Cloud. For more information, including
482
- * step-by-step procedures, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/setting-up.html">Setting up
483
- * Amazon Web Services IoT FleetWise</a>. </p>
484
- * <note>
485
- * <p>An Amazon Web Services account is <b>not</b> the same thing as a "user
486
- * account". An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_identity-management.html#intro-identity-users">Amazon Web Services user</a> is an identity that you create using Identity and Access Management (IAM) and
487
- * takes the form of either an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html">IAM user</a> or an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM role, both
488
- * with credentials</a>. A single Amazon Web Services account can, and typically does,
489
- * contain many users and roles.</p>
490
- * </note>
301
+ * @see {@link RegisterAccountCommand}
491
302
  */
492
303
  registerAccount(args: RegisterAccountCommandInput, options?: __HttpHandlerOptions): Promise<RegisterAccountCommandOutput>;
493
304
  registerAccount(args: RegisterAccountCommandInput, cb: (err: any, data?: RegisterAccountCommandOutput) => void): void;
494
305
  registerAccount(args: RegisterAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterAccountCommandOutput) => void): void;
495
306
  /**
496
- * @public
497
- * <p>Adds to or modifies the tags of the given resource. Tags are metadata which can be
498
- * used to manage a resource.</p>
307
+ * @see {@link TagResourceCommand}
499
308
  */
500
309
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
501
310
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
502
311
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
503
312
  /**
504
- * @public
505
- * <p>Removes the given tags (metadata) from the resource.</p>
313
+ * @see {@link UntagResourceCommand}
506
314
  */
507
315
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
508
316
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
509
317
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
510
318
  /**
511
- * @public
512
- * <p> Updates a campaign. </p>
319
+ * @see {@link UpdateCampaignCommand}
513
320
  */
514
321
  updateCampaign(args: UpdateCampaignCommandInput, options?: __HttpHandlerOptions): Promise<UpdateCampaignCommandOutput>;
515
322
  updateCampaign(args: UpdateCampaignCommandInput, cb: (err: any, data?: UpdateCampaignCommandOutput) => void): void;
516
323
  updateCampaign(args: UpdateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCampaignCommandOutput) => void): void;
517
324
  /**
518
- * @public
519
- * <p> Updates a decoder manifest.</p>
520
- * <p>A decoder manifest can only be updated when the status is <code>DRAFT</code>. Only
521
- * <code>ACTIVE</code> decoder manifests can be associated with vehicles.</p>
325
+ * @see {@link UpdateDecoderManifestCommand}
522
326
  */
523
327
  updateDecoderManifest(args: UpdateDecoderManifestCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDecoderManifestCommandOutput>;
524
328
  updateDecoderManifest(args: UpdateDecoderManifestCommandInput, cb: (err: any, data?: UpdateDecoderManifestCommandOutput) => void): void;
525
329
  updateDecoderManifest(args: UpdateDecoderManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDecoderManifestCommandOutput) => void): void;
526
330
  /**
527
- * @public
528
- * <p> Updates the description of an existing fleet. </p>
529
- * <note>
530
- * <p>If the fleet is successfully updated, Amazon Web Services IoT FleetWise sends back an HTTP 200 response
531
- * with an empty HTTP body.</p>
532
- * </note>
331
+ * @see {@link UpdateFleetCommand}
533
332
  */
534
333
  updateFleet(args: UpdateFleetCommandInput, options?: __HttpHandlerOptions): Promise<UpdateFleetCommandOutput>;
535
334
  updateFleet(args: UpdateFleetCommandInput, cb: (err: any, data?: UpdateFleetCommandOutput) => void): void;
536
335
  updateFleet(args: UpdateFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFleetCommandOutput) => void): void;
537
336
  /**
538
- * @public
539
- * <p> Updates a vehicle model (model manifest). If created vehicles are associated with a
540
- * vehicle model, it can't be updated.</p>
337
+ * @see {@link UpdateModelManifestCommand}
541
338
  */
542
339
  updateModelManifest(args: UpdateModelManifestCommandInput, options?: __HttpHandlerOptions): Promise<UpdateModelManifestCommandOutput>;
543
340
  updateModelManifest(args: UpdateModelManifestCommandInput, cb: (err: any, data?: UpdateModelManifestCommandOutput) => void): void;
544
341
  updateModelManifest(args: UpdateModelManifestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateModelManifestCommandOutput) => void): void;
545
342
  /**
546
- * @public
547
- * <p> Updates a signal catalog. </p>
343
+ * @see {@link UpdateSignalCatalogCommand}
548
344
  */
549
345
  updateSignalCatalog(args: UpdateSignalCatalogCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSignalCatalogCommandOutput>;
550
346
  updateSignalCatalog(args: UpdateSignalCatalogCommandInput, cb: (err: any, data?: UpdateSignalCatalogCommandOutput) => void): void;
551
347
  updateSignalCatalog(args: UpdateSignalCatalogCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSignalCatalogCommandOutput) => void): void;
552
348
  /**
553
- * @public
554
- * <p> Updates a vehicle. </p>
349
+ * @see {@link UpdateVehicleCommand}
555
350
  */
556
351
  updateVehicle(args: UpdateVehicleCommandInput, options?: __HttpHandlerOptions): Promise<UpdateVehicleCommandOutput>;
557
352
  updateVehicle(args: UpdateVehicleCommandInput, cb: (err: any, data?: UpdateVehicleCommandOutput) => void): void;
558
353
  updateVehicle(args: UpdateVehicleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVehicleCommandOutput) => void): void;
559
354
  }
355
+ /**
356
+ * @public
357
+ * <p>Amazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer
358
+ * vehicle data to the Amazon Web Services cloud at scale. With Amazon Web Services IoT FleetWise, you can standardize all of
359
+ * your vehicle data models, independent of the in-vehicle communication architecture, and
360
+ * define data collection rules to transfer only high-value data to the cloud.
361
+ * </p>
362
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/">What is Amazon Web Services IoT FleetWise?</a> in the
363
+ * <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
364
+ */
365
+ export declare class IoTFleetWise extends IoTFleetWiseClient implements IoTFleetWise {
366
+ }
@@ -200,7 +200,7 @@ import {
200
200
  UpdateVehicleCommandOutput,
201
201
  } from "./commands/UpdateVehicleCommand";
202
202
  import { IoTFleetWiseClient } from "./IoTFleetWiseClient";
203
- export declare class IoTFleetWise extends IoTFleetWiseClient {
203
+ export interface IoTFleetWise {
204
204
  associateVehicleFleet(
205
205
  args: AssociateVehicleFleetCommandInput,
206
206
  options?: __HttpHandlerOptions
@@ -858,3 +858,6 @@ export declare class IoTFleetWise extends IoTFleetWiseClient {
858
858
  cb: (err: any, data?: UpdateVehicleCommandOutput) => void
859
859
  ): void;
860
860
  }
861
+ export declare class IoTFleetWise
862
+ extends IoTFleetWiseClient
863
+ implements IoTFleetWise {}