Skip to content

Commit d3ee07b

Browse files
committed
updated Spec
1 parent 1896347 commit d3ee07b

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

basics_scenarios/sitewise_scenario/SPECIFICATION.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,40 @@
11
# AWS IoT SiteWise Service Scenario Specification
22

33
## Overview
4-
This SDK Basics scenario demonstrates how to interact with AWS IoT SiteWise using the AWS SDK. It demonstrates various tasks such as creating a SiteWise Asset Model, creating an asset, sending data to the asset, reading data, and so on. Finally this scenario demonstrates how to clean up resources. Its purpose is to demonstrate how to get up and running with AWS IoT SiteWise and the AWS SDK.
4+
This SDK Basics scenario demonstrates how to interact with AWS IoT SiteWise using an AWS SDK.
5+
It demonstrates various tasks such as creating a SiteWise Asset Model, creating an asset,
6+
sending data to the asset, reading data, and so on. Finally this scenario demonstrates how
7+
to clean up resources. Its purpose is to demonstrate how to get up and running with
8+
AWS IoT SiteWise and an AWS SDK.
59

610
## Resources
7-
This Basics scenario has a depedency on an IAM role that has permissions for this service. We will create this resource using a CloudFormation template so the user does not have to manually create it. You can see this functionality in the Program execution section below.
11+
This Basics scenario requires an IAM role that has permissions to work with AWS IoT
12+
SiteWise service. The scenario creates this resource using a CloudFormation template.
813

914
## Hello AWS IoT SiteWise
1015
This program is intended for users not familiar with the AWS IoT SiteWise Service to easily get up and running. The logic is to show use of
1116
`listAssetsPaginator`.
1217

13-
## Scenario Program Flow
18+
## Basics Scenario Program Flow
1419
The AWS IoT SiteWise Basics scenario executes the following operations.
1520

1621
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.
22+
- Description: This step creates an AWS SiteWise Asset Model by invoking the `createAssetModel` method.
23+
- Exception Handling: Check to see if a `ResourceAlreadyExistsException` is thrown.
24+
If it is thrown, get the asset model ID and move on.
1925

2026
2. **Create an AWS IoT SiteWise Asset**:
2127
- Description: This operation creates an AWS SiteWise asset.
2228
- 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.
29+
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so,
30+
display the message and end the program.
2431

2532
3. **Retrieve the property ID values**:
26-
- 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 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.
33+
- Description: To send data to an asset, we need to get the property ID values for the
34+
the model properties. This scenario uses temperature and humidity properties.
35+
- The method `listAssetModelProperties()` is called to retrieve the property ID values.
36+
- Exception Handling: Check to see if an `IoTSiteWiseException` is thrown. There are not
37+
many other useful exceptions for this specific call. If so, display the message and end the program.
2938

3039
4. **Send data to an AWS IoT SiteWise Asset**:
3140
- Description: This operation sends data to an IoT SiteWise Asset.
@@ -47,7 +56,7 @@ The AWS IoT SiteWise Basics scenario executes the following operations.
4756
- The method `describePortal()` is called and returns the URL.
4857
- Exception Handling: Check to see if a `ResourceNotFoundException` is thrown. If so, display the message and end the program.
4958

50-
8. **Create an IoTSitewise Gateway**:
59+
8. **Create an IoTSiteWise Gateway**:
5160
- Description: This operation creates an IoT SiteWise Gateway.
5261
- The method `createGateway` is called.
5362
- Exception Handling: Check to see if an `IoTSiteWiseException` is thrown.

0 commit comments

Comments
 (0)