Skip to content

Commit 5f5c957

Browse files
committed
updated spec
1 parent b611683 commit 5f5c957

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

basics_scenarios/sitewise_scenario/SPECIFICATION.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,52 +14,52 @@ This program is intended for users not familiar with the AWS IoT SiteWise Servic
1414
The AWS IoT SiteWise Basics scenario executes the following operations.
1515

1616
1. **Create an AWS SiteWise Asset Model**:
17-
- Description: This operation creates an AWS SiteWise Asset Model. Invoke the `createAssetModel` method.
18-
- Exception Handling: Check to see if a `ResourceAlreadyExistsException` is thrown. If it is thrown, get the asset model id and move on.
17+
- Description: This operation creates an AWS SiteWise Asset Model. Invoke the `createAssetModel` method.
18+
- Exception Handling: Check to see if a `ResourceAlreadyExistsException` is thrown. If it is thrown, get the asset model ID and move on.
1919

2020
2. **Create an AWS IoT SiteWise Asset**:
2121
- Description: This operation creates an AWS SiteWise asset.
22-
- The method `createAsset` is called to obtain the asset id.
23-
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end program.
22+
- The method `createAsset` is called to obtain the asset ID.
23+
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
2424

2525
3. **Retrieve the property ID values**:
2626
- Description: To send data to an asset, we need to get the property ID values for the Temperature and Humidity properties.
27-
- The method `listAssetModels()` is called to retrieve asset id values.
28-
- Exception Handling: Check to see if a `IoTSiteWiseException` is thrown. There are not many other useful exceptions for this specific call. If so, display the message and end the program.
27+
- The method `listAssetModels()` is called to retrieve the asset ID values.
28+
- Exception Handling: Check to see if an `IoTSiteWiseException` is thrown. There are not many other useful exceptions for this specific call. If so, display the message and end the program.
2929

3030
4. **Send data to an AWS IoT SiteWise Asset**:
3131
- Description: This operation sends data to an IoT SiteWise Asset.
3232
- This step uses the method `batchPutAssetPropertyValue()`.
33-
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end program.
33+
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
3434

3535
5. **Retrieve the value of the IoT SiteWise Asset property**:
3636
- Description: This operation gets data from the asset.
3737
- This step uses the method `getAssetPropertyValue()`.
38-
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end program.
38+
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
3939

4040
6. **Create an IoT SiteWise Portal**:
41-
- Description: This operation is creates a Sitewise portal.
41+
- Description: This operation creates an IoT SiteWise portal.
4242
- The method `createPortal` is called.
43-
- Exception Handling: Check to see if a `IoTSiteWiseException` is thrown.
43+
- Exception Handling: Check to see if an `IoTSiteWiseException` is thrown.
4444

4545
7. **Describe the Portal**:
46-
- Description: This operation descrines the portal and returns an URL for the portal.
47-
- The method `describePortal()` is called and retutns URL.
48-
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end program.
46+
- Description: This operation describes the portal and returns a URL for the portal.
47+
- The method `describePortal()` is called and returns the URL.
48+
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
4949

5050
8. **Create an IoTSitewise Gateway**:
51-
- Description: This operation creates a Sitewise Gateway.
52-
- The method `createGateway)` is called.
53-
- Exception Handling: Check to see if a `IoTSiteWiseException` is thrown.
51+
- Description: This operation creates an IoT SiteWise Gateway.
52+
- The method `createGateway` is called.
53+
- Exception Handling: Check to see if an `IoTSiteWiseException` is thrown.
5454

55-
9. **Describe the Sitewise Gateway**:
55+
9. **Describe the IoT SiteWise Gateway**:
5656
- Description: This operation describes the Gateway.
57-
- The method `describeGateway()` is called."
58-
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end program.
57+
- The method `describeGateway()` is called.
58+
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
5959

60-
10. **Delete the AWS IoT SiteWise Assets**
61-
- The `delete()` methods ares called to clean up the resources.
62-
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end program.
60+
10. **Delete the AWS IoT SiteWise Assets**:
61+
- The `delete()` methods are called to clean up the resources.
62+
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program."
6363

6464
### Program execution
6565
The following shows the output of the AWS IoT SiteWise Basics scenario in the console.

0 commit comments

Comments
 (0)