[ aws . iotsitewise ]
create-asset-model¶
Description¶
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 .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
create-asset-model
--asset-model-name <value>
[--asset-model-description <value>]
[--asset-model-properties <value>]
[--asset-model-hierarchies <value>]
[--asset-model-composite-models <value>]
[--client-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--asset-model-name (string)
A unique, friendly name for the asset model.
--asset-model-description (string)
A description for the asset model.
--asset-model-properties (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 .
(structure)
Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
name -> (string)
The name of the property definition.
dataType -> (string)
The data type of the property definition.
If you specify
STRUCT, you must also specifydataTypeSpecto 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
STRUCTdata type.The options for this parameter depend on the type of the composite model in which you define this property. Use
AWS/ALARM_STATEfor alarm state in alarm composite models.unit -> (string)
The unit of the property definition, such as
NewtonsorRPM.type -> (structure)
The property definition type (see
PropertyType). You can only specify one type in a property definition.attribute -> (structure)
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 -> (structure)
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 -> (structure)
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 -> (structure)
The forwarding configuration for the given measurement property.
state -> (string)
The forwarding state for the given property.
transform -> (structure)
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.
(structure)
Contains expression variable information.
name -> (string)
The friendly name of the variable to be used in the expression.
value -> (structure)
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
nameif it’s from the same asset model.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.
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 .processingConfig -> (structure)
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 -> (structure)
The forwarding configuration for a given property.
state -> (string)
The forwarding state for the given property.
metric -> (structure)
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.
(structure)
Contains expression variable information.
name -> (string)
The friendly name of the variable to be used in the expression.
value -> (structure)
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
nameif it’s from the same asset model.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.
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 .window -> (structure)
The window (time interval) over which IoT SiteWise computes the metric’s aggregation expression. IoT SiteWise computes one data point per
window.tumbling -> (structure)
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
1winterval the end of Sunday at midnight each week (UTC), the1dinterval at the end of each day at midnight (UTC), the1hinterval 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
offsetparameter accepts the following:
The offset time. For example, if you specify
18hforoffsetand1dforinterval, 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
PT18Hforoffsetand1dforinterval, 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:00foroffset,5mforinterval, 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-08foroffsetand1dforinterval, 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 -> (structure)
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.
JSON Syntax:
[
{
"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"
}
}
...
],
"processingConfig": {
"computeLocation": "EDGE"|"CLOUD",
"forwardingConfig": {
"state": "DISABLED"|"ENABLED"
}
}
},
"metric": {
"expression": "string",
"variables": [
{
"name": "string",
"value": {
"propertyId": "string",
"hierarchyId": "string"
}
}
...
],
"window": {
"tumbling": {
"interval": "string",
"offset": "string"
}
},
"processingConfig": {
"computeLocation": "EDGE"|"CLOUD"
}
}
}
}
...
]
--asset-model-hierarchies (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 .
(structure)
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.
name -> (string)
The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).
childAssetModelId -> (string)
The ID of an asset model for this hierarchy.
Shorthand Syntax:
name=string,childAssetModelId=string ...
JSON Syntax:
[
{
"name": "string",
"childAssetModelId": "string"
}
...
]
--asset-model-composite-models (list)
The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.
(structure)
Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset 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.
(structure)
Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
name -> (string)
The name of the property definition.
dataType -> (string)
The data type of the property definition.
If you specify
STRUCT, you must also specifydataTypeSpecto 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
STRUCTdata type.The options for this parameter depend on the type of the composite model in which you define this property. Use
AWS/ALARM_STATEfor alarm state in alarm composite models.unit -> (string)
The unit of the property definition, such as
NewtonsorRPM.type -> (structure)
The property definition type (see
PropertyType). You can only specify one type in a property definition.attribute -> (structure)
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 -> (structure)
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 -> (structure)
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 -> (structure)
The forwarding configuration for the given measurement property.
state -> (string)
The forwarding state for the given property.
transform -> (structure)
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.
(structure)
Contains expression variable information.
name -> (string)
The friendly name of the variable to be used in the expression.
value -> (structure)
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
nameif it’s from the same asset model.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.
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 .processingConfig -> (structure)
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 -> (structure)
The forwarding configuration for a given property.
state -> (string)
The forwarding state for the given property.
metric -> (structure)
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.
(structure)
Contains expression variable information.
name -> (string)
The friendly name of the variable to be used in the expression.
value -> (structure)
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
nameif it’s from the same asset model.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.
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 .window -> (structure)
The window (time interval) over which IoT SiteWise computes the metric’s aggregation expression. IoT SiteWise computes one data point per
window.tumbling -> (structure)
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
1winterval the end of Sunday at midnight each week (UTC), the1dinterval at the end of each day at midnight (UTC), the1hinterval 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
offsetparameter accepts the following:
The offset time. For example, if you specify
18hforoffsetand1dforinterval, 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
PT18Hforoffsetand1dforinterval, 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:00foroffset,5mforinterval, 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-08foroffsetand1dforinterval, 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 -> (structure)
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.
JSON Syntax:
[
{
"name": "string",
"description": "string",
"type": "string",
"properties": [
{
"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"
}
}
...
],
"processingConfig": {
"computeLocation": "EDGE"|"CLOUD",
"forwardingConfig": {
"state": "DISABLED"|"ENABLED"
}
}
},
"metric": {
"expression": "string",
"variables": [
{
"name": "string",
"value": {
"propertyId": "string",
"hierarchyId": "string"
}
}
...
],
"window": {
"tumbling": {
"interval": "string",
"offset": "string"
}
},
"processingConfig": {
"computeLocation": "EDGE"|"CLOUD"
}
}
}
}
...
]
}
...
]
--client-token (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.
--tags (map)
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 .
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To create an asset model
The following create-asset-model example creates an asset model that defines a wind turbine with the following properties:
Serial number - The serial number of a wind turbine
Generated power - The generated power data stream from a wind turbine
Temperature C - The temperature data stream from a wind turbine in Celsius
Temperature F - The mapped temperature data points from Celsius to Fahrenheit
aws iotsitewise create-asset-model \
--cli-input-json file://create-wind-turbine-model.json
Contents of create-wind-turbine-model.json:
{
"assetModelName": "Wind Turbine Model",
"assetModelDescription": "Represents a wind turbine",
"assetModelProperties": [
{
"name": "Serial Number",
"dataType": "STRING",
"type": {
"attribute": {}
}
},
{
"name": "Generated Power",
"dataType": "DOUBLE",
"unit": "kW",
"type": {
"measurement": {}
}
},
{
"name": "Temperature C",
"dataType": "DOUBLE",
"unit": "Celsius",
"type": {
"measurement": {}
}
},
{
"name": "Temperature F",
"dataType": "DOUBLE",
"unit": "Fahrenheit",
"type": {
"transform": {
"expression": "temp_c * 9 / 5 + 32",
"variables": [
{
"name": "temp_c",
"value": {
"propertyId": "Temperature C"
}
}
]
}
}
},
{
"name": "Total Generated Power",
"dataType": "DOUBLE",
"unit": "kW",
"type": {
"metric": {
"expression": "sum(power)",
"variables": [
{
"name": "power",
"value": {
"propertyId": "Generated Power"
}
}
],
"window": {
"tumbling": {
"interval": "1h"
}
}
}
}
}
]
}
Output:
{
"assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"assetModelStatus": {
"state": "CREATING"
}
}
For more information, see Defining asset models in the AWS IoT SiteWise User Guide.
Output¶
assetModelId -> (string)
The ID of the asset model. You can use this ID when you call other IoT SiteWise APIs.
assetModelArn -> (string)
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
assetModelStatus -> (structure)
The status of the asset model, which contains a state (
CREATINGafter successfully calling this operation) and any error message.state -> (string)
The current state of the asset model.
error -> (structure)
Contains associated error information, if any.
code -> (string)
The error code.
message -> (string)
The error message.
details -> (list)
A list of detailed errors.
(structure)
Contains detailed error information.
code -> (string)
The error code.
message -> (string)
The error message.