Skip to content

README.md

Latest commit

 

History

History
153 lines (96 loc) · 4.55 KB

README.md

File metadata and controls

153 lines (96 loc) · 4.55 KB

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.

_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.

Code examples

Prerequisites

For prerequisites, see the README in the javascriptv3 folder.

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.

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

node ./actions/<fileName>

Run a scenario

Most scenarios can be run with the following command:

node ./scenarios/<fileName>

Run with options

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

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.

Hello AWS IoT SiteWise

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

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.

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.

Additional resources

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

SPDX-License-Identifier: Apache-2.0