Industrial IoT / SCADA · API / SDK

AWS IoT SiteWise API

AWS

Access industrial asset models and related data through service APIs.

Official documentation Download development spec

AWS IOT SITEWISE / DEVELOPER FIELD GUIDE

Choose an interface. Define a verifiable result.

Company or project context, ten technical entry points and a practical analysis of every reference.

2026-10-08 · Integration not tested

Company / project overview

Original summary of official company or project statements; use the source for the full original page.

AWS IoT SiteWise · About
Service	AWS IoT SiteWise is a managed service for collecting, organizing and monitoring industrial equipment data.
Asset context	Asset models structure data across facilities, areas and machines.
Developer boundary	APIs expose model, asset and time-series operations; device connectivity and trustworthy measurements need a separate ingestion design.

Complete official About page ↗

About reference — TA analysis
Audience	Buyers, partners and product owners shortlisting an AI provider.
Our assessment	Use positioning and company history for initial fit. Obtain project-specific deployment, support and commercial terms separately.

Official sources reviewed; no live API, inference or benchmark was run. Expected results are proposed internal contracts.

Top 10 technical entry points

Ten documented technical entry points selected by developer task; not ten separate SDKs or an official ranking.

Choose by the work you need to complete
Interface	Purpose and audience
01 · CreateAssetModelAPI / SDK / developer guide	Define standardized asset properties and hierarchies.Asset model designers
02 · CreateAssetAPI / SDK / developer guide	Create an asset using a defined model.Asset onboarding teams
03 · DescribeAssetAPI / SDK / developer guide	Retrieve asset properties and metadata.Asset inventory developers
04 · ListAssetsAPI / SDK / developer guide	List assets matching supported filters.Inventory sync teams
05 · BatchPutAssetPropertyValueAPI / SDK / developer guide	Submit time-stamped values for asset properties.Telemetry ingestion engineers
06 · GetAssetPropertyValueAPI / SDK / developer guide	Read the latest available property value.Monitoring developers
07 · GetAssetPropertyValueHistoryAPI / SDK / developer guide	Read historical property values.Time-series analysts
08 · GetAssetPropertyAggregatesAPI / SDK / developer guide	Retrieve supported aggregate statistics.Industrial KPI teams
09 · AssociateAssetsAPI / SDK / developer guide	Associate child assets within defined hierarchies.Plant model architects
10 · ExecuteQueryAPI / SDK / developer guide	Query SiteWise data using its supported query interface.Data application engineers

Reference analysis

Capabilities summarize official documentation. Constraints and proposed tests are our engineering assessment.

API / SDK / developer guide

CreateAssetModel

CreateAssetModel · TA
Target audience	Asset model designers
Documented capability	Define standardized asset properties and hierarchies.
Input → output	Model definition → model identifier and lifecycle state.
Execution environment	AWS IoT SiteWise in selected account and region, with authorized IAM access
Our decision constraint	Model creation is not physical asset discovery.
Our suggested validation	Validate types, units and readiness before creating assets.

Official reference · CreateAssetModel ↗

API / SDK / developer guide

CreateAsset

CreateAsset · TA
Target audience	Asset onboarding teams
Documented capability	Create an asset using a defined model.
Input → output	Model ID and asset metadata → asset identifier.
Execution environment	AWS IoT SiteWise in selected account and region, with authorized IAM access
Our decision constraint	API acceptance may precede asset readiness.
Our suggested validation	Observe lifecycle state and verify assigned model.

Official reference · CreateAsset ↗

API / SDK / developer guide

DescribeAsset

DescribeAsset · TA
Target audience	Asset inventory developers
Documented capability	Retrieve asset properties and metadata.
Input → output	Asset ID → model, properties and state.
Execution environment	AWS IoT SiteWise in selected account and region, with authorized IAM access
Our decision constraint	Asset metadata does not establish current equipment health.
Our suggested validation	Check property IDs and model references against intended equipment.

Official reference · DescribeAsset ↗

