Skip to content

Commit 4497288

Browse files
committed
updated high level Readme
1 parent 9cecf12 commit 4497288

File tree

1 file changed

+18
-20
lines changed

1 file changed

+18
-20
lines changed

basics_scenarios/sitewise_scenario/README.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,35 @@
1-
# Amazon OpenSearch Service Basic Scenario
1+
# AWS IoT SiteWise Service Basic Scenario
22

33
## Overview
44

5-
This Amazon OpenSearch Service (Amazon ECR) basic scenario demonstrates how to interact with the Amazon OpenSearch service using an AWS SDK. The scenario covers various operations such as creating an OpenSearch domain, modifying a domain, waiting for changes to the domain to enter a complete state, and so on.
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.
66

77
Here are the top five service operations this scenario covers.
88

9-
**Create an Amazon OpenSearch Domain**:
10-
- Description: This operation creates a new Amazon OpenSearch domain, which is a managed instance of the OpenSearch engine.
9+
1. **Create an AWS SiteWise Asset Model**:
10+
- Description: This step creates an AWS SiteWise Asset Model by invoking the `createAssetModel` method.
1111

12-
2. **Describe the Amazon OpenSearch Domain**:
13-
- Description: This operation retrieves information about the specified Amazon OpenSearch domain.
14-
- The method `describeDomain(domainName)` is called to obtain the Amazon Resource Name (ARN) of the specified OpenSearch domain.
12+
2. **Create an AWS IoT SiteWise Asset**:
13+
- Description: This operation creates an AWS SiteWise asset.
1514

16-
3. **List the Domains in Your Account**:
17-
- Description: This operation lists all the Amazon OpenSearch domains in the current AWS account.
18-
- The method `listAllDomains()` is called to retrieve a list of all the OpenSearch domains available in the account.
1915

20-
4. **Wait until the Domain's Change Status Reaches a Completed State**:
21-
- Description: This operation waits until the change status of the specified Amazon OpenSearch domain reaches a completed state.
22-
- When making changes to an OpenSearch domain, such as scaling the number of data nodes or updating the OpenSearch version, the domain goes through a change process. This method, `domainChangeProgress(domainName)`, waits until the change status of the specified domain reaches a completed state, which can take several minutes to several hours, depending on the complexity of the change and the current load on the OpenSearch service.
23-
Note this operation may take up to 20 minutes.
16+
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.
2419

25-
5. **Modify the Domain**:
26-
- Description: This operation modifies the cluster configuration of the specified Amazon OpenSearch domain, such as the instance count.
27-
- The flexibility to modify the OpenSearch domain's configuration is particularly useful when the data or usage patterns change over time, as you can easily scale the domain to meet the new requirements without having to recreate the entire domain.
28-
- The method `updateSpecificDomain(domainName)` is called to update the configuration of the specified OpenSearch domain.
20+
21+
4. **Send data to an AWS IoT SiteWise Asset**:
22+
- Description: This operation sends data to an IoT SiteWise Asset.
23+
24+
5. **Retrieve the value of the IoT SiteWise Asset property**:
25+
- Description: This operation gets data from the asset.
2926

3027
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.
3128

3229
### Resources
3330

34-
This scenario does not require any additional AWS resources to run.
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.
3533

3634

3735
## Implementations
@@ -44,7 +42,7 @@ This scenario example will be implemented in the following languages:
4442

4543
## Additional reading
4644

47-
- [Amazon ECR](https://docs.aws.amazon.com/AmazonECR/latest/userguide/what-is-ecr.html)
45+
- [AWS Sitewise](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/what-is-sitewise.html)
4846

4947
---
5048

0 commit comments

Comments
 (0)