ContextQMD
Back to Aws Doc Sdk Examples

AWS IoT SiteWise code examples for the SDK for JavaScript (v3)

javascriptv3/example_code/iotsitewise/README.md

latest4.6 KB
Original Source

AWS IoT SiteWise code examples for the SDK for JavaScript (v3)

Overview

Shows how to use the AWS SDK for JavaScript (v3) 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 and Free Tier.
  • 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.
  • This code is not tested in every AWS Region. For more information, see AWS Regional Services.
<!--custom.important.start--> <!--custom.important.end-->

Code examples

Prerequisites

For prerequisites, see the README in the javascriptv3 folder.

<!--custom.prerequisites.start--> <!--custom.prerequisites.end-->

Get started

Basics

Code examples that show you how to perform the essential operations within a service.

Single actions

Code excerpts that show you how to call individual service functions.

<!--custom.examples.start--> <!--custom.examples.end-->

Run the examples

Instructions

Note: All code examples are written in ECMAscript 6 (ES6). For guidelines on converting to CommonJS, see JavaScript ES6/CommonJS syntax.

Run a single action

bash
node ./actions/<fileName>

Run a scenario

Most scenarios can be run with the following command:

bash
node ./scenarios/<fileName>

Run with options

Some actions and scenarios can be run with options from the command line:

bash
node ./scenarios/<fileName> --option1 --option2

util.parseArgs is used to configure these options. For the specific options available to each script, see the parseArgs usage for that file.

<!--custom.instructions.start--> <!--custom.instructions.end-->

Hello AWS IoT SiteWise

This example shows you how to get started using AWS IoT SiteWise.

bash
node ./hello.js

Learn the basics

This example shows you how to do the following:

  • Create an AWS IoT SiteWise Asset Model.
  • Create an AWS IoT SiteWise Asset.
  • Retrieve the property ID values.
  • Send data to an AWS IoT SiteWise Asset.
  • Retrieve the value of the AWS IoT SiteWise Asset property.
  • Create an AWS IoT SiteWise Portal.
  • Create an AWS IoT SiteWise Gateway.
  • Describe the AWS IoT SiteWise Gateway.
  • Delete the AWS IoT SiteWise Assets.
<!--custom.basic_prereqs.iotsitewise_Scenario.start--> <!--custom.basic_prereqs.iotsitewise_Scenario.end--> <!--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 in the javascriptv3 folder.

<!--custom.tests.start--> <!--custom.tests.end-->

Additional resources

<!--custom.resources.start--> <!--custom.resources.end-->

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0