Skip to content

Commit 1194151

Browse files
meyertst-awsmeyertst-aws
committed
the ReadMes
1 parent b870f33 commit 1194151

File tree

3 files changed

+137
-4
lines changed

3 files changed

+137
-4
lines changed

‎.doc_gen/metadata/iot_sitewise_metadata.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,9 +278,9 @@ iotsitewise_BatchPutAssetPropertyValue:
278278
A helper function to generate the entries parameter from a values
279279
list.
280280
snippet_tags:
281-
- python.example_code.iotsitewise.BatchPutAssetPropertyValue.properties_to_
281+
- python.example_code.iotsitewise.BatchPutAssetPropertyValue.properties_to_values
282282
- description: >
283-
Here is an example of a values list to pass to the helper
283+
Here is an example of a values list to pass to the helper
284284
function.
285285
snippet_tags:
286286
- python.example_code.iotsitewise.BatchPutAssetPropertyValue.values

‎javav2/example_code/iotsitewise/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav
3131

3232
### Get started
3333

34-
- [Hello AWS IoT SiteWise](src/main/java/com/example/iotsitewise/HelloSitewise.java#L14) (`ListVersions`)
34+
- [Hello AWS IoT SiteWise](src/main/java/com/example/iotsitewise/HelloSitewise.java#L14) (`ListAssetModels`)
3535

3636

3737
### Basics
@@ -54,10 +54,10 @@ Code excerpts that show you how to call individual service functions.
5454
- [DeleteAssetModel](src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java#L320)
5555
- [DeleteGateway](src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java#L513)
5656
- [DeletePortal](src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java#L381)
57-
- [DescribeAssetModel](src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java#L264)
5857
- [DescribeGateway](src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java#L540)
5958
- [DescribePortal](src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java#L439)
6059
- [GetAssetPropertyValue](src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java#L233)
60+
- [ListAssetModelProperties](src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java#L264)
6161
- [ListAssetModels](src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java#L408)
6262

6363

‎python/example_code/iotsitewise/README.md‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# AWS IoT SiteWise code examples for the SDK for Python
2+
3+
## Overview
4+
5+
Shows how to use the AWS SDK for Python (Boto3) to work with AWS IoT SiteWise.
6+
7+
<!--custom.overview.start-->
8+
<!--custom.overview.end-->
9+
10+
_AWS IoT SiteWise _
11+
12+
## ⚠ Important
13+
14+
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
15+
* Running the tests might result in charges to your AWS account.
16+
* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
17+
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
18+
19+
<!--custom.important.start-->
20+
<!--custom.important.end-->
21+
22+
## Code examples
23+
24+
### Prerequisites
25+
26+
For prerequisites, see the [README](../../README.md#Prerequisites) in the `python` folder.
27+
28+
Install the packages required by these examples by running the following in a virtual environment:
29+
30+
```
31+
python -m pip install -r requirements.txt
32+
```
33+
34+
<!--custom.prerequisites.start-->
35+
<!--custom.prerequisites.end-->
36+
37+
### Get started
38+
39+
- [Hello AWS IoT SiteWise](hello/hello_iot_sitewise.py#L4) (`ListAssetModels`)
40+
41+
42+
### Basics
43+
44+
Code examples that show you how to perform the essential operations within a service.
45+
46+
- [Learn the basics](iotsitewise_getting_started.py)
47+
48+
49+
### Single actions
50+
51+
Code excerpts that show you how to call individual service functions.
52+
53+
- [BatchPutAssetPropertyValue](iotsitewise_wrapper.py#L155)
54+
- [CreateAsset](iotsitewise_wrapper.py#L75)
55+
- [CreateAssetModel](iotsitewise_wrapper.py#L41)
56+
- [CreateGateway](iotsitewise_wrapper.py#L315)
57+
- [CreatePortal](iotsitewise_wrapper.py#L259)
58+
- [DeleteAsset](iotsitewise_wrapper.py#L415)
59+
- [DeleteAssetModel](iotsitewise_wrapper.py#L434)
60+
- [DeleteGateway](iotsitewise_wrapper.py#L371)
61+
- [DeletePortal](iotsitewise_wrapper.py#L393)
62+
- [DescribeGateway](iotsitewise_wrapper.py#L347)
63+
- [DescribePortal](iotsitewise_wrapper.py#L315)
64+
- [GetAssetPropertyValue](iotsitewise_wrapper.py#L229)
65+
- [ListAssetModelProperties](iotsitewise_wrapper.py#L129)
66+
- [ListAssetModels](iotsitewise_wrapper.py#L105)
67+
68+
69+
<!--custom.examples.start-->
70+
<!--custom.examples.end-->
71+
72+
## Run the examples
73+
74+
### Instructions
75+
76+
77+
<!--custom.instructions.start-->
78+
<!--custom.instructions.end-->
79+
80+
#### Hello AWS IoT SiteWise
81+
82+
This example shows you how to get started using AWS IoT SiteWise.
83+
84+
```
85+
python hello/hello_iot_sitewise.py
86+
```
87+
88+
#### Learn the basics
89+
90+
This example shows you how to Learn core operations for AWS IoT SiteWise using an AWS SDK.
91+
92+
93+
<!--custom.basic_prereqs.iotsitewise_Scenario.start-->
94+
<!--custom.basic_prereqs.iotsitewise_Scenario.end-->
95+
96+
Start the example by running the following at a command prompt:
97+
98+
```
99+
python iotsitewise_getting_started.py
100+
```
101+
102+
103+
<!--custom.basics.iotsitewise_Scenario.start-->
104+
<!--custom.basics.iotsitewise_Scenario.end-->
105+
106+
107+
### Tests
108+
109+
⚠ Running tests might result in charges to your AWS account.
110+
111+
112+
To find instructions for running these tests, see the [README](../../README.md#Tests)
113+
in the `python` folder.
114+
115+
116+
117+
<!--custom.tests.start-->
118+
<!--custom.tests.end-->
119+
120+
## Additional resources
121+
122+
- [AWS IoT SiteWise Developer Guide](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/what-is-sitewise.html)
123+
- [AWS IoT SiteWise API Reference](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/Welcome.html)
124+
- [SDK for Python AWS IoT SiteWise reference](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/iotsitewise.html)
125+
126+
<!--custom.resources.start-->
127+
<!--custom.resources.end-->
128+
129+
---
130+
131+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
132+
133+
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)