How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon IoT SiteWise Asset Models API

The Asset Models API from Amazon IoT SiteWise — 3 operation(s) for asset models.

Amazon IoT SiteWise Asset Models API is one of 16 APIs that Amazon IoT SiteWise publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Asset Models. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.

This API exposes 6 operations across 3 paths, and defines 66 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://iotsitewise.{region}.amazonaws.com, https://iotsitewise.{region}.amazonaws.com, http://iotsitewise.{region}.amazonaws.com.cn, https://iotsitewise.{region}.amazonaws.com.cn.

6 operations 3 paths 66 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://iotsitewise.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon IoT SiteWise Asset Models API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Asset Models 6
POST
/asset-models
Amazon IoT SiteWise Create Asset Model
CreateAssetModel 7 params body → 202480481482483484485486
GET
/asset-models
Amazon IoT SiteWise List Asset Models
ListAssetModels 9 params → 200480481482
DELETE
/asset-models/{assetModelId}
Amazon IoT SiteWise Delete Asset Model
DeleteAssetModel 9 params → 202480481482483484
GET
/asset-models/{assetModelId}
Amazon IoT SiteWise Describe Asset Model
DescribeAssetModel 9 params → 200480481482483
PUT
/asset-models/{assetModelId}
Amazon IoT SiteWise Update Asset Model
UpdateAssetModel 8 params body → 202480481482483484485486
GET
/asset-models/{assetModelId}/properties
Amazon IoT SiteWise List Asset Model Properties
ListAssetModelProperties 11 params → 200480481482483

Schemas 66

The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are DescribeAssetModelResponse (10 properties), AssetModelSummary (7 properties), AssetModelPropertySummary (7 properties), AssetModelProperty (6 properties). Each schema is shown below with its type and property counts.

VariableValue
object
Identifies a property value used in an expression.
2 properties 1 required
ForwardingConfigState
string
NextToken
string
DetailedErrors
array
AssetModelCompositeModel
object
Contains information about a composite model in an asset model. This object contains the asset property definitions that you define in the composite model.
5 properties 2 required
Timestamp
string
UpdateAssetModelResponse
object
1 property 1 required
ComputeLocation
string
AssetModelHierarchies
array
DeleteAssetModelResponse
object
1 property 1 required
Expression
string
DetailedErrorCode
string
AssetModelPropertyDefinition
object
Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
5 properties 3 required
Offset
string
Interval
string
TumblingWindow
object
Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time window. You can use this window in metrics to aggregate data…
2 properties 1 required
ForwardingConfig
object
The forwarding configuration for a given property.
1 property 1 required
Description
string
DetailedError
object
Contains detailed error information.
2 properties 2 required
AssetModelProperties
array
ListAssetModelsResponse
object
2 properties 1 required
AssetModelSummary
object
Contains a summary of an asset model.
7 properties 7 required
AssetModelPropertySummaries
array
AssetModelSummaries
array
InternalFailureException
VariableName
string
Measurement
object
Contains an asset measurement property. For more information, see Measurements in the IoT SiteWise User Guide .
1 property
Metric
object
Contains an asset metric property. With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expres…
4 properties 3 required
TransformProcessingConfig
object
The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Clou…
2 properties 1 required
MetricProcessingConfig
object
The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By defaul…
1 property 1 required
ListAssetModelPropertiesResponse
object
2 properties 1 required
DetailedErrorMessage
string
DescribeAssetModelResponse
object
10 properties 9 required
ID
string
ConflictingOperationException
AssetModelStatus
object
Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide .
2 properties 1 required
ErrorCode
string
ThrottlingException
DefaultValue
string
Transform
object
Contains an asset transform property. A transform is a one-to-one mapping of a property's data points from one form to another. For example, you can use a tran…
3 properties 2 required
ResourceNotFoundException
InvalidRequestException
PropertyDataType
string
ARN
string
ExpressionVariables
array
ErrorMessage
string
PropertyType
object
Contains a property type, which can be one of attribute , measurement , metric , or transform .
4 properties
AssetModelHierarchyDefinition
object
Contains an asset model hierarchy used in asset model creation. An asset model hierarchy determines the kind (or type) of asset that can belong to a hierarchy.
2 properties 2 required
TagValue
string
Macro
string
ExpressionVariable
object
Contains expression variable information.
2 properties 2 required
CreateAssetModelResponse
object
3 properties 3 required
AssetModelState
string
AssetModelCompositeModelDefinition
object
Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.
4 properties 2 required
Attribute
object
Contains an asset attribute property. For more information, see Attributes in the IoT SiteWise User Guide .
1 property
MeasurementProcessingConfig
object
The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services…
1 property 1 required
AssetModelCompositeModels
array
AssetModelProperty
object
Contains information about an asset model property.
6 properties 3 required
Name
string
LimitExceededException
ResourceAlreadyExistsException
PropertyUnit
string
ErrorDetails
object
Contains the details of an IoT SiteWise error.
3 properties 2 required
AssetModelPropertySummary
object
Contains a summary of a property associated with a model.
7 properties 3 required
MetricWindow
object
Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).
1 property
AssetModelHierarchy
object
Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-iot-sitewise-asset-models-api-openapi.yml Raw ↑

Other APIs Amazon IoT SiteWise publishes across the network.

Amazon IoT SiteWise Access Policies API
Amazon IoT SiteWise Assets API
Amazon IoT SiteWise Configuration API
Amazon IoT SiteWise Dashboards API
Amazon IoT SiteWise Dashboards#projectId API
Amazon IoT SiteWise Gateways API
Amazon IoT SiteWise Jobs API
Amazon IoT SiteWise Logging API
Amazon IoT SiteWise Portals API
Amazon IoT SiteWise Projects API
Amazon IoT SiteWise Projects#portalId API
Amazon IoT SiteWise Properties API
Where this information came from

This is an independent, third-party profile of Amazon IoT SiteWise Asset Models API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.