Skip to content

Commit 5d2c0b1

Browse files
author
awstools
committed
feat(client-iotfleetwise): AWS IoT FleetWise now includes campaign parameters to store and forward data, configure MQTT topic as a data destination, and collect diagnostic trouble code data. It includes APIs for network agnostic data collection using custom decoding interfaces, and monitoring the last known state of vehicles.
1 parent b203a9c commit 5d2c0b1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+4270
-330
lines changed

Diff for: clients/client-iotfleetwise/README.md

+43
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ define data collection rules to transfer only high-value data to the cloud.
1313
</p>
1414
<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
1515
<i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
16+
<important>
17+
<p>Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">Amazon Web Services Region and feature availability</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
18+
</important>
1619

1720
## Installing
1821

@@ -272,6 +275,14 @@ CreateSignalCatalog
272275

273276
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotfleetwise/command/CreateSignalCatalogCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/CreateSignalCatalogCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/CreateSignalCatalogCommandOutput/)
274277

278+
</details>
279+
<details>
280+
<summary>
281+
CreateStateTemplate
282+
</summary>
283+
284+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotfleetwise/command/CreateStateTemplateCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/CreateStateTemplateCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/CreateStateTemplateCommandOutput/)
285+
275286
</details>
276287
<details>
277288
<summary>
@@ -320,6 +331,14 @@ DeleteSignalCatalog
320331

321332
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotfleetwise/command/DeleteSignalCatalogCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/DeleteSignalCatalogCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/DeleteSignalCatalogCommandOutput/)
322333

334+
</details>
335+
<details>
336+
<summary>
337+
DeleteStateTemplate
338+
</summary>
339+
340+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotfleetwise/command/DeleteStateTemplateCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/DeleteStateTemplateCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/DeleteStateTemplateCommandOutput/)
341+
323342
</details>
324343
<details>
325344
<summary>
@@ -400,6 +419,14 @@ GetSignalCatalog
400419

401420
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotfleetwise/command/GetSignalCatalogCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/GetSignalCatalogCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/GetSignalCatalogCommandOutput/)
402421

422+
</details>
423+
<details>
424+
<summary>
425+
GetStateTemplate
426+
</summary>
427+
428+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotfleetwise/command/GetStateTemplateCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/GetStateTemplateCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/GetStateTemplateCommandOutput/)
429+
403430
</details>
404431
<details>
405432
<summary>
@@ -512,6 +539,14 @@ ListSignalCatalogs
512539

513540
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotfleetwise/command/ListSignalCatalogsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/ListSignalCatalogsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/ListSignalCatalogsCommandOutput/)
514541

542+
</details>
543+
<details>
544+
<summary>
545+
ListStateTemplates
546+
</summary>
547+
548+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotfleetwise/command/ListStateTemplatesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/ListStateTemplatesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/ListStateTemplatesCommandOutput/)
549+
515550
</details>
516551
<details>
517552
<summary>
@@ -616,6 +651,14 @@ UpdateSignalCatalog
616651

617652
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotfleetwise/command/UpdateSignalCatalogCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/UpdateSignalCatalogCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/UpdateSignalCatalogCommandOutput/)
618653

654+
</details>
655+
<details>
656+
<summary>
657+
UpdateStateTemplate
658+
</summary>
659+
660+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iotfleetwise/command/UpdateStateTemplateCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/UpdateStateTemplateCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-iotfleetwise/Interface/UpdateStateTemplateCommandOutput/)
661+
619662
</details>
620663
<details>
621664
<summary>

Diff for: clients/client-iotfleetwise/src/IoTFleetWise.ts

