canonical: https://jentic.com/apis/amazonaws.com/iotsitewise # AWS IoT SiteWise Jentic publishes the only available OpenAPI specification for AWS IoT SiteWise, keeping it validated and agent-ready. AWS IoT SiteWise is a managed service that collects, organises, and analyses data from industrial equipment at scale. It models physical assets such as wind turbines, production lines, and chemical reactors as digital twins, ingests time-series property values from MQTT or OPC-UA gateways, and exposes the data through 73 endpoints covering assets, asset models, properties, gateways, portals, and dashboards. The service runs aggregations on the fly and supports SiteWise Monitor portals so operators can browse live and historical metrics without standing up custom dashboards. ## For AI agents Model industrial assets, ingest sensor telemetry, and query historical and aggregated property values from factory, energy, and utility equipment. ## Scope Does not handle MQTT messaging, edge code deployment, or general device shadow management - use for industrial asset modelling, sensor data ingestion, and historical querying only. ## Capabilities - Model industrial equipment as asset hierarchies via /asset-models and /assets endpoints - Stream property values in batch through /properties/batch/putAssetPropertyValue - Query aggregated, historical, and latest property values across asset fleets - Provision and configure SiteWise Edge gateways for on-premises OPC-UA collection - Create SiteWise Monitor portals, projects, and dashboards for operator visibility - Associate time-series aliases with asset properties for cross-source data unification - Run interpolation queries to fill gaps in irregular sensor sampling intervals ## Use cases ### Industrial Asset Modelling Represent physical equipment such as turbines, conveyors, and compressors as structured digital assets with typed properties, hierarchies, and computed metrics. AWS IoT SiteWise stores asset models that describe the schema of equipment classes, then instantiates assets that inherit those models. Engineers can roll up child asset metrics to parent assets, enabling fleet-wide and site-wide views without custom data pipelines. Example prompt: Create an asset model named WindTurbine with properties for RotorSpeed, PowerOutput, and BladePitch, then instantiate three assets bound to that model ### Sensor Data Ingestion at Scale Collect time-series telemetry from thousands of sensors using SiteWise Edge gateways, MQTT publishers, or direct API writes. The /properties/batch/putAssetPropertyValue endpoint accepts up to 10 entries per call with multiple value timestamps each, suitable for high-frequency industrial workloads. Data flows into time-series storage with built-in retention, and computed properties evaluate transforms and metrics as new values arrive. Example prompt: Push a batch of 50 timestamped pressure readings from sensor S-204 into the BoilerPressure property of asset asset-9f3b ### Operator Dashboards and Portals Provide manufacturing and energy operators with live visibility into plant performance through SiteWise Monitor portals. Portals organise projects and dashboards backed by SSO, and dashboards reference asset properties directly so they update as new telemetry arrives. The /portals, /projects, and /dashboards endpoints let teams provision the entire visibility layer from infrastructure-as-code rather than the console. Example prompt: Provision a SiteWise Monitor portal named 'Plant 7 Operations' with a project containing one dashboard wired to the BoilerPressure and SteamFlow properties ### Historical Trend and Aggregate Analysis Investigate equipment behaviour by querying aggregated metrics over arbitrary time windows. The /properties/batch/aggregates and /properties/batch/history endpoints return min, max, average, sum, and standard deviation across one or many assets at minute, hour, or day resolution. Reliability engineers use these queries to spot drift, schedule maintenance, and feed analytics notebooks without exporting raw data. Example prompt: Fetch the hourly average of property prop-rotor-speed for asset asset-9f3b across the last 24 hours ### AI Agent Industrial Operations AI agents call AWS IoT SiteWise through Jentic to read live and historical equipment data, instantiate assets when new gear is commissioned, and surface anomalies to maintenance staff. Through Jentic, an agent searches for the right SiteWise operation by intent, loads the schema, and submits the call with credentials kept in your Jentic One instance. This avoids the multi-day overhead of building bespoke SigV4 request signing into agent runtimes. Example prompt: Search Jentic for 'get latest sensor reading from industrial asset', load the BatchGetAssetPropertyValue schema, and execute it for asset asset-9f3b property prop-temp ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | /asset-models | Create an asset model | | POST | /assets | Create an asset from a model | | POST | /properties/batch/putAssetPropertyValue | Ingest batched property values | | POST | /properties/batch/latest | Read the latest values for many properties | | POST | /properties/batch/history | Query historical property values | | POST | /properties/batch/aggregates | Query aggregated metrics over time windows | | POST | /portals | Create a SiteWise Monitor portal | ## Key resources - **Assets and Asset Models** — Define equipment schemas and instantiate physical asset records - **Properties** — Read latest, historical, and aggregated time-series values - **Gateways** — Manage SiteWise Edge gateways that bridge OPC-UA and MQTT sources - **Portals, Projects, and Dashboards** — Provision the SiteWise Monitor visibility layer - **Time Series and Aliases** — Map external data stream identifiers to asset properties ## Why Jentic - **Setup:** Wiring the IoT SiteWise API by hand means building AWS Signature Version 4 signing, selecting the right regional host from iotsitewise.{region}.amazonaws.com, wiring IAM roles, and handling AWS throttling and retries yourself. Through Jentic you install once, import AWS IoT SiteWise from the API Directory, store the AWS access key and secret once, and your agent calls it. - **Permission scoping:** IoT SiteWise carries asset and property ids in the request body of its batch read and write operations, so limit the agent to the operations it needs, such as BatchGetAssetPropertyValue for reads or CreateAssetModel for setup. You choose the operations it may call, so destructive ones like DeleteAsset or DeletePortal are not included unless you add them. - **Credential handling:** Your AWS access key and secret for IoT SiteWise are stored once, encrypted, by your own Jentic One instance and signed with SigV4 at execution time. They never enter the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'read the latest reading from an industrial sensor' or 'create an iot asset model', and Jentic returns the matching IoT SiteWise operation with its input schema so the agent calls the right endpoint without reading the AWS reference. ## Related APIs - **AWS IoT Events** — Detect and respond to events from IoT sensor data - **AWS IoT Core Data** — Publish and subscribe to MQTT topics for connected devices - **AWS IoT Greengrass** — Run edge compute on industrial gateways - **Amazon Kinesis Analytics** — Streaming SQL analytics over time-series data ## FAQ ### Why is there no official OpenAPI spec for AWS IoT SiteWise? AWS does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call AWS IoT SiteWise via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the AWS IoT SiteWise API use? AWS IoT SiteWise uses AWS Signature Version 4 (SigV4) HMAC request signing. Each request must be signed with an access key, secret key, and optional session token scoped to the IoT SiteWise IAM permissions. Through Jentic, these credentials are stored encrypted in the vault and applied at execution time, so the agent never sees raw secrets. ### Can I ingest time-series sensor data with the AWS IoT SiteWise API? Yes. Use POST /properties/batch/putAssetPropertyValue to submit up to 10 entries per call, where each entry can carry multiple timestamped values. For higher throughput, deploy a SiteWise Edge gateway and configure OPC-UA or MQTT data sources, which write into the same property records via the gateway endpoints. ### How do I model a piece of industrial equipment with AWS IoT SiteWise through Jentic? Search Jentic for 'create iot sitewise asset model', load the schema for POST /asset-models, and submit the model definition with measurement, transform, and metric properties. Then call POST /assets to instantiate the asset bound to that model. Jentic handles SigV4 signing for both calls. ### What are the rate limits for the AWS IoT SiteWise API? Rate limits vary by operation and AWS Region. Asset property data writes default to 10 entries per request and ingestion quotas scale per region; read operations such as BatchGetAssetPropertyValue have separate transactions-per-second limits documented in the AWS service quotas console. Check your account's IoT SiteWise quotas before high-volume runs. ### Can the AWS IoT SiteWise API run aggregations across many assets at once? Yes. POST /properties/batch/aggregates accepts entries that span multiple asset IDs and property IDs and returns aggregate values such as average, sum, minimum, maximum, count, and standard deviation across the window you specify. ### Does AWS IoT SiteWise support on-premises data collection? Yes. SiteWise Edge gateways run on AWS IoT Greengrass and connect to OPC-UA servers and other industrial protocols at the plant. Use the /20200301/gateways endpoints to register gateways, then attach data source configurations to push values into the cloud. ### Can I limit what my agent is allowed to do with the AWS IoT SiteWise API? Yes. Because you run your own self-hosted Jentic One instance, your rules decide which of the 73 IoT SiteWise operations the agent may call, so you can allow reads such as BatchGetAssetPropertyValue while withholding writes and setup calls like CreateAssetModel. Destructive operations such as DeleteAsset and DeletePortal are excluded unless you explicitly add them. Since asset and property ids travel in the request bodies of the batch read and write operations, you constrain access at the operation level and pair it with AWS credentials scoped to the matching IoT SiteWise IAM permissions.