Amazon IoT SiteWise Properties 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 Properties. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.
This API exposes
8 operations
across 8 paths,
and defines 79 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.
The identity and technical contract details declared by the specification.
AssetPropertyValueHistory
array
BatchGetAssetPropertyValueSkippedEntry
object
Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValue request.
3 properties
2 required
BatchPutAssetPropertyErrors
array
BatchGetAssetPropertyAggregatesSkippedEntries
array
PropertyValueStringValue
string
BatchGetAssetPropertyValueHistoryEntry
object
Contains information for an asset property historical value entry that is associated with the BatchGetAssetPropertyValueHistory API. To identify an asset prope…
8 properties
1 required
BatchGetAssetPropertyAggregatesResponse
object
4 properties
3 required
ResourceNotFoundException
Aggregates
object
Contains the (pre-calculated) aggregate values for an asset property.
6 properties
Variant
object
Contains an asset property value (of a single type only).
4 properties
BatchGetAssetPropertyAggregatesSkippedEntry
object
Contains information for an entry that has been processed by the previous BatchGetAssetPropertyAggregates request.
3 properties
2 required
BatchPutAssetPropertyError
object
Contains error information from updating a batch of asset property values.
3 properties
3 required
InterpolatedAssetPropertyValues
array
BatchGetAssetPropertyValueHistoryResponse
object
4 properties
3 required
BatchGetAssetPropertyValueErrorCode
string
InterpolatedAssetPropertyValue
object
Contains information about an interpolated asset property value.
2 properties
2 required
BatchGetAssetPropertyAggregatesErrorInfo
object
Contains the error code and the timestamp for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
2 properties
2 required
AssetPropertyValue
object
Contains asset property value information.
3 properties
2 required
BatchGetAssetPropertyAggregatesEntry
object
Contains information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API. To identify an asset property, you…
10 properties
5 required
BatchGetAssetPropertyValueHistorySuccessEntry
object
Contains success information for an entry that is associated with the BatchGetAssetPropertyValueHistory API.
2 properties
2 required
GetInterpolatedAssetPropertyValuesResponse
object
2 properties
1 required
BatchGetAssetPropertyValueSuccessEntries
array
AssetPropertyAlias
string
BatchGetAssetPropertyValueHistoryErrorCode
string
BatchGetAssetPropertyAggregatesErrorEntries
array
PropertyValueIntegerValue
integer
BatchGetAssetPropertyValueHistorySkippedEntries
array
GetAssetPropertyValueResponse
object
1 property
GetAssetPropertyAggregatesResponse
object
2 properties
1 required
BatchGetAssetPropertyValueHistoryErrorInfo
object
The error information, such as the error code and the timestamp.
2 properties
2 required
PropertyValueDoubleValue
number
BatchGetAssetPropertyValueEntry
object
Contains information for an asset property value entry that is associated with the BatchGetAssetPropertyValue API. To identify an asset property, you must spec…
4 properties
1 required
BatchEntryCompletionStatus
string
BatchPutAssetPropertyErrorEntry
object
Contains error information for asset property value entries that are associated with the BatchPutAssetPropertyValue API.
2 properties
2 required
AggregatedDoubleValue
number
AssetPropertyValues
array
PutAssetPropertyValueEntry
object
Contains a list of value updates for an asset property in the list of asset entries consumed by the BatchPutAssetPropertyValue API operation.
5 properties
2 required
BatchGetAssetPropertyValueErrorEntry
object
Contains error information for an asset property value entry that is associated with the BatchGetAssetPropertyValue API.
3 properties
3 required
BatchGetAssetPropertyAggregatesErrorEntry
object
Contains error information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
3 properties
3 required
BatchGetAssetPropertyAggregatesErrorCode
string
BatchGetAssetPropertyValueHistoryErrorEntry
object
A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.
3 properties
3 required
ServiceUnavailableException
BatchPutAssetPropertyValueResponse
object
1 property
1 required
BatchGetAssetPropertyValueResponse
object
4 properties
3 required
BatchPutAssetPropertyValueErrorCode
string
TimeInNanos
object
Contains a timestamp with optional nanosecond granularity.
2 properties
1 required
BatchPutAssetPropertyErrorEntries
array
BatchGetAssetPropertyValueErrorInfo
object
The error information, such as the error code and the timestamp.
2 properties
2 required
BatchGetAssetPropertyValueSkippedEntries
array
BatchGetAssetPropertyValueSuccessEntry
object
Contains success information for an entry that is associated with the BatchGetAssetPropertyValue API.
2 properties
1 required
PropertyValueBooleanValue
boolean
AggregatedValue
object
Contains aggregated asset property values (for example, average, minimum, and maximum).
3 properties
2 required
BatchGetAssetPropertyValueHistoryErrorEntries
array
ConflictingOperationException
BatchGetAssetPropertyAggregatesSuccessEntries
array
BatchGetAssetPropertyValueErrorEntries
array
BatchGetAssetPropertyAggregatesSuccessEntry
object
Contains success information for an entry that is associated with the BatchGetAssetPropertyAggregates API.
2 properties
2 required
GetAssetPropertyValueHistoryResponse
object
2 properties
1 required
BatchGetAssetPropertyValueHistorySkippedEntry
object
Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValueHistory request.
3 properties
2 required
BatchGetAssetPropertyValueHistorySuccessEntries
array
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Amazon IoT SiteWise publishes across the network.