+119
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,11 @@ import {
3838
CreateSignalCatalogCommandInput,
3939
CreateSignalCatalogCommandOutput,
4040
} from "./commands/CreateSignalCatalogCommand";
41+
import {
42+
CreateStateTemplateCommand,
43+
CreateStateTemplateCommandInput,
44+
CreateStateTemplateCommandOutput,
45+
} from "./commands/CreateStateTemplateCommand";
4146
import {
4247
CreateVehicleCommand,
4348
CreateVehicleCommandInput,
@@ -64,6 +69,11 @@ import {
6469
DeleteSignalCatalogCommandInput,
6570
DeleteSignalCatalogCommandOutput,
6671
} from "./commands/DeleteSignalCatalogCommand";
72+
import {
73+
DeleteStateTemplateCommand,
74+
DeleteStateTemplateCommandInput,
75+
DeleteStateTemplateCommandOutput,
76+
} from "./commands/DeleteStateTemplateCommand";
6777
import {
6878
DeleteVehicleCommand,
6979
DeleteVehicleCommandInput,
@@ -106,6 +116,11 @@ import {
106116
GetSignalCatalogCommandInput,
107117
GetSignalCatalogCommandOutput,
108118
} from "./commands/GetSignalCatalogCommand";
119+
import {
120+
GetStateTemplateCommand,
121+
GetStateTemplateCommandInput,
122+
GetStateTemplateCommandOutput,
123+
} from "./commands/GetStateTemplateCommand";
109124
import { GetVehicleCommand, GetVehicleCommandInput, GetVehicleCommandOutput } from "./commands/GetVehicleCommand";
110125
import {
111126
GetVehicleStatusCommand,
@@ -168,6 +183,11 @@ import {
168183
ListSignalCatalogsCommandInput,
169184
ListSignalCatalogsCommandOutput,
170185
} from "./commands/ListSignalCatalogsCommand";
186+
import {
187+
ListStateTemplatesCommand,
188+
ListStateTemplatesCommandInput,
189+
ListStateTemplatesCommandOutput,
190+
} from "./commands/ListStateTemplatesCommand";
171191
import {
172192
ListTagsForResourceCommand,
173193
ListTagsForResourceCommandInput,
@@ -225,6 +245,11 @@ import {
225245
UpdateSignalCatalogCommandInput,
226246
UpdateSignalCatalogCommandOutput,
227247
} from "./commands/UpdateSignalCatalogCommand";
248+
import {
249+
UpdateStateTemplateCommand,
250+
UpdateStateTemplateCommandInput,
251+
UpdateStateTemplateCommandOutput,
252+
} from "./commands/UpdateStateTemplateCommand";
228253
import {
229254
UpdateVehicleCommand,
230255
UpdateVehicleCommandInput,
@@ -241,12 +266,14 @@ const commands = {
241266
CreateFleetCommand,
242267
CreateModelManifestCommand,
243268
CreateSignalCatalogCommand,
269+
CreateStateTemplateCommand,
244270
CreateVehicleCommand,
245271
DeleteCampaignCommand,
246272
DeleteDecoderManifestCommand,
247273
DeleteFleetCommand,
248274
DeleteModelManifestCommand,
249275
DeleteSignalCatalogCommand,
276+
DeleteStateTemplateCommand,
250277
DeleteVehicleCommand,
251278
DisassociateVehicleFleetCommand,
252279
GetCampaignCommand,
@@ -257,6 +284,7 @@ const commands = {
257284
GetModelManifestCommand,
258285
GetRegisterAccountStatusCommand,
259286
GetSignalCatalogCommand,
287+
GetStateTemplateCommand,
260288
GetVehicleCommand,
261289
GetVehicleStatusCommand,
262290
ImportDecoderManifestCommand,
@@ -271,6 +299,7 @@ const commands = {
271299
ListModelManifestsCommand,
272300
ListSignalCatalogNodesCommand,
273301
ListSignalCatalogsCommand,
302+
ListStateTemplatesCommand,
274303
ListTagsForResourceCommand,
275304
ListVehiclesCommand,
276305
ListVehiclesInFleetCommand,
@@ -284,6 +313,7 @@ const commands = {
284313
UpdateFleetCommand,
285314
UpdateModelManifestCommand,
286315
UpdateSignalCatalogCommand,
316+
UpdateStateTemplateCommand,
287317
UpdateVehicleCommand,
288318
};
289319

@@ -415,6 +445,23 @@ export interface IoTFleetWise {
415445
cb: (err: any, data?: CreateSignalCatalogCommandOutput) => void
416446
): void;
417447

448+
/**
449+
* @see {@link CreateStateTemplateCommand}
450+
*/
451+
createStateTemplate(
452+
args: CreateStateTemplateCommandInput,
453+
options?: __HttpHandlerOptions
454+
): Promise<CreateStateTemplateCommandOutput>;
455+
createStateTemplate(
456+
args: CreateStateTemplateCommandInput,
457+
cb: (err: any, data?: CreateStateTemplateCommandOutput) => void
458+
): void;
459+
createStateTemplate(
460+
args: CreateStateTemplateCommandInput,
461+
options: __HttpHandlerOptions,
462+
cb: (err: any, data?: CreateStateTemplateCommandOutput) => void
463+
): void;
464+
418465
/**
419466
* @see {@link CreateVehicleCommand}
420467
*/
@@ -502,6 +549,23 @@ export interface IoTFleetWise {
502549
cb: (err: any, data?: DeleteSignalCatalogCommandOutput) => void
503550
): void;
504551

552+
/**
553+
* @see {@link DeleteStateTemplateCommand}
554+
*/
555+
deleteStateTemplate(
556+
args: DeleteStateTemplateCommandInput,
557+
options?: __HttpHandlerOptions
558+
): Promise<DeleteStateTemplateCommandOutput>;
559+
deleteStateTemplate(
560+
args: DeleteStateTemplateCommandInput,
561+
cb: (err: any, data?: DeleteStateTemplateCommandOutput) => void
562+
): void;
563+
deleteStateTemplate(
564+
args: DeleteStateTemplateCommandInput,
565+
options: __HttpHandlerOptions,
566+
cb: (err: any, data?: DeleteStateTemplateCommandOutput) => void
567+
): void;
568+
505569
/**
506570
* @see {@link DeleteVehicleCommand}
507571
*/
@@ -657,6 +721,23 @@ export interface IoTFleetWise {
657721
cb: (err: any, data?: GetSignalCatalogCommandOutput) => void
658722
): void;
659723

724+
/**
725+
* @see {@link GetStateTemplateCommand}
726+
*/
727+
getStateTemplate(
728+
args: GetStateTemplateCommandInput,
729+
options?: __HttpHandlerOptions
730+
): Promise<GetStateTemplateCommandOutput>;
731+
getStateTemplate(
732+
args: GetStateTemplateCommandInput,
733+
cb: (err: any, data?: GetStateTemplateCommandOutput) => void
734+
): void;
735+
getStateTemplate(
736+
args: GetStateTemplateCommandInput,
737+
options: __HttpHandlerOptions,
738+
cb: (err: any, data?: GetStateTemplateCommandOutput) => void
739+
): void;
740+
660741
/**
661742
* @see {@link GetVehicleCommand}
662743
*/
@@ -882,6 +963,24 @@ export interface IoTFleetWise {
882963
cb: (err: any, data?: ListSignalCatalogsCommandOutput) => void
883964
): void;
884965

966+
/**
967+
* @see {@link ListStateTemplatesCommand}
968+
*/
969+
listStateTemplates(): Promise<ListStateTemplatesCommandOutput>;
970+
listStateTemplates(
971+
args: ListStateTemplatesCommandInput,
972+
options?: __HttpHandlerOptions
973+
): Promise<ListStateTemplatesCommandOutput>;
974+
listStateTemplates(
975+
args: ListStateTemplatesCommandInput,
976+
cb: (err: any, data?: ListStateTemplatesCommandOutput) => void
977+
): void;
978+
listStateTemplates(
979+
args: ListStateTemplatesCommandInput,
980+
options: __HttpHandlerOptions,
981+
cb: (err: any, data?: ListStateTemplatesCommandOutput) => void
982+
): void;
983+
885984
/**
886985
* @see {@link ListTagsForResourceCommand}
887986
*/
@@ -1075,6 +1174,23 @@ export interface IoTFleetWise {
10751174
cb: (err: any, data?: UpdateSignalCatalogCommandOutput) => void
10761175
): void;
10771176

1177+
/**
1178+
* @see {@link UpdateStateTemplateCommand}
1179+
*/
1180+
updateStateTemplate(
1181+
args: UpdateStateTemplateCommandInput,
1182+
options?: __HttpHandlerOptions
1183+
): Promise<UpdateStateTemplateCommandOutput>;
1184+
updateStateTemplate(
1185+
args: UpdateStateTemplateCommandInput,
1186+
cb: (err: any, data?: UpdateStateTemplateCommandOutput) => void
1187+
): void;
1188+
updateStateTemplate(
1189+
args: UpdateStateTemplateCommandInput,
1190+
options: __HttpHandlerOptions,
1191+
cb: (err: any, data?: UpdateStateTemplateCommandOutput) => void
1192+
): void;
1193+
10781194
/**
10791195
* @see {@link UpdateVehicleCommand}
10801196
*/
@@ -1095,6 +1211,9 @@ export interface IoTFleetWise {
10951211
* </p>
10961212
* <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
10971213
* <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
1214+
* <important>
1215+
* <p>Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">Amazon Web Services Region and feature availability</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
1216+
* </important>
10981217
* @public
10991218
*/
11001219
export class IoTFleetWise extends IoTFleetWiseClient implements IoTFleetWise {}

0 commit comments

Comments
 (0)