Skip to content

Commit b6f57eb

Browse files
committed
added service level readme
1 parent b8b9b3b commit b6f57eb

File tree

1 file changed

+40
-37
lines changed

1 file changed

+40
-37
lines changed

kotlin/services/iotfleetwise/README.md

+40-37
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# AWS IoT code examples for the SDK for Kotlin
1+
# AWS IoT FleetWise code examples for the SDK for Kotlin
22

33
## Overview
44

5-
Shows how to use the AWS SDK for Kotlin to work with AWS IoT.
5+
Shows how to use the AWS SDK for Kotlin to work with AWS IoT FleetWise.
66

77
<!--custom.overview.start-->
88
<!--custom.overview.end-->
99

10-
_AWS IoT provides secure, bi-directional communication for Internet-connected devices (such as sensors, actuators, embedded devices, wireless devices, and smart appliances) to connect to the AWS Cloud over MQTT, HTTPS, and LoRaWAN._
10+
_AWS IoT FleetWise provides a secure and scalable platform for collecting, storing, and analyzing data from connected vehicles and fleets._
1111

1212
## ⚠ Important
1313

@@ -31,32 +31,36 @@ For prerequisites, see the [README](../../README.md#Prerequisites) in the `kotli
3131

3232
### Get started
3333

34-
- [Hello AWS IoT](src/main/kotlin/com/example/iot/HelloIoT.kt#L6) (`listThings`)
34+
- [Hello AWS IoT FleetWise](src/main/java/com/example/fleetwise/HelloFleetwise.kt#L10) (`listSignalCatalogsPaginator`)
3535

3636

3737
### Basics
3838

3939
Code examples that show you how to perform the essential operations within a service.
4040

41-
- [Learn the basics](src/main/kotlin/com/example/iot/IotScenario.kt)
41+
- [Learn the basics](src/main/java/com/example/fleetwise/scenario/FleetwiseScenario.kt)
4242

4343

4444
### Single actions
4545

4646
Code excerpts that show you how to call individual service functions.
4747

48-
- [AttachThingPrincipal](src/main/kotlin/com/example/iot/IotScenario.kt#L476)
49-
- [CreateKeysAndCertificate](src/main/kotlin/com/example/iot/IotScenario.kt#L511)
50-
- [CreateThing](src/main/kotlin/com/example/iot/IotScenario.kt#L528)
51-
- [CreateTopicRule](src/main/kotlin/com/example/iot/IotScenario.kt#L331)
52-
- [DeleteCertificate](src/main/kotlin/com/example/iot/IotScenario.kt#L257)
53-
- [DeleteThing](src/main/kotlin/com/example/iot/IotScenario.kt#L243)
54-
- [DescribeEndpoint](src/main/kotlin/com/example/iot/IotScenario.kt#L397)
55-
- [DescribeThing](src/main/kotlin/com/example/iot/IotScenario.kt#L494)
56-
- [DetachThingPrincipal](src/main/kotlin/com/example/iot/IotScenario.kt#L277)
57-
- [ListCertificates](src/main/kotlin/com/example/iot/IotScenario.kt#L384)
58-
- [SearchIndex](src/main/kotlin/com/example/iot/IotScenario.kt#L295)
59-
- [UpdateThing](src/main/kotlin/com/example/iot/IotScenario.kt#L429)
48+
- [createDecoderManifest](src/main/java/com/example/fleetwise/scenario/FleetwiseScenario.kt#L467)
49+
- [createFleet](src/main/java/com/example/fleetwise/scenario/FleetwiseScenario.kt#L640)
50+
- [createModelManifest](src/main/java/com/example/fleetwise/scenario/FleetwiseScenario.kt#L590)
51+
- [createSignalCatalog](src/main/java/com/example/fleetwise/scenario/FleetwiseScenario.kt#L662)
52+
- [createVehicle](src/main/java/com/example/fleetwise/scenario/FleetwiseScenario.kt#L299)
53+
- [deleteDecoderManifest](src/main/java/com/example/fleetwise/scenario/FleetwiseScenario.kt#L454)
54+
- [deleteFleet](src/main/java/com/example/fleetwise/scenario/FleetwiseScenario.kt#L555)
55+
- [deleteModelManifest](src/main/java/com/example/fleetwise/scenario/FleetwiseScenario.kt#L573)
56+
- [deleteSignalCatalog](src/main/java/com/example/fleetwise/scenario/FleetwiseScenario.kt#L538)
57+
- [deleteVehicle](src/main/java/com/example/fleetwise/scenario/FleetwiseScenario.kt#L260)
58+
- [getDecoderManifest](src/main/java/com/example/fleetwise/scenario/FleetwiseScenario.kt#L343)
59+
- [getModelManifest](src/main/java/com/example/fleetwise/scenario/FleetwiseScenario.kt#L389)
60+
- [getVehicle](src/main/java/com/example/fleetwise/scenario/FleetwiseScenario.kt#L273)
61+
- [listSignalCatalogNodes](src/main/java/com/example/fleetwise/scenario/FleetwiseScenario.kt#L620)
62+
- [updateDecoderManifest](src/main/java/com/example/fleetwise/scenario/FleetwiseScenario.kt#L330)
63+
- [updateModelManifest](src/main/java/com/example/fleetwise/scenario/FleetwiseScenario.kt#L435)
6064

6165

6266
<!--custom.examples.start-->
@@ -70,33 +74,32 @@ Code excerpts that show you how to call individual service functions.
7074
<!--custom.instructions.start-->
7175
<!--custom.instructions.end-->
7276

73-
#### Hello AWS IoT
77+
#### Hello AWS IoT FleetWise
7478

75-
This example shows you how to get started using AWS IoT.
79+
This example shows you how to get started using AWS IoT FleetWise.
7680

7781

7882
#### Learn the basics
7983

8084
This example shows you how to do the following:
8185

82-
- Create an AWS IoT Thing.
83-
- Generate a device certificate.
84-
- Update an AWS IoT Thing with Attributes.
85-
- Return a unique endpoint.
86-
- List your AWS IoT certificates.
87-
- Create an AWS IoT shadow.
88-
- Write out state information.
89-
- Creates a rule.
90-
- List your rules.
91-
- Search things using the Thing name.
92-
- Delete an AWS IoT Thing.
86+
- Create a collection of standardized signals.
87+
- Create a fleet that represents a group of vehicles.
88+
- Create a model manifest.
89+
- Create a decoder manifest.
90+
- Check the status of the model manifest.
91+
- Check the status of the decoder.
92+
- Create an IoT Thing.
93+
- Create a vehicle.
94+
- Display vehicle details.
95+
- Delete the AWS IoT FleetWise Assets.
9396

94-
<!--custom.basic_prereqs.iot_Scenario.start-->
95-
<!--custom.basic_prereqs.iot_Scenario.end-->
97+
<!--custom.basic_prereqs.iotfleetwise_Scenario.start-->
98+
<!--custom.basic_prereqs.iotfleetwise_Scenario.end-->
9699

97100

98-
<!--custom.basics.iot_Scenario.start-->
99-
<!--custom.basics.iot_Scenario.end-->
101+
<!--custom.basics.iotfleetwise_Scenario.start-->
102+
<!--custom.basics.iotfleetwise_Scenario.end-->
100103

101104

102105
### Tests
@@ -114,9 +117,9 @@ in the `kotlin` folder.
114117

115118
## Additional resources
116119

117-
- [AWS IoT Developer Guide](https://docs.aws.amazon.com/iot/latest/developerguide/what-is-aws-iot.html)
118-
- [AWS IoT API Reference](https://docs.aws.amazon.com/iot/latest/apireference/Welcome.html)
119-
- [SDK for Kotlin AWS IoT reference](https://sdk.amazonaws.com/kotlin/api/latest/iot/index.html)
120+
- [AWS IoT FleetWise Developer Guide](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/what-is-fleetwise.html)
121+
- [AWS IoT FleetWise API Reference](https://docs.aws.amazon.com/iot-fleetwise/latest/APIReference/Welcome.html)
122+
- [SDK for Kotlin AWS IoT FleetWise reference](https://sdk.amazonaws.com/kotlin/api/latest/iot/index.html)
120123

121124
<!--custom.resources.start-->
122125
<!--custom.resources.end-->

0 commit comments

Comments
 (0)