Skip to content

Commit 833fc88

Browse files
scmacdonscmacdon
authored
Java V2 Add Sitewise Basics Scenario (#6871)
1 parent 347e86d commit 833fc88

File tree

12 files changed

+2419
-0
lines changed

12 files changed

+2419
-0
lines changed

‎.doc_gen/metadata/iot_sitewise_metadata.yaml‎

Lines changed: 204 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,204 @@
1+
# zexi 0.4.0
2+
iotsitewise_Hello:
3+
title: Hello &ITSWlong;
4+
title_abbrev: Hello &ITSW;
5+
synopsis: get started using &ITSW;.
6+
category: Hello
7+
languages:
8+
Java:
9+
versions:
10+
- sdk_version: 2
11+
github: javav2/example_code/iotsitewise
12+
sdkguide:
13+
excerpts:
14+
- description:
15+
snippet_tags:
16+
- iotsitewise.hello.main
17+
services:
18+
iotsitewise: {ListVersions}
19+
iotsitewise_DescribeGateway:
20+
languages:
21+
Java:
22+
versions:
23+
- sdk_version: 2
24+
github: javav2/example_code/iotsitewise
25+
excerpts:
26+
- description:
27+
snippet_tags:
28+
- sitewise.java2.describe.gateway.main
29+
services:
30+
iotsitewise: {DescribeGateway}
31+
iotsitewise_DeleteGateway:
32+
languages:
33+
Java:
34+
versions:
35+
- sdk_version: 2
36+
github: javav2/example_code/iotsitewise
37+
excerpts:
38+
- description:
39+
snippet_tags:
40+
- sitewise.java2.delete.gateway.main
41+
services:
42+
iotsitewise: {DeleteGateway}
43+
iotsitewise_CreateGateway:
44+
languages:
45+
Java:
46+
versions:
47+
- sdk_version: 2
48+
github: javav2/example_code/iotsitewise
49+
excerpts:
50+
- description:
51+
snippet_tags:
52+
- sitewise.java2.create.gateway.main
53+
services:
54+
iotsitewise: {CreateGateway}
55+
iotsitewise_DescribePortal:
56+
languages:
57+
Java:
58+
versions:
59+
- sdk_version: 2
60+
github: javav2/example_code/iotsitewise
61+
excerpts:
62+
- description:
63+
snippet_tags:
64+
- sitewise.java2.describe.portal.main
65+
services:
66+
iotsitewise: {DescribePortal}
67+
iotsitewise_ListAssetModels:
68+
languages:
69+
Java:
70+
versions:
71+
- sdk_version: 2
72+
github: javav2/example_code/iotsitewise
73+
excerpts:
74+
- description:
75+
snippet_tags:
76+
- sitewise.java2.list.asset.model.main
77+
services:
78+
iotsitewise: {ListAssetModels}
79+
iotsitewise_DeletePortal:
80+
languages:
81+
Java:
82+
versions:
83+
- sdk_version: 2
84+
github: javav2/example_code/iotsitewise
85+
excerpts:
86+
- description:
87+
snippet_tags:
88+
- sitewise.java2.delete.portal.main
89+
services:
90+
iotsitewise: {DeletePortal}
91+
iotsitewise_CreatePortal:
92+
languages:
93+
Java:
94+
versions:
95+
- sdk_version: 2
96+
github: javav2/example_code/iotsitewise
97+
excerpts:
98+
- description:
99+
snippet_tags:
100+
- sitewise.java2.create.portal.main
101+
services:
102+
iotsitewise: {CreatePortal}
103+
iotsitewise_DeleteAssetModel:
104+
languages:
105+
Java:
106+
versions:
107+
- sdk_version: 2
108+
github: javav2/example_code/iotsitewise
109+
excerpts:
110+
- description:
111+
snippet_tags:
112+
- sitewise.java2.delete.asset.model.main
113+
services:
114+
iotsitewise: {DeleteAssetModel}
115+
iotsitewise_DeleteAsset:
116+
languages:
117+
Java:
118+
versions:
119+
- sdk_version: 2
120+
github: javav2/example_code/iotsitewise
121+
excerpts:
122+
- description:
123+
snippet_tags:
124+
- sitewise.java2.delete.asset.main
125+
services:
126+
iotsitewise: {DeleteAsset}
127+
iotsitewise_DescribeAssetModel:
128+
languages:
129+
Java:
130+
versions:
131+
- sdk_version: 2
132+
github: javav2/example_code/iotsitewise
133+
excerpts:
134+
- description:
135+
snippet_tags:
136+
- sitewise.java2.describe.asset.model.main
137+
services:
138+
iotsitewise: {DescribeAssetModel}
139+
iotsitewise_GetAssetPropertyValue:
140+
languages:
141+
Java:
142+
versions:
143+
- sdk_version: 2
144+
github: javav2/example_code/iotsitewise
145+
excerpts:
146+
- description:
147+
snippet_tags:
148+
- sitewise.java2_get_property.main
149+
services:
150+
iotsitewise: {GetAssetPropertyValue}
151+
iotsitewise_BatchPutAssetPropertyValue:
152+
languages:
153+
Java:
154+
versions:
155+
- sdk_version: 2
156+
github: javav2/example_code/iotsitewise
157+
excerpts:
158+
- description:
159+
snippet_tags:
160+
- sitewise.java2_put_batch_property.main
161+
services:
162+
iotsitewise: {BatchPutAssetPropertyValue}
163+
iotsitewise_CreateAsset:
164+
languages:
165+
Java:
166+
versions:
167+
- sdk_version: 2
168+
github: javav2/example_code/iotsitewise
169+
excerpts:
170+
- description:
171+
snippet_tags:
172+
- sitewise.java2_create_asset.main
173+
services:
174+
iotsitewise: {CreateAsset}
175+
iotsitewise_CreateAssetModel:
176+
languages:
177+
Java:
178+
versions:
179+
- sdk_version: 2
180+
github: javav2/example_code/iotsitewise
181+
excerpts:
182+
- description:
183+
snippet_tags:
184+
- sitewise.java2_create_asset_model.main
185+
services:
186+
iotsitewise: {CreateAssetModel}
187+
iotsitewise_Scenario:
188+
synopsis: Learn core operations for &ITSWlong; using an &AWS; SDK.
189+
category: Basics
190+
languages:
191+
Java:
192+
versions:
193+
- sdk_version: 2
194+
github: javav2/example_code/iotsitewise
195+
sdkguide:
196+
excerpts:
197+
- description: Run an interactive scenario demonstrating &ITSW; features.
198+
snippet_tags:
199+
- iotsitewise.java2.scenario.main
200+
- description: A wrapper class for &ITSW; SDK methods.
201+
snippet_tags:
202+
- iotsitewise.java2.actions.main
203+
services:
204+
iotsitewise: {}

‎basics_scenarios/sitewise_scenario/README.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## 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.
3+
4+
## Key Operations
5+
6+
1. **Create an AWS SiteWise Asset Model**:
7+
- This step creates an AWS SiteWise Asset Model by invoking the `createAssetModel` method.
8+
9+
2. **Create an AWS IoT SiteWise Asset**:
10+
- This operation creates an AWS SiteWise asset.
11+
12+
3. **Retrieve the property ID values**:
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.
14+
15+
4. **Send data to an AWS IoT SiteWise Asset**:
16+
- This operation sends data to an IoT SiteWise Asset.
17+
18+
5. **Retrieve the value of the IoT SiteWise Asset property**:
19+
- This operation gets data from the asset.
20+
21+
**Note** See the Eng spec for a full listing of operations.
22+
23+
## Resources
24+
25+
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.
26+
27+
## Implementations
28+
29+
This scenario example will be implemented in the following languages:
30+
31+
- Java
32+
- Python
33+
- JavaScript
34+
35+
## Additional Reading
36+
37+
- [AWS IoT SiteWise Documentation](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/what-is-sitewise.html)
38+
39+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)