You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: scenarios/basics/fleetwise/SPECIFICATION.md
+88-84Lines changed: 88 additions & 84 deletions
Original file line number
Diff line number
Diff line change
@@ -11,65 +11,58 @@ AWS Fleetwise and an AWS SDK.
11
11
This Basics scenario does not require any additional AWS resources.
12
12
13
13
## Hello AWS Fleetwise
14
-
This program is intended for users not familiar with the AWS IoT Fleetwise Service to easily get up and running. The program uses a `listSignalCatalogsPaginator` to demonstrate how you can read through catalog information.
14
+
This program is intended for users not familiar with the AWS IoT Fleetwise Service to easily get up and running. The program uses a `listSignalCatalogsPaginator` to demonstrate how you can read through catalog information. If there are no catalogs, print out a message to inform the user.
15
15
16
16
## Basics Scenario Program Flow
17
17
The AWS IoT Fleetwise Basics scenario executes the following operations.
18
18
19
19
1.**Create an AWS FleetWise collection**:
20
-
- Description: This step creates an AWS Fleetwise collection by invoking the `createSignalCatalog` method.
20
+
- Description: Creates an AWS Fleetwise collection by invoking `createSignalCatalog`.
21
21
- Exception Handling: Check to see if a `ValidationException` is thrown.
22
22
If it is thrown, if so, display the message and end the program.
23
23
24
24
2.**Create an IoT Fleetwise fleet**:
25
-
- Description: This operation creates an AWS Fleetwise fleet.
26
-
- The method `createFleet` is called.
27
-
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown.
25
+
- Description: Creates an AWS Fleetwise fleet by invoking `createFleet`.
26
+
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If it is thrown, if so, display the message and end the program.
28
27
29
28
3.**Create a model manifest**:
30
-
- Description: To create a model manifest, the method`listSignalCatalogNodes` is called to retrieve a list of nodes. This node list is passed to `createModelManifest()`.
31
-
- Exception Handling: Check to see if an `CompletionException` is thrown. If so, display the message and end the program.
29
+
- Description: Creates a model manifest by invoking`listSignalCatalogNodes` to retrieve a list of nodes. This node list is passed to `createModelManifest()`.
30
+
- Exception Handling: Check to see if an `InvalidSignalsException` is thrown. If so, display the message and end the program.
32
31
33
32
4.**Create a decoder manifest**:
34
-
- Description: This operation creates a decoder manifest.
35
-
- This step uses the method `createDecoderManifest`.
36
-
- Exception Handling: Check to see if a `CompletionException` is thrown. If so, display the message and end the program.
33
+
- Description: Creates a decoder manifest by invoking `createDecoderManifest`.
34
+
- Exception Handling: Check to see if a `DecoderManifestValidationException` is thrown. If so, display the message and end the program.
37
35
38
36
5.**Check the status of the model manifest**:
39
-
- Description: This operation checks the status of the model manifest.
40
-
- This step uses the `updateModelManifest`and `getModelManifest` methods.
41
-
- Exception Handling: Check to see if a `CompletionException` is thrown. If so, display the message and end the program.
37
+
- Description: Checks the status of the model manifest by invoking `updateModelManifest`and `getModelManifest`.
38
+
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
42
39
43
40
6.**Check the status of the decoder**:
44
-
- Description: This operation creates an IoT Thing which is required to create a vehicle.
45
-
- This step uses the `createThing` method.
46
-
- Exception Handling: Check to see if a `RuntimeException` is thrown. If so, display the message and end the program.
41
+
- Description: Checks the status of the decoder manifest by invoking `updateDecoderManifest`and `getDecoderManifest`.
42
+
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
47
43
48
44
49
45
7.**Create an IoT Thing**:
50
-
- Description: This operation describes the portal and returns a URL for the portal.
51
-
- The method `describePortal` is called and returns the URL.
46
+
- Description: Creates an IoT Thing which is required to create a vehicle by invoking `createThing`.
52
47
- Exception Handling: Check to see if a `ResourceAlreadyExistsException` is thrown. If so, display the message and end the program.
53
48
54
49
8.**Create a vehicle**:
55
-
- Description: This operation creates a vehicle.
56
-
- The method `createVehicle` is called.
50
+
- Description: Creates a vehicle by invoking `createVehicle`.
57
51
- Exception Handling: Check to see if an `ResourceNotFoundException` is thrown. If so, display the message and end the program.
58
52
59
53
9.**Display vehicle details**:
60
-
- Description: This operation describes the vehicle.
61
-
- The method `getVehicle` is called.
62
-
- Exception Handling: Check to see if a `???` is thrown. If so, display the message and end the program.
54
+
- Description: Describes the vehicle by invoking `getVehicle`.
55
+
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
63
56
64
57
10.**Delete the AWS IoT Fleetwise Assets**:
65
58
- The `delete` methods are called to clean up the resources.
66
59
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program."
67
60
68
61
### Program execution
69
-
The following shows the output of the AWS IoT Fleetwise Basics scenario in the console.
62
+
The following shows the output of the AWS IoT Fleetwise Basics scenario.
70
63
71
64
```
72
-
AWS IoT FleetWise is a managed service that simplifies the
65
+
WS IoT FleetWise is a managed service that simplifies the
73
66
process of collecting, organizing, and transmitting vehicle
74
67
data to the cloud in near real-time. Designed for automakers
75
68
and fleet operators, it allows you to define vehicle models,
0 commit comments