API / SDK / developer guide

ListAssets

ListAssets · TA
Target audience	Inventory sync teams
Documented capability	List assets matching supported filters.
Input → output	Filter and pagination → asset summaries.
Execution environment	AWS IoT SiteWise in selected account and region, with authorized IAM access
Our decision constraint	One response can be only one page.
Our suggested validation	Consume pagination and preserve asset IDs without duplicates.

Official reference · ListAssets ↗

API / SDK / developer guide

BatchPutAssetPropertyValue

BatchPutAssetPropertyValue · TA
Target audience	Telemetry ingestion engineers
Documented capability	Submit time-stamped values for asset properties.
Input → output	Batch entries → entry-level ingestion errors or acceptance.
Execution environment	AWS IoT SiteWise in selected account and region, with authorized IAM access
Our decision constraint	A successful HTTP response can include per-entry errors.
Our suggested validation	Inspect every error entry and retry only eligible failed data.

Official reference · BatchPutAssetPropertyValue ↗

API / SDK / developer guide

GetAssetPropertyValue

GetAssetPropertyValue · TA
Target audience	Monitoring developers
Documented capability	Read the latest available property value.
Input → output	Property reference → value, timestamp and quality.
Execution environment	AWS IoT SiteWise in selected account and region, with authorized IAM access
Our decision constraint	Latest available is not necessarily current or good quality.
Our suggested validation	Apply freshness and quality rules before displaying status.

Official reference · GetAssetPropertyValue ↗

API / SDK / developer guide

GetAssetPropertyValueHistory

GetAssetPropertyValueHistory · TA
Target audience	Time-series analysts
Documented capability	Read historical property values.
Input → output	Property and time range → paginated values.
Execution environment	AWS IoT SiteWise in selected account and region, with authorized IAM access
Our decision constraint	Missing data is not zero and time boundaries must be explicit.
Our suggested validation	Check order, timestamp precision and complete time-window coverage.

Official reference · GetAssetPropertyValueHistory ↗

API / SDK / developer guide

GetAssetPropertyAggregates

GetAssetPropertyAggregates · TA
Target audience	Industrial KPI teams
Documented capability	Retrieve supported aggregate statistics.
Input → output	Property, window and aggregate type → statistics.
Execution environment	AWS IoT SiteWise in selected account and region, with authorized IAM access
Our decision constraint	Aggregate resolution and missing/quality filtering affect interpretation.
Our suggested validation	Compare a known window with independently calculated expected statistics.

Official reference · GetAssetPropertyAggregates ↗

API / SDK / developer guide

AssociateAssets

AssociateAssets · TA
Target audience	Plant model architects
Documented capability	Associate child assets within defined hierarchies.
Input → output	Parent, hierarchy and child IDs → association.
Execution environment	AWS IoT SiteWise in selected account and region, with authorized IAM access
Our decision constraint	Hierarchy relationships must match the model definition.
Our suggested validation	Read back association and reject invalid parent/child combinations.

Official reference · AssociateAssets ↗

API / SDK / developer guide

ExecuteQuery

ExecuteQuery · TA
Target audience	Data application engineers
Documented capability	Query SiteWise data using its supported query interface.
Input → output	Query statement → columns and rows.
Execution environment	AWS IoT SiteWise in selected account and region, with authorized IAM access
Our decision constraint	Query schema and limitations differ from a general-purpose SQL database.
Our suggested validation	Check result metadata, empty rows and continuation handling.

Official reference · ExecuteQuery ↗

Official API reference

Official API reference · Supporting reference analysis
TA	Integration architects
Our validation advice	Check quotas, regional availability and action-level IAM permissions before implementation.

Official reference · Official API reference ↗

04 / INPUT · EXPECTED OUTPUT · ACCEPTANCE

Expected results before implementation

Illustrative asset telemetry read envelope; not native SiteWise API JSON. No telemetry was uploaded, asset created or API called.

Illustrative contract · no API call or model execution · not measured provider output

