AWS IoT SiteWise

2022/11/02 - AWS IoT SiteWise - 2 new 4 updated api methods

Changes  This release adds the ListAssetModelProperties and ListAssetProperties APIs. You can list all properties that belong to a single asset model or asset using these two new APIs.

ListAssetModelProperties (new) Link ¶

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'
)
type assetModelId

string

param assetModelId

[REQUIRED]

The ID of the asset model.

type nextToken

string

param nextToken

The token to be used for the next set of paginated results.

type maxResults

integer

param maxResults

The maximum number of results to return for each paginated request. If not specified, the default value is 50.

type filter

string

param filter

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

rtype

dict

returns

Response Syntax

{
    'assetModelPropertySummaries': [
        {
            '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'
                    }
                }
            },
            'assetModelCompositeModelId': '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.

        • id (string) --

          The ID of the property.

        • 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.

                  • 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 name if 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 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.

    • nextToken (string) --

      The token for the next set of results, or null if there are no additional results.

ListAssetProperties (new) Link ¶

Retrieves a paginated list of properties associated with an asset. 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_properties(
    assetId='string',
    nextToken='string',
    maxResults=123,
    filter='ALL'|'BASE'
)
type assetId

string

param assetId

[REQUIRED]

The ID of the asset.

type nextToken

string

param nextToken

The token to be used for the next set of paginated results.

type maxResults

integer

param maxResults

The maximum number of results to return for each paginated request. If not specified, the default value is 50.

type filter

string

param filter

Filters the requested list of asset properties. You can choose one of the following options:

  • ALL – The list includes all asset properties for a given asset model ID.

  • BASE – The list includes only base asset properties for a given asset model ID.

Default: BASE

rtype

dict

returns

Response Syntax

