feat(client-iotfleetwise): AWS IoT FleetWise now includes campaign pa…

…rameters 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.
aws · Nov 21, 2024 · 5d2c0b1 · 5d2c0b1
1 parent b203a9c
commit 5d2c0b1
Show file tree

Hide file tree

Showing 42 changed files with 4,270 additions and 330 deletions.
diff --git a/clients/client-iotfleetwise/README.md b/clients/client-iotfleetwise/README.md
@@ -13,6 +13,9 @@ define data collection rules to transfer only high-value data to the cloud.
 </p>
 <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
 <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
+<important>
+<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>
+</important>
 
 ## Installing
 
@@ -272,6 +275,14 @@ CreateSignalCatalog
 
 [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/)
 
+</details>
+<details>
+<summary>
+CreateStateTemplate
+</summary>
+
+[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/)
+
 </details>
 <details>
 <summary>
@@ -320,6 +331,14 @@ DeleteSignalCatalog
 
 [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/)
 
+</details>
+<details>
+<summary>
+DeleteStateTemplate
+</summary>
+
+[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/)
+
 </details>
 <details>
 <summary>
@@ -400,6 +419,14 @@ GetSignalCatalog
 
 [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/)
 
+</details>
+<details>
+<summary>
+GetStateTemplate
+</summary>
+
+[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/)
+
 </details>
 <details>
 <summary>
@@ -512,6 +539,14 @@ ListSignalCatalogs
 
 [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/)
 
+</details>
+<details>
+<summary>
+ListStateTemplates
+</summary>
+
+[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/)
+
 </details>
 <details>
 <summary>
@@ -616,6 +651,14 @@ UpdateSignalCatalog
 
 [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/)
 
+</details>
+<details>
+<summary>
+UpdateStateTemplate
+</summary>
+
+[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/)
+
 </details>
 <details>
 <summary>

diff --git a/clients/client-iotfleetwise/src/IoTFleetWise.ts b/clients/client-iotfleetwise/src/IoTFleetWise.ts
@@ -38,6 +38,11 @@ import {
   CreateSignalCatalogCommandInput,
   CreateSignalCatalogCommandOutput,
 } from "./commands/CreateSignalCatalogCommand";
