Skip to content

Commit db74d14

Browse files
author
awstools
committed
feat(client-iotfleetwise): AWS IoT FleetWise introduces new APIs for vision system data, such as data collected from cameras, radars, and lidars. You can now model and decode complex data types.
1 parent 436c9c6 commit db74d14

40 files changed

+1979
-435
lines changed

‎clients/client-iotfleetwise/src/IoTFleetWise.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1084,7 +1084,7 @@ export interface IoTFleetWise {
10841084
* your vehicle data models, independent of the in-vehicle communication architecture, and
10851085
* define data collection rules to transfer only high-value data to the cloud.
10861086
* </p>
1087-
* <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
1087+
* <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
10881088
* <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
10891089
*/
10901090
export class IoTFleetWise extends IoTFleetWiseClient implements IoTFleetWise {}

‎clients/client-iotfleetwise/src/IoTFleetWiseClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ export interface IoTFleetWiseClientResolvedConfig extends IoTFleetWiseClientReso
476476
* your vehicle data models, independent of the in-vehicle communication architecture, and
477477
* define data collection rules to transfer only high-value data to the cloud.
478478
* </p>
479-
* <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
479+
* <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
480480
* <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
481481
*/
482482
export class IoTFleetWiseClient extends __Client<

‎clients/client-iotfleetwise/src/commands/AssociateVehicleFleetCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,9 @@ export interface AssociateVehicleFleetCommandOutput extends AssociateVehicleFlee
6666
* @throws {@link InternalServerException} (server fault)
6767
* <p>The request couldn't be completed because the server temporarily failed.</p>
6868
*
69+
* @throws {@link LimitExceededException} (client fault)
70+
* <p>A service quota was exceeded. </p>
71+
*
6972
* @throws {@link ResourceNotFoundException} (client fault)
7073
* <p>The resource wasn't found.</p>
7174
*

‎clients/client-iotfleetwise/src/commands/BatchCreateVehicleCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@ export interface BatchCreateVehicleCommandOutput extends BatchCreateVehicleRespo
3838
/**
3939
* @public
4040
* <p> Creates a group, or batch, of vehicles. </p>
41-
* <note>
41+
* <note>
4242
* <p> You must specify a decoder manifest and a vehicle model (model manifest) for each
4343
* vehicle. </p>
44-
* </note>
45-
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/create-vehicles-cli.html">Create multiple
44+
* </note>
45+
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/create-vehicles-cli.html">Create multiple
4646
* vehicles (AWS CLI)</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>. </p>
4747
* @example
4848
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-iotfleetwise/src/commands/BatchUpdateVehicleCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@ export interface BatchUpdateVehicleCommandOutput extends BatchUpdateVehicleRespo
3838
/**
3939
* @public
4040
* <p> Updates a group, or batch, of vehicles.</p>
41-
* <note>
41+
* <note>
4242
* <p> You must specify a decoder manifest and a vehicle model (model manifest) for each
4343
* vehicle. </p>
44-
* </note>
45-
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/update-vehicles-cli.html">Update multiple
44+
* </note>
45+
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/update-vehicles-cli.html">Update multiple
4646
* vehicles (AWS CLI)</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>. </p>
4747
* @example
4848
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-iotfleetwise/src/commands/CreateCampaignCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
4141
* running in vehicles uses campaigns to decide how to collect and transfer data to the
4242
* cloud. You create campaigns in the cloud. After you or your team approve campaigns,
4343
* Amazon Web Services IoT FleetWise automatically deploys them to vehicles. </p>
44-
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/campaigns.html">Collect and transfer data
44+
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/campaigns.html">Collect and transfer data
4545
* with campaigns</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
4646
* @example
4747
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-iotfleetwise/src/commands/CreateDecoderManifestCommand.ts

Lines changed: 55 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,18 +39,18 @@ export interface CreateDecoderManifestCommandOutput extends CreateDecoderManifes
3939
* @public
4040
* <p>Creates the decoder manifest associated with a model manifest. To create a decoder
4141
* manifest, the following must be true:</p>
42-
* <ul>
42+
* <ul>
4343
* <li>
44-
* <p>Every signal decoder has a unique name.</p>
44+
* <p>Every signal decoder has a unique name.</p>
4545
* </li>
4646
* <li>
47-
* <p>Each signal decoder is associated with a network interface.</p>
47+
* <p>Each signal decoder is associated with a network interface.</p>
4848
* </li>
4949
* <li>
50-
* <p>Each network interface has a unique ID.</p>
50+
* <p>Each network interface has a unique ID.</p>
5151
* </li>
5252
* <li>
53-
* <p>The signal decoders are specified in the model manifest.</p>
53+
* <p>The signal decoders are specified in the model manifest.</p>
5454
* </li>
5555
* </ul>
5656
* @example
@@ -89,6 +89,52 @@ export interface CreateDecoderManifestCommandOutput extends CreateDecoderManifes
8989
* bitRightShift: Number("int"),
9090
* bitMaskLength: Number("int"),
9191
* },
92+
* messageSignal: { // MessageSignal
93+
* topicName: "STRING_VALUE", // required
94+
* structuredMessage: { // StructuredMessage Union: only one key present
95+
* primitiveMessageDefinition: { // PrimitiveMessageDefinition Union: only one key present
96+
* ros2PrimitiveMessageDefinition: { // ROS2PrimitiveMessageDefinition
97+
* primitiveType: "STRING_VALUE", // required
98+
* offset: Number("double"),
99+
* scaling: Number("double"),
100+
* upperBound: Number("long"),
101+
* },
102+
* },
103+
* structuredMessageListDefinition: { // StructuredMessageListDefinition
104+
* name: "STRING_VALUE", // required
105+
* memberType: {// Union: only one key present
106+
* primitiveMessageDefinition: {// Union: only one key present
107+
* ros2PrimitiveMessageDefinition: {
108+
* primitiveType: "STRING_VALUE", // required
109+
* offset: Number("double"),
110+
* scaling: Number("double"),
111+
* upperBound: Number("long"),
112+
* },
113+
* },
114+
* structuredMessageListDefinition: {
115+
* name: "STRING_VALUE", // required
116+
* memberType: "<StructuredMessage>", // required
117+
* listType: "STRING_VALUE", // required
118+
* capacity: Number("int"),
119+
* },
120+
* structuredMessageDefinition: [ // StructuredMessageDefinition
121+
* { // StructuredMessageFieldNameAndDataTypePair
122+
* fieldName: "STRING_VALUE", // required
123+
* dataType: "<StructuredMessage>", // required
124+
* },
125+
* ],
126+
* },
127+
* listType: "STRING_VALUE", // required
128+
* capacity: Number("int"),
129+
* },
130+
* structuredMessageDefinition: [
131+
* {
132+
* fieldName: "STRING_VALUE", // required
133+
* dataType: "<StructuredMessage>", // required
134+
* },
135+
* ],
136+
* },
137+
* },
92138
* },
93139
* ],
94140
* networkInterfaces: [ // NetworkInterfaces
@@ -109,6 +155,10 @@ export interface CreateDecoderManifestCommandOutput extends CreateDecoderManifes
109155
* useExtendedIds: true || false,
110156
* hasTransmissionEcu: true || false,
111157
* },
158+
* vehicleMiddleware: { // VehicleMiddleware
159+
* name: "STRING_VALUE", // required
160+
* protocolName: "STRING_VALUE", // required
161+
* },
112162
* },
113163
* ],
114164
* tags: [ // TagList

‎clients/client-iotfleetwise/src/commands/CreateFleetCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ export interface CreateFleetCommandOutput extends CreateFleetResponse, __Metadat
3939
* @public
4040
* <p> Creates a fleet that represents a group of vehicles.
4141
* </p>
42-
* <note>
42+
* <note>
4343
* <p>You must create both a signal catalog and vehicles before you can create a fleet.
4444
* </p>
45-
* </note>
46-
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleets.html">Fleets</a> in the
45+
* </note>
46+
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleets.html">Fleets</a> in the
4747
* <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
4848
* @example
4949
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-iotfleetwise/src/commands/CreateModelManifestCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ export interface CreateModelManifestCommandOutput extends CreateModelManifestRes
3939
* @public
4040
* <p> Creates a vehicle model (model manifest) that specifies signals (attributes,
4141
* branches, sensors, and actuators). </p>
42-
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/vehicle-models.html">Vehicle models</a>
42+
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/vehicle-models.html">Vehicle models</a>
4343
* in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
4444
* @example
4545
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-iotfleetwise/src/commands/CreateSignalCatalogCommand.ts

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ export interface CreateSignalCatalogCommandOutput extends CreateSignalCatalogRes
6868
* max: Number("double"),
6969
* deprecationMessage: "STRING_VALUE",
7070
* comment: "STRING_VALUE",
71+
* structFullyQualifiedName: "STRING_VALUE",
7172
* },
7273
* actuator: { // Actuator
7374
* fullyQualifiedName: "STRING_VALUE", // required
@@ -82,6 +83,7 @@ export interface CreateSignalCatalogCommandOutput extends CreateSignalCatalogRes
8283
* assignedValue: "STRING_VALUE",
8384
* deprecationMessage: "STRING_VALUE",
8485
* comment: "STRING_VALUE",
86+
* structFullyQualifiedName: "STRING_VALUE",
8587
* },
8688
* attribute: { // Attribute
8789
* fullyQualifiedName: "STRING_VALUE", // required
@@ -98,6 +100,21 @@ export interface CreateSignalCatalogCommandOutput extends CreateSignalCatalogRes
98100
* deprecationMessage: "STRING_VALUE",
99101
* comment: "STRING_VALUE",
100102
* },
103+
* struct: { // CustomStruct
104+
* fullyQualifiedName: "STRING_VALUE", // required
105+
* description: "STRING_VALUE",
106+
* deprecationMessage: "STRING_VALUE",
107+
* comment: "STRING_VALUE",
108+
* },
109+
* property: { // CustomProperty
110+
* fullyQualifiedName: "STRING_VALUE", // required
111+
* dataType: "STRING_VALUE", // required
112+
* dataEncoding: "STRING_VALUE",
113+
* description: "STRING_VALUE",
114+
* deprecationMessage: "STRING_VALUE",
115+
* comment: "STRING_VALUE",
116+
* structFullyQualifiedName: "STRING_VALUE",
117+
* },
101118
* },
102119
* ],
103120
* tags: [ // TagList

‎clients/client-iotfleetwise/src/commands/CreateVehicleCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ export interface CreateVehicleCommandOutput extends CreateVehicleResponse, __Met
4040
* <p> Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles
4141
* created from the same vehicle model consist of the same signals inherited from the
4242
* vehicle model.</p>
43-
* <note>
43+
* <note>
4444
* <p> If you have an existing Amazon Web Services IoT thing, you can use Amazon Web Services IoT FleetWise to create a
4545
* vehicle and collect data from your thing. </p>
46-
* </note>
47-
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/create-vehicle-cli.html">Create a vehicle
46+
* </note>
47+
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/create-vehicle-cli.html">Create a vehicle
4848
* (AWS CLI)</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
4949
* @example
5050
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-iotfleetwise/src/commands/DeleteDecoderManifestCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ export interface DeleteDecoderManifestCommandOutput extends DeleteDecoderManifes
3939
* @public
4040
* <p> Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles
4141
* associated with it. </p>
42-
* <note>
42+
* <note>
4343
* <p>If the decoder manifest is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200
4444
* response with an empty body.</p>
45-
* </note>
45+
* </note>
4646
* @example
4747
* Use a bare-bones client and the command you need to make an API call.
4848
* ```javascript

‎clients/client-iotfleetwise/src/commands/DeleteFleetCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ export interface DeleteFleetCommandOutput extends DeleteFleetResponse, __Metadat
4040
* <p> Deletes a fleet. Before you delete a fleet, all vehicles must be
4141
* 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
4242
* CLI)</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
43-
* <note>
43+
* <note>
4444
* <p>If the fleet is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response
4545
* with an empty body.</p>
46-
* </note>
46+
* </note>
4747
* @example
4848
* Use a bare-bones client and the command you need to make an API call.
4949
* ```javascript

‎clients/client-iotfleetwise/src/commands/DeleteModelManifestCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ export interface DeleteModelManifestCommandOutput extends DeleteModelManifestRes
3838
/**
3939
* @public
4040
* <p> Deletes a vehicle model (model manifest).</p>
41-
* <note>
41+
* <note>
4242
* <p>If the vehicle model is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200
4343
* response with an empty body.</p>
44-
* </note>
44+
* </note>
4545
* @example
4646
* Use a bare-bones client and the command you need to make an API call.
4747
* ```javascript

‎clients/client-iotfleetwise/src/commands/DeleteSignalCatalogCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ export interface DeleteSignalCatalogCommandOutput extends DeleteSignalCatalogRes
3838
/**
3939
* @public
4040
* <p> Deletes a signal catalog. </p>
41-
* <note>
41+
* <note>
4242
* <p>If the signal catalog is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200
4343
* response with an empty body.</p>
44-
* </note>
44+
* </note>
4545
* @example
4646
* Use a bare-bones client and the command you need to make an API call.
4747
* ```javascript

‎clients/client-iotfleetwise/src/commands/DeleteVehicleCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ export interface DeleteVehicleCommandOutput extends DeleteVehicleResponse, __Met
3838
/**
3939
* @public
4040
* <p> Deletes a vehicle and removes it from any campaigns.</p>
41-
* <note>
41+
* <note>
4242
* <p>If the vehicle is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response
4343
* with an empty body.</p>
44-
* </note>
44+
* </note>
4545
* @example
4646
* Use a bare-bones client and the command you need to make an API call.
4747
* ```javascript

‎clients/client-iotfleetwise/src/commands/DisassociateVehicleFleetCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ export interface DisassociateVehicleFleetCommandOutput extends DisassociateVehic
3939
* @public
4040
* <p>Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a
4141
* fleet doesn't delete the vehicle.</p>
42-
* <note>
42+
* <note>
4343
* <p>If the vehicle is successfully dissociated from a fleet, Amazon Web Services IoT FleetWise sends back an
4444
* HTTP 200 response with an empty body.</p>
45-
* </note>
45+
* </note>
4646
* @example
4747
* Use a bare-bones client and the command you need to make an API call.
4848
* ```javascript

‎clients/client-iotfleetwise/src/commands/GetDecoderManifestCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ export interface GetDecoderManifestCommandOutput extends GetDecoderManifestRespo
5757
* // status: "STRING_VALUE",
5858
* // creationTime: new Date("TIMESTAMP"), // required
5959
* // lastModificationTime: new Date("TIMESTAMP"), // required
60+
* // message: "STRING_VALUE",
6061
* // };
6162
*
6263
* ```

‎clients/client-iotfleetwise/src/commands/GetRegisterAccountStatusCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ export interface GetRegisterAccountStatusCommandOutput extends GetRegisterAccoun
4040
* <p> Retrieves information about the status of registering your Amazon Web Services account, IAM, and
4141
* Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services
4242
* Cloud. </p>
43-
* <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>
44-
* <note>
43+
* <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>
44+
* <note>
4545
* <p>This API operation doesn't require input parameters.</p>
46-
* </note>
46+
* </note>
4747
* @example
4848
* Use a bare-bones client and the command you need to make an API call.
4949
* ```javascript

‎clients/client-iotfleetwise/src/commands/GetSignalCatalogCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ export interface GetSignalCatalogCommandOutput extends GetSignalCatalogResponse,
5959
* // totalSensors: Number("int"),
6060
* // totalAttributes: Number("int"),
6161
* // totalActuators: Number("int"),
62+
* // totalStructs: Number("int"),
63+
* // totalProperties: Number("int"),
6264
* // },
6365
* // creationTime: new Date("TIMESTAMP"), // required
6466
* // lastModificationTime: new Date("TIMESTAMP"), // required

‎clients/client-iotfleetwise/src/commands/ListCampaignsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export interface ListCampaignsCommandOutput extends ListCampaignsResponse, __Met
3838
/**
3939
* @public
4040
* <p> Lists information about created campaigns. </p>
41-
* <note>
41+
* <note>
4242
* <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the request to return more results.</p>
4343
* </note>
4444
* @example

‎clients/client-iotfleetwise/src/commands/ListDecoderManifestNetworkInterfacesCommand.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export interface ListDecoderManifestNetworkInterfacesCommandOutput
4646
/**
4747
* @public
4848
* <p> Lists the network interfaces specified in a decoder manifest. </p>
49-
* <note>
49+
* <note>
5050
* <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the request to return more results.</p>
5151
* </note>
5252
* @example
@@ -81,6 +81,10 @@ export interface ListDecoderManifestNetworkInterfacesCommandOutput
8181
* // useExtendedIds: true || false,
8282
* // hasTransmissionEcu: true || false,
8383
* // },
84+
* // vehicleMiddleware: { // VehicleMiddleware
85+
* // name: "STRING_VALUE", // required
86+
* // protocolName: "STRING_VALUE", // required
87+
* // },
8488
* // },
8589
* // ],
8690
* // nextToken: "STRING_VALUE",

0 commit comments

Comments
 (0)