{
    'assetPropertySummaries': [
        {
            'id': 'string',
            'alias': 'string',
            'unit': 'string',
            'notification': {
                'topic': 'string',
                'state': 'ENABLED'|'DISABLED'
            },
            'assetCompositeModelId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • assetPropertySummaries (list) --

      A list that summarizes the properties associated with the specified asset.

      • (dict) --

        Contains a summary of a property associated with an asset.

        • id (string) --

          The ID of the property.

        • alias (string) --

          The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .

        • unit (string) --

          The unit of measure (such as Newtons or RPM) of the asset property.

        • notification (dict) --

          Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide .

          • topic (string) --

            The MQTT topic to which IoT SiteWise publishes property value update notifications.

          • state (string) --

            The current notification state.

        • assetCompositeModelId (string) --

          The ID of the composite model that contains the asset property.

    • nextToken (string) --

      The token for the next set of results, or null if there are no additional results.

DescribeAsset (updated) Link ¶
Changes (request, response)
Request
{'excludeProperties': 'boolean'}
Response
{'assetCompositeModels': {'id': 'string'}}

Retrieves information about an asset.

See also: AWS API Documentation

Request Syntax

client.describe_asset(
    assetId='string',
    excludeProperties=True|False
)
type assetId

string

param assetId

[REQUIRED]

The ID of the asset.

type excludeProperties

boolean

param excludeProperties

Whether or not to exclude asset properties from the response.

rtype

dict

returns

Response Syntax

{
    'assetId': 'string',
    'assetArn': 'string',
    'assetName': 'string',
    'assetModelId': 'string',
    'assetProperties': [
        {
            'id': 'string',
            'name': 'string',
            'alias': 'string',
            'notification': {
                'topic': 'string',
                'state': 'ENABLED'|'DISABLED'
            },
            'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
            'dataTypeSpec': 'string',
            'unit': 'string'
        },
    ],
    'assetHierarchies': [
        {
            'id': 'string',
            'name': 'string'
        },
    ],
    'assetCompositeModels': [
        {
            'name': 'string',
            'description': 'string',
            'type': 'string',
            'properties': [
                {
                    'id': 'string',
                    'name': 'string',
                    'alias': 'string',
                    'notification': {
                        'topic': 'string',
                        'state': 'ENABLED'|'DISABLED'
                    },
                    'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
                    'dataTypeSpec': 'string',
                    'unit': 'string'
                },
            ],
            'id': 'string'
        },
    ],
    'assetCreationDate': datetime(2015, 1, 1),
    'assetLastUpdateDate': datetime(2015, 1, 1),
    'assetStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string',
            'details': [
                {
                    'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message': 'string'
                },
            ]
        }
    },
    'assetDescription': 'string'
}

Response Structure

  • (dict) --

    • assetId (string) --

      The ID of the asset.

    • assetArn (string) --

      The ARN of the asset, which has the following format.

      arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

    • assetName (string) --

      The name of the asset.

    • assetModelId (string) --

      The ID of the asset model that was used to create the asset.

    • assetProperties (list) --

      The list of asset properties for the asset.

      This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

      • (dict) --

        Contains asset property information.

        • id (string) --

          The ID of the asset property.

        • name (string) --

          The name of the property.

        • alias (string) --

          The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .

        • notification (dict) --

          The asset property's notification topic and state. For more information, see UpdateAssetProperty .

          • topic (string) --

            The MQTT topic to which IoT SiteWise publishes property value update notifications.

          • state (string) --

            The current notification state.

        • dataType (string) --

          The data type of the asset 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 asset property.

    • assetHierarchies (list) --

      A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.

      • (dict) --

        Describes an asset hierarchy that contains a hierarchy's name and ID.

        • id (string) --

          The ID of the hierarchy. This ID is a hierarchyId .

        • name (string) --

          The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.

    • assetCompositeModels (list) --

      The composite models for the asset.

      • (dict) --

        Contains information about a composite model in an asset. This object contains the asset's properties 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 properties that this composite model defines.

          • (dict) --

            Contains asset property information.

            • id (string) --

              The ID of the asset property.

            • name (string) --

              The name of the property.

            • alias (string) --

              The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .

            • notification (dict) --

              The asset property's notification topic and state. For more information, see UpdateAssetProperty .

              • topic (string) --

                The MQTT topic to which IoT SiteWise publishes property value update notifications.

              • state (string) --

                The current notification state.

            • dataType (string) --

              The data type of the asset 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 asset property.

        • id (string) --

          The ID of the asset composite model.

    • assetCreationDate (datetime) --

      The date the asset was created, in Unix epoch time.

    • assetLastUpdateDate (datetime) --

      The date the asset was last updated, in Unix epoch time.

    • assetStatus (dict) --

      The current status of the asset, which contains a state and any error message.

      • state (string) --

        The current status of the asset.

      • 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.

    • assetDescription (string) --

      A description for the asset.

DescribeAssetModel (updated) Link ¶
Changes (request, response)
Request
{'excludeProperties': 'boolean'}
Response
{'assetModelCompositeModels': {'id': 'string'}}

Retrieves information about an asset model.

See also: AWS API Documentation

Request Syntax

client.describe_asset_model(
    assetModelId='string',
    excludeProperties=True|False
)
type assetModelId

string

param assetModelId

[REQUIRED]

The ID of the asset model.

type excludeProperties

boolean

param excludeProperties

Whether or not to exclude asset model properties from the response.

rtype

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 assetModelCompositeModels object.

      • (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 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.

                  • 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 name if 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 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.

    • 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 .

        • 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 childAssetModelId asset 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 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.

                      • 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 name if 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 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.

        • 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.

DescribeAssetProperty (updated) Link ¶
Changes (response)
{'compositeModel': {'id': 'string'}}

Retrieves information about an asset property.

Note

When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.

This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue .

See also: AWS API Documentation

Request Syntax

client.describe_asset_property(
    assetId='string',
    propertyId='string'
)
type assetId

string

param assetId

[REQUIRED]

The ID of the asset.

type propertyId

string

param propertyId

[REQUIRED]

The ID of the asset property.

rtype

dict

returns

Response Syntax

{
    'assetId': 'string',
    'assetName': 'string',
    'assetModelId': 'string',
    'assetProperty': {
        'id': 'string',
        'name': 'string',
        'alias': 'string',
        'notification': {
            'topic': 'string',
            'state': 'ENABLED'|'DISABLED'
        },
        'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
        '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'
                }
            }
        }
    },
    'compositeModel': {
        'name': 'string',
        'type': 'string',
        'assetProperty': {
            'id': 'string',
            'name': 'string',
            'alias': 'string',
            'notification': {
                'topic': 'string',
                'state': 'ENABLED'|'DISABLED'
            },
            'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
            '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'
    }
}

