Skip to content

Commit 17b50b4

Browse files
author
awstools
committed
docs(client-iotfleetwise): Documentation update for AWS IoT FleetWise
1 parent 8c9f644 commit 17b50b4

File tree

5 files changed

+5
-28
lines changed

5 files changed

+5
-28
lines changed

‎clients/client-iotfleetwise/README.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,6 @@
99

1010
AWS SDK for JavaScript IoTFleetWise Client for Node.js, Browser and React Native.
1111

12-
<note>
13-
<p>Amazon Web Services IoT FleetWise is in preview release and is subject to change. We recommend that you
14-
use the service only with test data, and not in production environments.</p>
15-
<p>While Amazon Web Services IoT FleetWise is in preview, you must download the preview Amazon Web Services SDK and CLI
16-
to use the API operations for this service. These API operations aren't
17-
available in the public Amazon Web Services SDK or CLI. For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/preview-sdk-cli.html">Preview Amazon Web Services SDK
18-
and CLI</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
19-
</note>
2012
<p>Amazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer
2113
vehicle data to the Amazon Web Services cloud at scale. With Amazon Web Services IoT FleetWise, you can standardize all of
2214
your vehicle data models, independent of the in-vehicle communication architecture, and

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -222,15 +222,7 @@ import {
222222
import { IoTFleetWiseClient } from "./IoTFleetWiseClient";
223223

224224
/**
225-
* <note>
226-
* <p>Amazon Web Services IoT FleetWise is in preview release and is subject to change. We recommend that you
227-
* use the service only with test data, and not in production environments.</p>
228-
* <p>While Amazon Web Services IoT FleetWise is in preview, you must download the preview Amazon Web Services SDK and CLI
229-
* to use the API operations for this service. These API operations aren't
230-
* available in the public Amazon Web Services SDK or CLI. For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/preview-sdk-cli.html">Preview Amazon Web Services SDK
231-
* and CLI</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
232-
* </note>
233-
* <p>Amazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer
225+
* <p>Amazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer
234226
* vehicle data to the Amazon Web Services cloud at scale. With Amazon Web Services IoT FleetWise, you can standardize all of
235227
* your vehicle data models, independent of the in-vehicle communication architecture, and
236228
* define data collection rules to transfer only high-value data to the cloud.

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -429,15 +429,7 @@ type IoTFleetWiseClientResolvedConfigType = __SmithyResolvedConfiguration<__Http
429429
export interface IoTFleetWiseClientResolvedConfig extends IoTFleetWiseClientResolvedConfigType {}
430430

431431
/**
432-
* <note>
433-
* <p>Amazon Web Services IoT FleetWise is in preview release and is subject to change. We recommend that you
434-
* use the service only with test data, and not in production environments.</p>
435-
* <p>While Amazon Web Services IoT FleetWise is in preview, you must download the preview Amazon Web Services SDK and CLI
436-
* to use the API operations for this service. These API operations aren't
437-
* available in the public Amazon Web Services SDK or CLI. For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/preview-sdk-cli.html">Preview Amazon Web Services SDK
438-
* and CLI</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
439-
* </note>
440-
* <p>Amazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer
432+
* <p>Amazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer
441433
* vehicle data to the Amazon Web Services cloud at scale. With Amazon Web Services IoT FleetWise, you can standardize all of
442434
* your vehicle data models, independent of the in-vehicle communication architecture, and
443435
* define data collection rules to transfer only high-value data to the cloud.

‎clients/client-iotfleetwise/src/models/models_0.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -853,6 +853,7 @@ export interface CreateCampaignRequest {
853853

854854
/**
855855
* <p> (Optional) A list of vehicle attributes to associate with a campaign. </p>
856+
* <p>Enrich the data with specified vehicle attributes. For example, add <code>make</code> and <code>model</code> to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against <code>make</code> and <code>model</code>.</p>
856857
* <p>Default: An empty array</p>
857858
*/
858859
dataExtraDimensions?: string[];

‎codegen/sdk-codegen/aws-models/iotfleetwise.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -857,7 +857,7 @@
857857
"dataExtraDimensions": {
858858
"target": "com.amazonaws.iotfleetwise#DataExtraDimensionNodePathList",
859859
"traits": {
860-
"smithy.api#documentation": "<p> (Optional) A list of vehicle attributes to associate with a campaign. </p>\n <p>Default: An empty array</p>"
860+
"smithy.api#documentation": "<p> (Optional) A list of vehicle attributes to associate with a campaign. </p>\n <p>Enrich the data with specified vehicle attributes. For example, add <code>make</code> and <code>model</code> to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against <code>make</code> and <code>model</code>.</p>\n <p>Default: An empty array</p>"
861861
}
862862
},
863863
"tags": {
@@ -3497,7 +3497,7 @@
34973497
},
34983498
"aws.protocols#awsJson1_0": {},
34993499
"smithy.api#cors": {},
3500-
"smithy.api#documentation": "<note>\n <p>Amazon Web Services IoT FleetWise is in preview release and is subject to change. We recommend that you\n use the service only with test data, and not in production environments.</p>\n <p>While Amazon Web Services IoT FleetWise is in preview, you must download the preview Amazon Web Services SDK and CLI\n to use the API operations for this service. These API operations aren't\n available in the public Amazon Web Services SDK or CLI. For more information, see <a href=\"https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/preview-sdk-cli.html\">Preview Amazon Web Services SDK\n and CLI</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>\n </note>\n <p>Amazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer\n vehicle data to the Amazon Web Services cloud at scale. With Amazon Web Services IoT FleetWise, you can standardize all of\n your vehicle data models, independent of the in-vehicle communication architecture, and\n define data collection rules to transfer only high-value data to the cloud.\n </p>\n <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\n <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>",
3500+
"smithy.api#documentation": "<p>Amazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer\n vehicle data to the Amazon Web Services cloud at scale. With Amazon Web Services IoT FleetWise, you can standardize all of\n your vehicle data models, independent of the in-vehicle communication architecture, and\n define data collection rules to transfer only high-value data to the cloud.\n </p>\n <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\n <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>",
35013501
"smithy.api#title": "AWS IoT FleetWise"
35023502
}
35033503
},

0 commit comments

Comments
 (0)