2025/08/04 - AWS IoT SiteWise - 4 new4 updated api methods
Changes Support Interface for IoT SiteWise Asset Modeling
Creates or updates an interface relationship between an asset model and an interface asset model. This operation applies an interface to an asset model.
See also: AWS API Documentation
Request Syntax
client.put_asset_model_interface_relationship( assetModelId='string', interfaceAssetModelId='string', propertyMappingConfiguration={ 'matchByPropertyName': True|False, 'createMissingProperty': True|False, 'overrides': [ { 'assetModelPropertyId': 'string', 'interfaceAssetModelPropertyId': 'string' }, ] }, clientToken='string' )
string
[REQUIRED]
The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
string
[REQUIRED]
The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
dict
[REQUIRED]
The configuration for mapping properties from the interface asset model to the asset model where the interface is applied. This configuration controls how properties are matched and created during the interface application process.
matchByPropertyName (boolean) --
If true, properties are matched by name between the interface asset model and the asset model where the interface is applied.
createMissingProperty (boolean) --
If true, missing properties from the interface asset model are automatically created in the asset model where the interface is applied.
overrides (list) --
A list of specific property mappings that override the automatic mapping by name when an interface is applied to an asset model.
(dict) --
Maps a property from an interface asset model to a property in the asset model where the interface is applied.
assetModelPropertyId (string) -- [REQUIRED]
The ID of the property in the asset model where the interface is applied.
interfaceAssetModelPropertyId (string) -- [REQUIRED]
The ID of the property in the interface asset model.
string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{ 'assetModelId': 'string', 'interfaceAssetModelId': 'string', 'assetModelArn': 'string', 'assetModelStatus': { 'state': 'CREATING'|'ACTIVE'|'UPDATING'|'PROPAGATING'|'DELETING'|'FAILED', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE', 'message': 'string', 'details': [ { 'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message': 'string' }, ] } } }
Response Structure
(dict) --
assetModelId (string) --
The ID of the asset model.
interfaceAssetModelId (string) --
The ID of the interface asset model.
assetModelArn (string) --
The ARN of the asset model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
assetModelStatus (dict) --
Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide.
state (string) --
The current state of the asset model.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
details (list) --
A list of detailed errors.
(dict) --
Contains detailed error information.
code (string) --
The error code.
message (string) --
The error message.
Deletes an interface relationship between an asset model and an interface asset model.
See also: AWS API Documentation
Request Syntax
client.delete_asset_model_interface_relationship( assetModelId='string', interfaceAssetModelId='string', clientToken='string' )
string
[REQUIRED]
The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
string
[REQUIRED]
The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
Response Syntax
{ 'assetModelId': 'string', 'interfaceAssetModelId': 'string', 'assetModelArn': 'string', 'assetModelStatus': { 'state': 'CREATING'|'ACTIVE'|'UPDATING'|'PROPAGATING'|'DELETING'|'FAILED', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE', 'message': 'string', 'details': [ { 'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message': 'string' }, ] } } }
Response Structure
(dict) --
assetModelId (string) --
The ID of the asset model.
interfaceAssetModelId (string) --
The ID of the interface asset model.
assetModelArn (string) --
The ARN of the asset model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
assetModelStatus (dict) --
Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide.
state (string) --
The current state of the asset model.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
details (list) --
A list of detailed errors.
(dict) --
Contains detailed error information.
code (string) --
The error code.
message (string) --
The error message.
Retrieves a paginated list of asset models that have a specific interface asset model applied to them.
See also: AWS API Documentation
Request Syntax
client.list_interface_relationships( interfaceAssetModelId='string', nextToken='string', maxResults=123 )
string
[REQUIRED]
The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
string
The token to be used for the next set of paginated results.
integer
The maximum number of results to return for each paginated request. Default: 50
dict
Response Syntax
{ 'interfaceRelationshipSummaries': [ { 'id': 'string' }, ], 'nextToken': 'string' }
Response Structure
(dict) --
interfaceRelationshipSummaries (list) --
A list that summarizes each interface relationship.
(dict) --
Contains summary information about an interface relationship, which defines how an interface is applied to an asset model. This summary provides the essential identifiers needed to retrieve detailed information about the relationship.
id (string) --
The ID of the asset model that has the interface applied to it.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Retrieves information about an interface relationship between an asset model and an interface asset model.
See also: AWS API Documentation
Request Syntax
client.describe_asset_model_interface_relationship( assetModelId='string', interfaceAssetModelId='string' )
string
[REQUIRED]
The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
string
[REQUIRED]
The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
dict
Response Syntax
{ 'assetModelId': 'string', 'interfaceAssetModelId': 'string', 'propertyMappings': [ { 'assetModelPropertyId': 'string', 'interfaceAssetModelPropertyId': 'string' }, ], 'hierarchyMappings': [ { 'assetModelHierarchyId': 'string', 'interfaceAssetModelHierarchyId': 'string' }, ] }
Response Structure
(dict) --
assetModelId (string) --
The ID of the asset model.
interfaceAssetModelId (string) --
The ID of the interface asset model.
propertyMappings (list) --
A list of property mappings between the interface asset model and the asset model where the interface is applied.
(dict) --
Maps a property from an interface asset model to a property in the asset model where the interface is applied.
assetModelPropertyId (string) --
The ID of the property in the asset model where the interface is applied.
interfaceAssetModelPropertyId (string) --
The ID of the property in the interface asset model.
hierarchyMappings (list) --
A list of hierarchy mappings between the interface asset model and the asset model where the interface is applied.
(dict) --
Maps a hierarchy from an interface asset model to a hierarchy in the asset model where the interface is applied.
assetModelHierarchyId (string) --
The ID of the hierarchy in the asset model where the interface is applied.
interfaceAssetModelHierarchyId (string) --
The ID of the hierarchy in the interface asset model.
{'assetModelType': {'INTERFACE'}}
Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.
You can create three types of asset models, ASSET_MODEL, COMPONENT_MODEL, or an INTERFACE.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
INTERFACE – An interface is a type of model that defines a standard structure that can be applied to different asset models.
See also: AWS API Documentation
Request Syntax
client.create_asset_model( assetModelName='string', assetModelType='ASSET_MODEL'|'COMPONENT_MODEL'|'INTERFACE', assetModelId='string', assetModelExternalId='string', assetModelDescription='string', assetModelProperties=[ { 'id': 'string', 'externalId': 'string', 'name': 'string', 'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT', 'dataTypeSpec': 'string', 'unit': 'string', 'type': { 'attribute': { 'defaultValue': 'string' }, 'measurement': { 'processingConfig': { 'forwardingConfig': { 'state': 'DISABLED'|'ENABLED' } } }, 'transform': { 'expression': 'string', 'variables': [ { 'name': 'string', 'value': { 'propertyId': 'string', 'hierarchyId': 'string', 'propertyPath': [ { 'id': 'string', 'name': 'string' }, ] } }, ], 'processingConfig': { 'computeLocation': 'EDGE'|'CLOUD', 'forwardingConfig': { 'state': 'DISABLED'|'ENABLED' } } }, 'metric': { 'expression': 'string', 'variables': [ { 'name': 'string', 'value': { 'propertyId': 'string', 'hierarchyId': 'string', 'propertyPath': [ { 'id': 'string', 'name': 'string' }, ] } }, ], 'window': { 'tumbling': { 'interval': 'string', 'offset': 'string' } }, 'processingConfig': { 'computeLocation': 'EDGE'|'CLOUD' } } } }, ], assetModelHierarchies=[ { 'id': 'string', 'externalId': 'string', 'name': 'string', 'childAssetModelId': 'string' }, ], assetModelCompositeModels=[ { 'id': 'string', 'externalId': 'string', 'name': 'string', 'description': 'string', 'type': 'string', 'properties': [ { 'id': 'string', 'externalId': 'string', 'name': 'string', 'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT', 'dataTypeSpec': 'string', 'unit': 'string', 'type': { 'attribute': { 'defaultValue': 'string' }, 'measurement': { 'processingConfig': { 'forwardingConfig': { 'state': 'DISABLED'|'ENABLED' } } }, 'transform': { 'expression': 'string', 'variables': [ { 'name': 'string', 'value': { 'propertyId': 'string', 'hierarchyId': 'string', 'propertyPath': [ { 'id': 'string', 'name': 'string' }, ] } }, ], 'processingConfig': { 'computeLocation': 'EDGE'|'CLOUD', 'forwardingConfig': { 'state': 'DISABLED'|'ENABLED' } } }, 'metric': { 'expression': 'string', 'variables': [ { 'name': 'string', 'value': { 'propertyId': 'string', 'hierarchyId': 'string', 'propertyPath': [ { 'id': 'string', 'name': 'string' }, ] } }, ], 'window': { 'tumbling': { 'interval': 'string', 'offset': 'string' } }, 'processingConfig': { 'computeLocation': 'EDGE'|'CLOUD' } } } }, ] }, ], clientToken='string', tags={ 'string': 'string' } )
string
[REQUIRED]
A unique name for the asset model.
string
The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
string
The ID to assign to the asset model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
string
An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.
string
A description for the asset model.
list
The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
(dict) --
Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
id (string) --
The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
externalId (string) --
An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) -- [REQUIRED]
The name of the property definition.
dataType (string) -- [REQUIRED]
The data type of the property definition.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
dataTypeSpec (string) --
The data type of the structure for this property. This parameter is required on properties that have the STRUCT data type.
The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models.
unit (string) --
The unit of the property definition, such as Newtons or RPM.
type (dict) -- [REQUIRED]
The property definition type (see PropertyType). You can only specify one type in a property definition.
attribute (dict) --
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
defaultValue (string) --
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide.
measurement (dict) --
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
processingConfig (dict) --
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 Cloud. By default, measurements are forwarded to the cloud.
forwardingConfig (dict) -- [REQUIRED]
The forwarding configuration for the given measurement property.
state (string) -- [REQUIRED]
The forwarding state for the given property.
transform (dict) --
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
expression (string) -- [REQUIRED]
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide.
variables (list) -- [REQUIRED]
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) -- [REQUIRED]
The friendly name of the variable to be used in the expression.
value (dict) -- [REQUIRED]
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
processingConfig (dict) --
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 Cloud. You can also configure transforms to be computed at the edge or in the cloud.
computeLocation (string) -- [REQUIRED]
The compute location for the given transform property.
forwardingConfig (dict) --
The forwarding configuration for a given property.
state (string) -- [REQUIRED]
The forwarding state for the given property.
metric (dict) --
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
expression (string) --
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide.
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) -- [REQUIRED]
The friendly name of the variable to be used in the expression.
value (dict) -- [REQUIRED]
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
window (dict) -- [REQUIRED]
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window.
tumbling (dict) --
The tumbling time interval window.
interval (string) -- [REQUIRED]
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
offset (string) --
The offset for the tumbling window. The offset parameter accepts the following:
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock. For example, if you specify 00:03:00 for offset, 5m for interval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
processingConfig (dict) --
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 default, metrics are forwarded to the cloud.
computeLocation (string) -- [REQUIRED]
The compute location for the given metric property.
list
The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.
(dict) --
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.
id (string) --
The ID to assign to the asset model hierarchy, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
externalId (string) --
An external ID to assign to the asset model hierarchy. The external ID must be unique among asset model hierarchies within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) -- [REQUIRED]
The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).
childAssetModelId (string) -- [REQUIRED]
The ID of an asset model for this hierarchy. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
list
The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.
(dict) --
Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.
id (string) --
The ID to assign to the composite model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
externalId (string) --
An external ID to assign to the composite model. The external ID must be unique among composite models within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) -- [REQUIRED]
The name of the composite model.
description (string) --
The description of the composite model.
type (string) -- [REQUIRED]
The type of the composite model. For alarm composite models, this type is AWS/ALARM.
properties (list) --
The asset property definitions for this composite model.
(dict) --
Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
id (string) --
The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
externalId (string) --
An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) -- [REQUIRED]
The name of the property definition.
dataType (string) -- [REQUIRED]
The data type of the property definition.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
dataTypeSpec (string) --
The data type of the structure for this property. This parameter is required on properties that have the STRUCT data type.
The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models.
unit (string) --
The unit of the property definition, such as Newtons or RPM.
type (dict) -- [REQUIRED]
The property definition type (see PropertyType). You can only specify one type in a property definition.
attribute (dict) --
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
defaultValue (string) --
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide.
measurement (dict) --
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
processingConfig (dict) --
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 Cloud. By default, measurements are forwarded to the cloud.
forwardingConfig (dict) -- [REQUIRED]
The forwarding configuration for the given measurement property.
state (string) -- [REQUIRED]
The forwarding state for the given property.
transform (dict) --
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
expression (string) -- [REQUIRED]
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide.
variables (list) -- [REQUIRED]
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) -- [REQUIRED]
The friendly name of the variable to be used in the expression.
value (dict) -- [REQUIRED]
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
processingConfig (dict) --
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 Cloud. You can also configure transforms to be computed at the edge or in the cloud.
computeLocation (string) -- [REQUIRED]
The compute location for the given transform property.
forwardingConfig (dict) --
The forwarding configuration for a given property.
state (string) -- [REQUIRED]
The forwarding state for the given property.
metric (dict) --
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
expression (string) --
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide.
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) -- [REQUIRED]
The friendly name of the variable to be used in the expression.
value (dict) -- [REQUIRED]
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
window (dict) -- [REQUIRED]
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window.
tumbling (dict) --
The tumbling time interval window.
interval (string) -- [REQUIRED]
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
offset (string) --
The offset for the tumbling window. The offset parameter accepts the following:
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock. For example, if you specify 00:03:00 for offset, 5m for interval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
processingConfig (dict) --
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 default, metrics are forwarded to the cloud.
computeLocation (string) -- [REQUIRED]
The compute location for the given metric property.
string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
This field is autopopulated if not provided.
dict
A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
(string) --
(string) --
dict
Response Syntax
{ 'assetModelId': 'string', 'assetModelArn': 'string', 'assetModelStatus': { 'state': 'CREATING'|'ACTIVE'|'UPDATING'|'PROPAGATING'|'DELETING'|'FAILED', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE', 'message': 'string', 'details': [ { 'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message': 'string' }, ] } } }
Response Structure
(dict) --
assetModelId (string) --
The ID of the asset model, in UUID format. You can use this ID when you call other IoT SiteWise API operations.
assetModelArn (string) --
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
assetModelStatus (dict) --
The status of the asset model, which contains a state ( CREATING after successfully calling this operation) and any error message.
state (string) --
The current state of the asset model.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
details (list) --
A list of detailed errors.
(dict) --
Contains detailed error information.
code (string) --
The error code.
message (string) --
The error message.
{'assetModelType': {'INTERFACE'}, 'interfaceDetails': [{'id': 'string'}]}
Retrieves information about an asset model. This includes details about the asset model's properties, hierarchies, composite models, and any interface relationships if the asset model implements interfaces.
See also: AWS API Documentation
Request Syntax
client.describe_asset_model( assetModelId='string', excludeProperties=True|False, assetModelVersion='string' )
string
[REQUIRED]
The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
boolean
Whether or not to exclude asset model properties from the response.
string
The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.
dict
Response Syntax
{ 'assetModelId': 'string', 'assetModelExternalId': 'string', 'assetModelArn': 'string', 'assetModelName': 'string', 'assetModelType': 'ASSET_MODEL'|'COMPONENT_MODEL'|'INTERFACE', 'assetModelDescription': 'string', 'assetModelProperties': [ { 'id': 'string', 'externalId': 'string', 'name': 'string', 'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT', 'dataTypeSpec': 'string', 'unit': 'string', 'type': { 'attribute': { 'defaultValue': 'string' }, 'measurement': { 'processingConfig': { 'forwardingConfig': { 'state': 'DISABLED'|'ENABLED' } } }, 'transform': { 'expression': 'string', 'variables': [ { 'name': 'string', 'value': { 'propertyId': 'string', 'hierarchyId': 'string', 'propertyPath': [ { 'id': 'string', 'name': 'string' }, ] } }, ], 'processingConfig': { 'computeLocation': 'EDGE'|'CLOUD', 'forwardingConfig': { 'state': 'DISABLED'|'ENABLED' } } }, 'metric': { 'expression': 'string', 'variables': [ { 'name': 'string', 'value': { 'propertyId': 'string', 'hierarchyId': 'string', 'propertyPath': [ { 'id': 'string', 'name': 'string' }, ] } }, ], 'window': { 'tumbling': { 'interval': 'string', 'offset': 'string' } }, 'processingConfig': { 'computeLocation': 'EDGE'|'CLOUD' } } }, 'path': [ { 'id': 'string', 'name': 'string' }, ] }, ], 'assetModelHierarchies': [ { 'id': 'string', 'externalId': 'string', 'name': 'string', 'childAssetModelId': 'string' }, ], 'assetModelCompositeModels': [ { 'name': 'string', 'description': 'string', 'type': 'string', 'properties': [ { 'id': 'string', 'externalId': 'string', 'name': 'string', 'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT', 'dataTypeSpec': 'string', 'unit': 'string', 'type': { 'attribute': { 'defaultValue': 'string' }, 'measurement': { 'processingConfig': { 'forwardingConfig': { 'state': 'DISABLED'|'ENABLED' } } }, 'transform': { 'expression': 'string', 'variables': [ { 'name': 'string', 'value': { 'propertyId': 'string', 'hierarchyId': 'string', 'propertyPath': [ { 'id': 'string', 'name': 'string' }, ] } }, ], 'processingConfig': { 'computeLocation': 'EDGE'|'CLOUD', 'forwardingConfig': { 'state': 'DISABLED'|'ENABLED' } } }, 'metric': { 'expression': 'string', 'variables': [ { 'name': 'string', 'value': { 'propertyId': 'string', 'hierarchyId': 'string', 'propertyPath': [ { 'id': 'string', 'name': 'string' }, ] } }, ], 'window': { 'tumbling': { 'interval': 'string', 'offset': 'string' } }, 'processingConfig': { 'computeLocation': 'EDGE'|'CLOUD' } } }, 'path': [ { 'id': 'string', 'name': 'string' }, ] }, ], 'id': 'string', 'externalId': 'string' }, ], 'assetModelCompositeModelSummaries': [ { 'id': 'string', 'externalId': 'string', 'name': 'string', 'type': 'string', 'description': 'string', 'path': [ { 'id': 'string', 'name': 'string' }, ] }, ], 'assetModelCreationDate': datetime(2015, 1, 1), 'assetModelLastUpdateDate': datetime(2015, 1, 1), 'assetModelStatus': { 'state': 'CREATING'|'ACTIVE'|'UPDATING'|'PROPAGATING'|'DELETING'|'FAILED', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE', 'message': 'string', 'details': [ { 'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message': 'string' }, ] } }, 'assetModelVersion': 'string', 'interfaceDetails': [ { 'id': 'string' }, ], 'eTag': 'string' }
Response Structure
(dict) --
assetModelId (string) --
The ID of the asset model, in UUID format.
assetModelExternalId (string) --
The external ID of the asset model, if any.
assetModelArn (string) --
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
assetModelName (string) --
The name of the asset model.
assetModelType (string) --
The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
assetModelDescription (string) --
The asset model's description.
assetModelProperties (list) --
The list of asset properties for the asset model.
This object doesn't include properties that you define in composite models. You can find composite model properties in the assetModelCompositeModels object.
(dict) --
Contains information about an asset model property.
id (string) --
The ID of the asset model property.
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
externalId (string) --
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) --
The name of the asset model property.
dataType (string) --
The data type of the asset model property.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
dataTypeSpec (string) --
The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
unit (string) --
The unit of the asset model property, such as Newtons or RPM.
type (dict) --
The property type (see PropertyType).
attribute (dict) --
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
defaultValue (string) --
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide.
measurement (dict) --
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
processingConfig (dict) --
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 Cloud. By default, measurements are forwarded to the cloud.
forwardingConfig (dict) --
The forwarding configuration for the given measurement property.
state (string) --
The forwarding state for the given property.
transform (dict) --
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
expression (string) --
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide.
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) --
The friendly name of the variable to be used in the expression.
value (dict) --
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
processingConfig (dict) --
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 Cloud. You can also configure transforms to be computed at the edge or in the cloud.
computeLocation (string) --
The compute location for the given transform property.
forwardingConfig (dict) --
The forwarding configuration for a given property.
state (string) --
The forwarding state for the given property.
metric (dict) --
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
expression (string) --
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide.
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) --
The friendly name of the variable to be used in the expression.
value (dict) --
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
window (dict) --
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window.
tumbling (dict) --
The tumbling time interval window.
interval (string) --
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
offset (string) --
The offset for the tumbling window. The offset parameter accepts the following:
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock. For example, if you specify 00:03:00 for offset, 5m for interval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
processingConfig (dict) --
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 default, metrics are forwarded to the cloud.
computeLocation (string) --
The compute location for the given metric property.
path (list) --
The structured path to the property from the root of the asset model.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
assetModelHierarchies (list) --
A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.
(dict) --
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.
id (string) --
The ID of the asset model hierarchy. This ID is a hierarchyId.
If you are callling UpdateAssetModel to create a new hierarchy: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
If you are calling UpdateAssetModel to modify an existing hierarchy: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
externalId (string) --
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) --
The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
childAssetModelId (string) --
The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the childAssetModelId asset model. IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to UpdateAssetModel, you may provide either the asset model ID or else externalId: followed by the asset model's external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
assetModelCompositeModels (list) --
The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.
(dict) --
Contains information about a composite model in an asset model. This object contains the asset property definitions that you define in the composite model.
name (string) --
The name of the composite model.
description (string) --
The description of the composite model.
type (string) --
The type of the composite model. For alarm composite models, this type is AWS/ALARM.
properties (list) --
The asset property definitions for this composite model.
(dict) --
Contains information about an asset model property.
id (string) --
The ID of the asset model property.
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
externalId (string) --
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) --
The name of the asset model property.
dataType (string) --
The data type of the asset model property.
If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
dataTypeSpec (string) --
The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
unit (string) --
The unit of the asset model property, such as Newtons or RPM.
type (dict) --
The property type (see PropertyType).
attribute (dict) --
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
defaultValue (string) --
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide.
measurement (dict) --
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
processingConfig (dict) --
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 Cloud. By default, measurements are forwarded to the cloud.
forwardingConfig (dict) --
The forwarding configuration for the given measurement property.
state (string) --
The forwarding state for the given property.
transform (dict) --
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
expression (string) --
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide.
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) --
The friendly name of the variable to be used in the expression.
value (dict) --
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
processingConfig (dict) --
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 Cloud. You can also configure transforms to be computed at the edge or in the cloud.
computeLocation (string) --
The compute location for the given transform property.
forwardingConfig (dict) --
The forwarding configuration for a given property.
state (string) --
The forwarding state for the given property.
metric (dict) --
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
expression (string) --
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide.
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) --
The friendly name of the variable to be used in the expression.
value (dict) --
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
window (dict) --
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window.
tumbling (dict) --
The tumbling time interval window.
interval (string) --
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
offset (string) --
The offset for the tumbling window. The offset parameter accepts the following:
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock. For example, if you specify 00:03:00 for offset, 5m for interval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
processingConfig (dict) --
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 default, metrics are forwarded to the cloud.
computeLocation (string) --
The compute location for the given metric property.
path (list) --
The structured path to the property from the root of the asset model.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
id (string) --
The ID of the asset model composite model.
externalId (string) --
The external ID of the asset model composite model. For more information, see Using external IDs in the IoT SiteWise User Guide.
assetModelCompositeModelSummaries (list) --
The list of the immediate child custom composite model summaries for the asset model.
(dict) --
Contains a summary of the composite model.
id (string) --
The ID of the composite model that this summary describes..
externalId (string) --
The external ID of a composite model on this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) --
The name of the composite model that this summary describes..
type (string) --
The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
description (string) --
The description of the composite model that this summary describes..
path (list) --
The path that includes all the pieces that make up the composite model.
(dict) --
Represents one level between a composite model and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
assetModelCreationDate (datetime) --
The date the asset model was created, in Unix epoch time.
assetModelLastUpdateDate (datetime) --
The date the asset model was last updated, in Unix epoch time.
assetModelStatus (dict) --
The current status of the asset model, which contains a state and any error message.
state (string) --
The current state of the asset model.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
details (list) --
A list of detailed errors.
(dict) --
Contains detailed error information.
code (string) --
The error code.
message (string) --
The error message.
assetModelVersion (string) --
The version of the asset model. See Asset model versions in the IoT SiteWise User Guide.
interfaceDetails (list) --
A list of interface details that describe the interfaces implemented by this asset model, including interface asset model IDs and property mappings.
(dict) --
Contains information about the relationship between an asset model and an interface asset model that is applied to it.
id (string) --
The ID of the asset model that has the interface applied to it.
eTag (string) --
The entity tag (ETag) is a hash of the retrieved version of the asset model. It's used to make concurrent updates safely to the resource. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
{'assetModelPropertySummaries': {'interfaceSummaries': [{'interfaceAssetModelId': 'string', 'interfaceAssetModelPropertyId': 'string'}]}}
Retrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.
See also: AWS API Documentation
Request Syntax
client.list_asset_model_properties( assetModelId='string', nextToken='string', maxResults=123, filter='ALL'|'BASE', assetModelVersion='string' )
string
[REQUIRED]
The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
string
The token to be used for the next set of paginated results.
integer
The maximum number of results to return for each paginated request. If not specified, the default value is 50.
string
Filters the requested list of asset model properties. You can choose one of the following options:
ALL – The list includes all asset model properties for a given asset model ID.
BASE – The list includes only base asset model properties for a given asset model ID.
Default: BASE
string
The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.
dict
Response Syntax
{ 'assetModelPropertySummaries': [ { 'id': 'string', 'externalId': 'string', 'name': 'string', 'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT', 'dataTypeSpec': 'string', 'unit': 'string', 'type': { 'attribute': { 'defaultValue': 'string' }, 'measurement': { 'processingConfig': { 'forwardingConfig': { 'state': 'DISABLED'|'ENABLED' } } }, 'transform': { 'expression': 'string', 'variables': [ { 'name': 'string', 'value': { 'propertyId': 'string', 'hierarchyId': 'string', 'propertyPath': [ { 'id': 'string', 'name': 'string' }, ] } }, ], 'processingConfig': { 'computeLocation': 'EDGE'|'CLOUD', 'forwardingConfig': { 'state': 'DISABLED'|'ENABLED' } } }, 'metric': { 'expression': 'string', 'variables': [ { 'name': 'string', 'value': { 'propertyId': 'string', 'hierarchyId': 'string', 'propertyPath': [ { 'id': 'string', 'name': 'string' }, ] } }, ], 'window': { 'tumbling': { 'interval': 'string', 'offset': 'string' } }, 'processingConfig': { 'computeLocation': 'EDGE'|'CLOUD' } } }, 'assetModelCompositeModelId': 'string', 'path': [ { 'id': 'string', 'name': 'string' }, ], 'interfaceSummaries': [ { 'interfaceAssetModelId': 'string', 'interfaceAssetModelPropertyId': 'string' }, ] }, ], 'nextToken': 'string' }
Response Structure
(dict) --
assetModelPropertySummaries (list) --
A list that summarizes the properties associated with the specified asset model.
(dict) --
Contains a summary of a property associated with a model. This includes information about which interfaces the property belongs to, if any.
id (string) --
The ID of the property.
externalId (string) --
The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) --
The name of the property.
dataType (string) --
The data type of the property.
dataTypeSpec (string) --
The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.
unit (string) --
The unit (such as Newtons or RPM) of the property.
type (dict) --
Contains a property type, which can be one of attribute, measurement, metric, or transform.
attribute (dict) --
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
defaultValue (string) --
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide.
measurement (dict) --
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
processingConfig (dict) --
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 Cloud. By default, measurements are forwarded to the cloud.
forwardingConfig (dict) --
The forwarding configuration for the given measurement property.
state (string) --
The forwarding state for the given property.
transform (dict) --
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
expression (string) --
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide.
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) --
The friendly name of the variable to be used in the expression.
value (dict) --
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
processingConfig (dict) --
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 Cloud. You can also configure transforms to be computed at the edge or in the cloud.
computeLocation (string) --
The compute location for the given transform property.
forwardingConfig (dict) --
The forwarding configuration for a given property.
state (string) --
The forwarding state for the given property.
metric (dict) --
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
expression (string) --
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the IoT SiteWise User Guide.
variables (list) --
The list of variables used in the expression.
(dict) --
Contains expression variable information.
name (string) --
The friendly name of the variable to be used in the expression.
value (dict) --
The variable that identifies an asset property from which to use values.
propertyId (string) --
The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
hierarchyId (string) --
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
propertyPath (list) --
The path of the property.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
window (dict) --
The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window.
tumbling (dict) --
The tumbling time interval window.
interval (string) --
The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
offset (string) --
The offset for the tumbling window. The offset parameter accepts the following:
The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
The 24-hour clock. For example, if you specify 00:03:00 for offset, 5m for interval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).
The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
processingConfig (dict) --
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 default, metrics are forwarded to the cloud.
computeLocation (string) --
The compute location for the given metric property.
assetModelCompositeModelId (string) --
The ID of the composite model that contains the asset model property.
path (list) --
The structured path to the property from the root of the asset model.
(dict) --
Represents one level between a property and the root of the asset model.
id (string) --
The ID of the path segment.
name (string) --
The name of the path segment.
interfaceSummaries (list) --
A list of interface summaries that describe which interfaces this property belongs to, including the interface asset model ID and the corresponding property ID in the interface.
(dict) --
Contains summary information about an interface that a property belongs to.
interfaceAssetModelId (string) --
The ID of the interface asset model that contains this property.
interfaceAssetModelPropertyId (string) --
The ID of the property in the interface asset model that corresponds to this property.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
{'assetModelTypes': {'INTERFACE'}}Response
{'assetModelSummaries': {'assetModelType': {'INTERFACE'}}}
Retrieves a paginated list of summaries of all asset models.
See also: AWS API Documentation
Request Syntax
client.list_asset_models( assetModelTypes=[ 'ASSET_MODEL'|'COMPONENT_MODEL'|'INTERFACE', ], nextToken='string', maxResults=123, assetModelVersion='string' )
list
The type of asset model. If you don't provide an assetModelTypes, all types of asset models are returned.
ASSET_MODEL – An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
INTERFACE – An interface is a type of model that defines a standard structure that can be applied to different asset models.
(string) --
string
The token to be used for the next set of paginated results.
integer
The maximum number of results to return for each paginated request.
Default: 50
string
The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.
dict
Response Syntax
{ 'assetModelSummaries': [ { 'id': 'string', 'externalId': 'string', 'arn': 'string', 'name': 'string', 'assetModelType': 'ASSET_MODEL'|'COMPONENT_MODEL'|'INTERFACE', 'description': 'string', 'creationDate': datetime(2015, 1, 1), 'lastUpdateDate': datetime(2015, 1, 1), 'status': { 'state': 'CREATING'|'ACTIVE'|'UPDATING'|'PROPAGATING'|'DELETING'|'FAILED', 'error': { 'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE', 'message': 'string', 'details': [ { 'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message': 'string' }, ] } }, 'version': 'string' }, ], 'nextToken': 'string' }
Response Structure
(dict) --
assetModelSummaries (list) --
A list that summarizes each asset model.
(dict) --
Contains a summary of an asset model.
id (string) --
The ID of the asset model (used with IoT SiteWise API operations).
externalId (string) --
The external ID of the asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
arn (string) --
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
name (string) --
The name of the asset model.
assetModelType (string) --
The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
description (string) --
The asset model description.
creationDate (datetime) --
The date the asset model was created, in Unix epoch time.
lastUpdateDate (datetime) --
The date the asset model was last updated, in Unix epoch time.
status (dict) --
The current status of the asset model.
state (string) --
The current state of the asset model.
error (dict) --
Contains associated error information, if any.
code (string) --
The error code.
message (string) --
The error message.
details (list) --
A list of detailed errors.
(dict) --
Contains detailed error information.
code (string) --
The error code.
message (string) --
The error message.
version (string) --
The version number of the asset model.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.