Response Structure

  • (dict) --

    • assetId (string) --

      The ID of the asset.

    • assetName (string) --

      The name of the asset.

    • assetModelId (string) --

      The ID of the asset model.

    • assetProperty (dict) --

      The asset property's definition, alias, and notification state.

      This response includes this object for normal asset properties. If you describe an asset property in a composite model, this response includes the asset property information in compositeModel .

      • id (string) --

        The ID of the asset property.

      • name (string) --

        The name of the property.

      • alias (string) --

        The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .

      • notification (dict) --

        The asset property's notification topic and state. For more information, see UpdateAssetProperty .

        • topic (string) --

          The MQTT topic to which IoT SiteWise publishes property value update notifications.

        • state (string) --

          The current notification state.

      • dataType (string) --

        The property data type.

      • unit (string) --

        The unit (such as Newtons or RPM ) of the asset property.

      • type (dict) --

        The property type (see PropertyType ). A property contains one type.

        • 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.

                • 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 name if 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 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.

    • compositeModel (dict) --

      The composite asset model that declares this asset property, if this asset property exists in a composite model.

      • name (string) --

        The name of the property.

      • type (string) --

        The type of the composite model that defines this property.

      • assetProperty (dict) --

        Contains asset property information.

        • id (string) --

          The ID of the asset property.

        • name (string) --

          The name of the property.

        • alias (string) --

          The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide .

        • notification (dict) --

          The asset property's notification topic and state. For more information, see UpdateAssetProperty .

          • topic (string) --

            The MQTT topic to which IoT SiteWise publishes property value update notifications.

          • state (string) --

            The current notification state.

        • dataType (string) --

          The property data type.

        • unit (string) --

          The unit (such as Newtons or RPM ) of the asset property.

        • type (dict) --

          The property type (see PropertyType ). A property contains one type.

          • 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.

                  • 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 name if 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 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.

      • id (string) --

        The ID of the composite model that contains the property.

UpdateAssetModel (updated) Link ¶
Changes (request)
{'assetModelCompositeModels': {'id': 'string'}}

Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide .

Warning

This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel .

If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.

See also: AWS API Documentation

Request Syntax

client.update_asset_model(
    assetModelId='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'
        },
    ],
    clientToken='string'
)
type assetModelId

string

param assetModelId

[REQUIRED]

The ID of the asset model to update.

type assetModelName

string

param assetModelName

[REQUIRED]

A unique, friendly name for the asset model.

type assetModelDescription

string

param assetModelDescription

A description for the asset model.

type assetModelProperties

list

param assetModelProperties

The updated 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 information about an asset model property.

    • id (string) --

      The ID of the asset model property.

    • name (string) -- [REQUIRED]

      The name of the asset model property.

    • dataType (string) -- [REQUIRED]

      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 STRUCT data type.

    • unit (string) --

      The unit of the asset model property, such as Newtons or RPM .

    • type (dict) -- [REQUIRED]

      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) -- [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) -- [REQUIRED]

                The ID of the property to use as the variable. You can use the property name if 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) -- [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) -- [REQUIRED]

          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) -- [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) -- [REQUIRED]

                The ID of the property to use as the variable. You can use the property name if 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) -- [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.

type assetModelHierarchies

list

param assetModelHierarchies

The updated 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) --

    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) -- [REQUIRED]

      The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.

    • childAssetModelId (string) -- [REQUIRED]

      The ID of the asset model. All assets in this hierarchy must be instances of the childAssetModelId asset model.

type assetModelCompositeModels

list

param assetModelCompositeModels

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.

  • (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) -- [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 information about an asset model property.

        • id (string) --

          The ID of the asset model property.

        • name (string) -- [REQUIRED]

          The name of the asset model property.

        • dataType (string) -- [REQUIRED]

          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 STRUCT data type.

        • unit (string) --

          The unit of the asset model property, such as Newtons or RPM .

        • type (dict) -- [REQUIRED]

          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) -- [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) -- [REQUIRED]

                    The ID of the property to use as the variable. You can use the property name if 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) -- [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) -- [REQUIRED]

              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) -- [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) -- [REQUIRED]

                    The ID of the property to use as the variable. You can use the property name if 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) -- [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.

    • id (string) --

      The ID of the asset model composite model.

type clientToken

string

param clientToken

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.

rtype

dict

returns

Response Syntax

{
    '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) --

    • assetModelStatus (dict) --

      The status of the asset model, which contains a state (UPDATING 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.