IoTSiteWise / Client / describe_asset_model
describe_asset_model#
- IoTSiteWise.Client.describe_asset_model(**kwargs)#
Retrieves information about an asset model.
See also: AWS API Documentation
Request Syntax
response = client.describe_asset_model( assetModelId='string', excludeProperties=True|False )
- Parameters:
assetModelId (string) –
[REQUIRED]
The ID of the asset model.
excludeProperties (boolean) – Whether or not to exclude asset model properties from the response.
- Return type:
dict
- Returns:
Response Syntax
{ 'assetModelId': 'string', 'assetModelArn': 'string', 'assetModelName': 'string', 'assetModelDescription': 'string', 'assetModelProperties': [ { 'id': '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' } }, ], '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' } } } }, ], 'assetModelHierarchies': [ { 'id': 'string', 'name': 'string', 'childAssetModelId': 'string' }, ], 'assetModelCompositeModels': [ { 'name': 'string', 'description': 'string', 'type': 'string', 'properties': [ { 'id': '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' } }, ], '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' } } } }, ], 'id': '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' }, ] } } }
Response Structure
(dict) –
assetModelId (string) –
The ID of the asset model.
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.
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
assetModelCompositeModelsobject.(dict) –
Contains information about an asset model property.
id (string) –
The ID of the asset model property.
name (string) –
The name of the asset model property.
dataType (string) –
The data type of the asset model property.
dataTypeSpec (string) –
The data type of the structure for this property. This parameter exists on properties that have the
STRUCTdata type.unit (string) –
The unit of the asset model property, such as
NewtonsorRPM.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
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 (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
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 (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
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 (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.
assetModelHierarchies (list) –
A list of asset model hierarchies that each contain a
childAssetModelIdand ahierarchyId(namedid). 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.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. All assets in this hierarchy must be instances of the
childAssetModelIdasset model.
assetModelCompositeModels (list) –
The list of composite asset models for the asset model.
(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.
name (string) –
The name of the asset model property.
dataType (string) –
The data type of the asset model property.
dataTypeSpec (string) –
The data type of the structure for this property. This parameter exists on properties that have the
STRUCTdata type.unit (string) –
The unit of the asset model property, such as
NewtonsorRPM.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
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 (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
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 (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
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 (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.
id (string) –
The ID of the asset model composite model.
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.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestExceptionIoTSiteWise.Client.exceptions.ResourceNotFoundExceptionIoTSiteWise.Client.exceptions.InternalFailureExceptionIoTSiteWise.Client.exceptions.ThrottlingException