+import {
+  CreateStateTemplateCommand,
+  CreateStateTemplateCommandInput,
+  CreateStateTemplateCommandOutput,
+} from "./commands/CreateStateTemplateCommand";
 import {
   CreateVehicleCommand,
   CreateVehicleCommandInput,
@@ -64,6 +69,11 @@ import {
   DeleteSignalCatalogCommandInput,
   DeleteSignalCatalogCommandOutput,
 } from "./commands/DeleteSignalCatalogCommand";
+import {
+  DeleteStateTemplateCommand,
+  DeleteStateTemplateCommandInput,
+  DeleteStateTemplateCommandOutput,
+} from "./commands/DeleteStateTemplateCommand";
 import {
   DeleteVehicleCommand,
   DeleteVehicleCommandInput,
@@ -106,6 +116,11 @@ import {
   GetSignalCatalogCommandInput,
   GetSignalCatalogCommandOutput,
 } from "./commands/GetSignalCatalogCommand";
+import {
+  GetStateTemplateCommand,
+  GetStateTemplateCommandInput,
+  GetStateTemplateCommandOutput,
+} from "./commands/GetStateTemplateCommand";
 import { GetVehicleCommand, GetVehicleCommandInput, GetVehicleCommandOutput } from "./commands/GetVehicleCommand";
 import {
   GetVehicleStatusCommand,
@@ -168,6 +183,11 @@ import {
   ListSignalCatalogsCommandInput,
   ListSignalCatalogsCommandOutput,
 } from "./commands/ListSignalCatalogsCommand";
+import {
+  ListStateTemplatesCommand,
+  ListStateTemplatesCommandInput,
+  ListStateTemplatesCommandOutput,
+} from "./commands/ListStateTemplatesCommand";
 import {
   ListTagsForResourceCommand,
   ListTagsForResourceCommandInput,
@@ -225,6 +245,11 @@ import {
   UpdateSignalCatalogCommandInput,
   UpdateSignalCatalogCommandOutput,
 } from "./commands/UpdateSignalCatalogCommand";
+import {
+  UpdateStateTemplateCommand,
+  UpdateStateTemplateCommandInput,
+  UpdateStateTemplateCommandOutput,
+} from "./commands/UpdateStateTemplateCommand";
 import {
   UpdateVehicleCommand,
   UpdateVehicleCommandInput,
@@ -241,12 +266,14 @@ const commands = {
   CreateFleetCommand,
   CreateModelManifestCommand,
   CreateSignalCatalogCommand,
+  CreateStateTemplateCommand,
   CreateVehicleCommand,
   DeleteCampaignCommand,
   DeleteDecoderManifestCommand,
   DeleteFleetCommand,
   DeleteModelManifestCommand,
   DeleteSignalCatalogCommand,
+  DeleteStateTemplateCommand,
   DeleteVehicleCommand,
   DisassociateVehicleFleetCommand,
   GetCampaignCommand,
@@ -257,6 +284,7 @@ const commands = {
   GetModelManifestCommand,
   GetRegisterAccountStatusCommand,
   GetSignalCatalogCommand,
+  GetStateTemplateCommand,
   GetVehicleCommand,
   GetVehicleStatusCommand,
   ImportDecoderManifestCommand,
@@ -271,6 +299,7 @@ const commands = {
   ListModelManifestsCommand,
   ListSignalCatalogNodesCommand,
   ListSignalCatalogsCommand,
+  ListStateTemplatesCommand,
   ListTagsForResourceCommand,
   ListVehiclesCommand,
   ListVehiclesInFleetCommand,
@@ -284,6 +313,7 @@ const commands = {
   UpdateFleetCommand,
   UpdateModelManifestCommand,
   UpdateSignalCatalogCommand,
+  UpdateStateTemplateCommand,
   UpdateVehicleCommand,
 };
 
@@ -415,6 +445,23 @@ export interface IoTFleetWise {
     cb: (err: any, data?: CreateSignalCatalogCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link CreateStateTemplateCommand}
+   */
+  createStateTemplate(
+    args: CreateStateTemplateCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<CreateStateTemplateCommandOutput>;
+  createStateTemplate(
+    args: CreateStateTemplateCommandInput,
+    cb: (err: any, data?: CreateStateTemplateCommandOutput) => void
+  ): void;
+  createStateTemplate(
+    args: CreateStateTemplateCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: CreateStateTemplateCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link CreateVehicleCommand}
    */
@@ -502,6 +549,23 @@ export interface IoTFleetWise {
     cb: (err: any, data?: DeleteSignalCatalogCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link DeleteStateTemplateCommand}
+   */
+  deleteStateTemplate(
+    args: DeleteStateTemplateCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<DeleteStateTemplateCommandOutput>;
+  deleteStateTemplate(
+    args: DeleteStateTemplateCommandInput,
+    cb: (err: any, data?: DeleteStateTemplateCommandOutput) => void
+  ): void;
+  deleteStateTemplate(
+    args: DeleteStateTemplateCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: DeleteStateTemplateCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link DeleteVehicleCommand}
    */
@@ -657,6 +721,23 @@ export interface IoTFleetWise {
     cb: (err: any, data?: GetSignalCatalogCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link GetStateTemplateCommand}
+   */
+  getStateTemplate(
+    args: GetStateTemplateCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<GetStateTemplateCommandOutput>;
+  getStateTemplate(
+    args: GetStateTemplateCommandInput,
+    cb: (err: any, data?: GetStateTemplateCommandOutput) => void
+  ): void;
+  getStateTemplate(
+    args: GetStateTemplateCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: GetStateTemplateCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link GetVehicleCommand}
    */
@@ -882,6 +963,24 @@ export interface IoTFleetWise {
     cb: (err: any, data?: ListSignalCatalogsCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link ListStateTemplatesCommand}
+   */
+  listStateTemplates(): Promise<ListStateTemplatesCommandOutput>;
+  listStateTemplates(
+    args: ListStateTemplatesCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<ListStateTemplatesCommandOutput>;
+  listStateTemplates(
+    args: ListStateTemplatesCommandInput,
+    cb: (err: any, data?: ListStateTemplatesCommandOutput) => void
+  ): void;
+  listStateTemplates(
+    args: ListStateTemplatesCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: ListStateTemplatesCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link ListTagsForResourceCommand}
    */
@@ -1075,6 +1174,23 @@ export interface IoTFleetWise {
     cb: (err: any, data?: UpdateSignalCatalogCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link UpdateStateTemplateCommand}
+   */
+  updateStateTemplate(
+    args: UpdateStateTemplateCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<UpdateStateTemplateCommandOutput>;
+  updateStateTemplate(
+    args: UpdateStateTemplateCommandInput,
+    cb: (err: any, data?: UpdateStateTemplateCommandOutput) => void
+  ): void;
+  updateStateTemplate(
+    args: UpdateStateTemplateCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: UpdateStateTemplateCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link UpdateVehicleCommand}
    */
@@ -1095,6 +1211,9 @@ export interface IoTFleetWise {
  *             </p>
  *          <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
  *                 <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
+ *          <important>
+ *             <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>
+ *          </important>
  * @public
  */
 export class IoTFleetWise extends IoTFleetWiseClient implements IoTFleetWise {}