Skip to content

Commit ac2076f

Browse files
committed
updated high level Readme
1 parent 4497288 commit ac2076f

File tree

1 file changed

+11
-23
lines changed

1 file changed

+11
-23
lines changed
Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,26 @@
1-
# AWS IoT SiteWise Service Basic Scenario
2-
31
## Overview
2+
This AWS IoT SiteWise Service basic scenario demonstrates how to interact with the AWS IoT SiteWise service using an AWS SDK. The scenario covers various operations such as creating an Asset Model, creating assets, sending data to assets, and retrieving data.
43

5-
This AWS IoT SiteWise Service basic scenario demonstrates how to interact with the AWS IoT SiteWise service using an AWS SDK. The scenario covers various operations such as creating a Asset Model, creating assets, sending data to assets, retrieving data, and so on.
6-
7-
Here are the top five service operations this scenario covers.
4+
## Key Operations
85

96
1. **Create an AWS SiteWise Asset Model**:
10-
- Description: This step creates an AWS SiteWise Asset Model by invoking the `createAssetModel` method.
7+
- This step creates an AWS SiteWise Asset Model by invoking the `createAssetModel` method.
118

129
2. **Create an AWS IoT SiteWise Asset**:
13-
- Description: This operation creates an AWS SiteWise asset.
14-
10+
- This operation creates an AWS SiteWise asset.
1511

1612
3. **Retrieve the property ID values**:
17-
- Description: To send data to an asset, we need to get the property ID values for the
18-
the model properties. This scenario uses temperature and humidity properties.
19-
13+
- To send data to an asset, we need to get the property ID values for the model properties. This scenario uses temperature and humidity properties.
2014

2115
4. **Send data to an AWS IoT SiteWise Asset**:
22-
- Description: This operation sends data to an IoT SiteWise Asset.
16+
- This operation sends data to an IoT SiteWise Asset.
2317

2418
5. **Retrieve the value of the IoT SiteWise Asset property**:
25-
- Description: This operation gets data from the asset.
19+
- This operation gets data from the asset.
2620

27-
Note: These steps are not the complete program, but summarizes the 5 high-level steps. See the Eng Spec for a complete listing of operations.
28-
29-
### Resources
30-
31-
This Basics scenario requires an IAM role that has permissions to work with AWS IoT
32-
SiteWise service. The scenario creates this resource using a CloudFormation template.
21+
## Resources
3322

23+
This Basics scenario requires an IAM role that has permissions to work with the AWS IoT SiteWise service. The scenario creates this resource using a CloudFormation template.
3424

3525
## Implementations
3626

@@ -40,10 +30,8 @@ This scenario example will be implemented in the following languages:
4030
- Python
4131
- JavaScript
4232

43-
## Additional reading
44-
45-
- [AWS Sitewise](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/what-is-sitewise.html)
33+
## Additional Reading
4634

47-
---
35+
- [AWS IoT SiteWise Documentation](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/what-is-sitewise.html)
4836

4937
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)