the ReadMes

awsdocs · Nov 15, 2024 · a9d371e · a9d371e
1 parent 498f985
commit a9d371e
Show file tree

Hide file tree

Showing 3 changed files with 137 additions and 4 deletions.
diff --git a/.doc_gen/metadata/iot_sitewise_metadata.yaml b/.doc_gen/metadata/iot_sitewise_metadata.yaml
@@ -278,9 +278,9 @@ iotsitewise_BatchPutAssetPropertyValue:
                A helper function to generate the entries parameter from a values
                list.
               snippet_tags:
-                - python.example_code.iotsitewise.BatchPutAssetPropertyValue.properties_to_
+                - python.example_code.iotsitewise.BatchPutAssetPropertyValue.properties_to_values
             - description: >
-               Here is an example of a values list to pass to the helper 
+               Here is an example of a values list to pass to the helper
                function.
               snippet_tags:
                 - python.example_code.iotsitewise.BatchPutAssetPropertyValue.values

diff --git a/javav2/example_code/iotsitewise/README.md b/javav2/example_code/iotsitewise/README.md
@@ -31,7 +31,7 @@ For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav
 
 ### Get started
 
-- [Hello AWS IoT SiteWise](src/main/java/com/example/iotsitewise/HelloSitewise.java#L14) (`ListVersions`)
+- [Hello AWS IoT SiteWise](src/main/java/com/example/iotsitewise/HelloSitewise.java#L14) (`ListAssetModels`)
 
 
 ### Basics
@@ -54,10 +54,10 @@ Code excerpts that show you how to call individual service functions.
 - [DeleteAssetModel](src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java#L320)
 - [DeleteGateway](src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java#L513)
 - [DeletePortal](src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java#L381)
-- [DescribeAssetModel](src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java#L264)
 - [DescribeGateway](src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java#L540)
 - [DescribePortal](src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java#L439)
 - [GetAssetPropertyValue](src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java#L233)
+- [ListAssetModelProperties](src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java#L264)
 - [ListAssetModels](src/main/java/com/example/iotsitewise/scenario/SitewiseActions.java#L408)
 
 

diff --git a/python/example_code/iotsitewise/README.md b/python/example_code/iotsitewise/README.md
@@ -0,0 +1,133 @@
+# AWS IoT SiteWise code examples for the SDK for Python
+
+## Overview
+
+Shows how to use the AWS SDK for Python (Boto3) to work with AWS IoT SiteWise.
+
+<!--custom.overview.start-->
+<!--custom.overview.end-->
+
+_AWS IoT SiteWise _
+
+## ⚠ Important
+
+* 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/).
+* Running the tests might result in charges to your AWS account.
+* 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).
+* 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).
+
+<!--custom.important.start-->
+<!--custom.important.end-->
+
+## Code examples
+
+### Prerequisites
+
+For prerequisites, see the [README](../../README.md#Prerequisites) in the `python` folder.
+
+Install the packages required by these examples by running the following in a virtual environment:
+
+```
+python -m pip install -r requirements.txt
+```
+
+<!--custom.prerequisites.start-->
+<!--custom.prerequisites.end-->
+
+### Get started
+
+- [Hello AWS IoT SiteWise](hello/hello_iot_sitewise.py#L4) (`ListAssetModels`)
+
+
+### Basics
+
+Code examples that show you how to perform the essential operations within a service.
+
+- [Learn the basics](iotsitewise_getting_started.py)
+
+
+### Single actions
+
+Code excerpts that show you how to call individual service functions.
+
+- [BatchPutAssetPropertyValue](iotsitewise_wrapper.py#L155)
+- [CreateAsset](iotsitewise_wrapper.py#L75)
+- [CreateAssetModel](iotsitewise_wrapper.py#L41)
+- [CreateGateway](iotsitewise_wrapper.py#L315)
+- [CreatePortal](iotsitewise_wrapper.py#L259)
+- [DeleteAsset](iotsitewise_wrapper.py#L415)
+- [DeleteAssetModel](iotsitewise_wrapper.py#L434)
+- [DeleteGateway](iotsitewise_wrapper.py#L371)
+- [DeletePortal](iotsitewise_wrapper.py#L393)
+- [DescribeGateway](iotsitewise_wrapper.py#L347)
+- [DescribePortal](iotsitewise_wrapper.py#L315)
+- [GetAssetPropertyValue](iotsitewise_wrapper.py#L229)
+- [ListAssetModelProperties](iotsitewise_wrapper.py#L129)
+- [ListAssetModels](iotsitewise_wrapper.py#L105)
+
+
+<!--custom.examples.start-->
+<!--custom.examples.end-->
+
+## Run the examples
+
+### Instructions
+
+
+<!--custom.instructions.start-->
+<!--custom.instructions.end-->
+
+#### Hello AWS IoT SiteWise
+
+This example shows you how to get started using AWS IoT SiteWise.
+
+```
+python hello/hello_iot_sitewise.py
+```
+
+#### Learn the basics
+
+This example shows you how to Learn core operations for AWS IoT SiteWise using an AWS SDK.
+
+
+<!--custom.basic_prereqs.iotsitewise_Scenario.start-->
+<!--custom.basic_prereqs.iotsitewise_Scenario.end-->
+
+Start the example by running the following at a command prompt:
+
+```
+python iotsitewise_getting_started.py
+```
+
+
+<!--custom.basics.iotsitewise_Scenario.start-->
+<!--custom.basics.iotsitewise_Scenario.end-->
+
+
+### Tests
+
+⚠ Running tests might result in charges to your AWS account.
+
+
+To find instructions for running these tests, see the [README](../../README.md#Tests)
+in the `python` folder.
+
+
+
+<!--custom.tests.start-->
+<!--custom.tests.end-->
+
+## Additional resources
+
+- [AWS IoT SiteWise Developer Guide](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/what-is-sitewise.html)
+- [AWS IoT SiteWise API Reference](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/Welcome.html)
+- [SDK for Python AWS IoT SiteWise reference](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/iotsitewise.html)
+
+<!--custom.resources.start-->
+<!--custom.resources.end-->
+
+---
+
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0