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 Assets API

The Assets API from Amazon IoT SiteWise — 8 operation(s) for assets.

Amazon IoT SiteWise Assets 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 Assets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.

This API exposes 12 operations across 8 paths, and defines 78 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.

12 operations 8 paths 78 schemas 1 DELETE6 GET3 POST2 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 Assets 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 12

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

Assets 12
POST
/assets/{assetId}/associate
Amazon IoT SiteWise Associate Assets
AssociateAssets 8 params body → 200480481482483484485486
POST
/assets
Amazon IoT SiteWise Create Asset
CreateAsset 7 params body → 202480481482483484485486
GET
/assets
Amazon IoT SiteWise List Assets
ListAssets 11 params → 200480481482483
DELETE
/assets/{assetId}
Amazon IoT SiteWise Delete Asset
DeleteAsset 9 params → 202480481482483484
GET
/assets/{assetId}
Amazon IoT SiteWise Describe Asset
DescribeAsset 9 params → 200480481482483
PUT
/assets/{assetId}
Amazon IoT SiteWise Update Asset
UpdateAsset 8 params body → 202480481482483484485
GET
/assets/{assetId}/properties/{propertyId}
Amazon IoT SiteWise Describe Asset Property
DescribeAssetProperty 9 params → 200480481482483
PUT
/assets/{assetId}/properties/{propertyId}
Amazon IoT SiteWise Update Asset Property
UpdateAssetProperty 9 params body → 200480481482483484
POST
/assets/{assetId}/disassociate
Amazon IoT SiteWise Disassociate Assets
DisassociateAssets 8 params body → 200480481482483484
GET
/assets/{assetId}/properties
Amazon IoT SiteWise List Asset Properties
ListAssetProperties 11 params → 200480481482483
GET
/assets/{assetId}/assetRelationships#traversalType
Amazon IoT SiteWise List Asset Relationships
ListAssetRelationships 11 params → 200480481482483
GET
/assets/{assetId}/hierarchies
Amazon IoT SiteWise List Associated Assets
ListAssociatedAssets 12 params → 200480481482483

Schemas 78

The contract defines 78 schemas that model the data the API accepts and returns. The most detailed are DescribeAssetResponse (11 properties), AssociatedAssetsSummary (9 properties), AssetSummary (9 properties), AssetProperty (7 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
ComputeLocation
string
PropertyNotificationTopic
string
DeleteAssetResponse
object
1 property 1 required
InternalFailureException
VariableName
string
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
ListAssetsResponse
object
2 properties 1 required
ResourceNotFoundException
ID
string
ThrottlingException
DefaultValue
string
AssetProperty
object
Contains asset property information.
7 properties 3 required
AssetHierarchyInfo
object
Contains information about a parent asset and a child asset that are related through an asset hierarchy.
2 properties
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
ResourceAlreadyExistsException
PropertyUnit
string
Timestamp
string
Expression
string
ListAssetRelationshipsResponse
object
2 properties 1 required
PropertyNotificationState
string
Measurement
object
Contains an asset measurement property. For more information, see Measurements in the IoT SiteWise User Guide .
1 property
AssetRelationshipSummaries
array
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
DetailedErrorMessage
string
PropertyNotification
object
Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT…
2 properties 2 required
AssetHierarchy
object
Describes an asset hierarchy that contains a hierarchy's name and ID.
2 properties 1 required
InvalidRequestException
UpdateAssetResponse
object
1 property 1 required
AssetSummary
object
Contains a summary of an asset.
9 properties 8 required
TagValue
string
AssetPropertySummary
object
Contains a summary of a property associated with an asset.
5 properties
LimitExceededException
AssetSummaries
array
NextToken
string
DetailedErrors
array
AssociatedAssetsSummary
object
Contains a summary of an associated asset.
9 properties 8 required
AssetPropertySummaries
array
CompositeModelProperty
object
Contains information about a composite model property on an asset.
4 properties 3 required
AssetRelationshipType
string
DescribeAssetPropertyResponse
object
5 properties 3 required
Offset
string
AssetCompositeModel
object
Contains information about a composite model in an asset. This object contains the asset's properties that you define in the composite model.
5 properties 3 required
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
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
ExpressionVariable
object
Contains expression variable information.
2 properties 2 required
Name
string
AssetRelationshipSummary
object
Contains information about assets that are related to one another.
2 properties 1 required
AssetHierarchies
array
ListAssociatedAssetsResponse
object
2 properties 1 required
AssetStatus
object
Contains information about the current status of an asset. For more information, see Asset and model states in the IoT SiteWise User Guide .
2 properties 1 required
AssetState
string
DetailedErrorCode
string
Interval
string
DetailedError
object
Contains detailed error information.
2 properties 2 required
Description
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
AssociatedAssetsSummaries
array
AssetProperties
array
CreateAssetResponse
object
3 properties 3 required
ConflictingOperationException
ErrorCode
string
ListAssetPropertiesResponse
object
2 properties 1 required
AssetCompositeModels
array
Macro
string
Attribute
object
Contains an asset attribute property. For more information, see Attributes in the IoT SiteWise User Guide .
1 property
DescribeAssetResponse
object
11 properties 9 required
PropertyAlias
string
ErrorDetails
object
Contains the details of an IoT SiteWise error.
3 properties 2 required
MetricWindow
object
Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).
1 property
Property
object
Contains asset property information.
7 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-iot-sitewise-assets-api-openapi.yml Raw ↑

Other APIs Amazon IoT SiteWise publishes across the network.

Amazon IoT SiteWise Access Policies API
Amazon IoT SiteWise Asset Models 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 Assets 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.