Property values returned

Expected behavior — illustrative, not executed
Input	Authorized query for a known property and time window.
Expected result	ok with typed values, timestamps and quality metadata.
Acceptance	Confirm units, time window and quality before KPI calculation.

No history in range

Expected behavior — illustrative, not executed
Input	Valid history request contains no data points.
Expected result	ok with values: []; not a zero reading.
Acceptance	Present missing data explicitly and do not interpolate silently.

Partial ingestion rejection

Expected behavior — illustrative, not executed
Input	A hypothetical batch contains valid and invalid entries.
Expected result	partial with failed entry IDs, even if HTTP transport succeeds.
Acceptance	Inspect per-entry errors and avoid resending accepted entries blindly.

Asset not ready

Expected behavior — illustrative, not executed
Input	Asset creation has been accepted but lifecycle work remains.
Expected result	pending; no claim of usable telemetry stream.
Acceptance	Check asset state before dependent operations.

Stale or poor-quality value

Expected behavior — illustrative, not executed
Input	Latest stored value is outside freshness threshold or has unacceptable quality.
Expected result	Valid read with degraded data status, not current healthy equipment.
Acceptance	Retain original timestamp/quality and require explicit downstream policy.

Map the expected result to your application

Map the actual SDK or service response into this proposed internal contract after integration. All IDs and values below are invented examples; no credentials or live requests are included.

Expected output JSON — illustrative, not measured · AWSIoTSiteWise-expected-results.json

{
  "schema_version": "1.0.0",
  "example": true,
  "provider": "AWS IoT SiteWise",
  "status": "ok",
  "input_id": "sample-001",
  "data": {
    "asset_id": "example-machine",
    "property_id": "example-temperature",
    "values": [
      {
        "value": 24,
        "unit": "C",
        "timestamp": "2026-10-08T00:00:00Z",
        "quality": "example-good"
      }
    ],
    "freshness_verified": false
  },
  "error": null,
  "verification": "illustrative-only;not-provider-response"
}

Download specification, example and acceptance plan

Engineering handoff — our proposed contract and gates
Result interpretation	Successful transport or execution does not establish model accuracy. Preserve valid empty results separately from operational failure.
Reproducibility	Record model, runtime, configuration and input identifiers; agree quality and latency criteria before representative tests. No measured performance is claimed.
Operation boundary	Illustrative asset telemetry read envelope; not native SiteWise API JSON. No telemetry was uploaded, asset created or API called.

Development assessment

Machine asset data view

Development concept · integration not tested

Provider capabilities above are based on official documentation or repositories. The proposed product, inputs, deliverable and acceptance criteria below are our development assessment.

Integration pilot

Validate runtime, schemas or hardware together before estimating a deployable product.

Proposed inputs: A test device or simulator, a tag map and documented units.
Proposed deliverable: Timestamped device values with freshness, unit and connection state.
Acceptance criterion: Verify scaling and timestamps against the source; a disconnected device must not appear healthy.
Dependencies: A gateway or service account, an equipment schema and access to a test environment.

Development sequence

Confirm access to AWS IoT SiteWise API, license and the exact supported version.
Prepare the sample above and implement one documented operation for “Machine asset data view”.
Normalize the result with source, time and explicit error state; keep the provider response for review.
Run the acceptance criterion before estimating rollout effort or committing a customer deliverable.

How to validate demand

Record product views, documentation clicks, specification downloads and contextual hub clicks. These are event counts, not unique people or completed integrations.

This feasibility assessment uses implementation conditions. No traffic-based rank or delivery-time promise is assigned.

AWS IoT SiteWise API

Choose an interface. Define a verifiable result.

Company / project overview

Top 10 technical entry points

Reference analysis

Official API reference

Expected results before implementation

Property values returned

No history in range

Partial ingestion rejection

Asset not ready

Stale or poor-quality value

Map the expected result to your application

Machine asset data view

Development sequence

How to validate demand

Related products