IoTSiteWise / Client / describe_asset_property

describe_asset_property#

IoTSiteWise.Client.describe_asset_property(**kwargs)#

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.

Request Syntax

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

Parameters:

assetId (string) –
[REQUIRED]

The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
propertyId (string) –
[REQUIRED]

The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

Return type:

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',
                            'propertyPath': [
                                {
                                    'id': 'string',
                                    'name': 'string'
                                },
                            ]
                        }
                    },
                ],
                'processingConfig': {
                    'computeLocation': 'EDGE'|'CLOUD',
                    'forwardingConfig': {
                        'state': 'DISABLED'|'ENABLED'
                    }
                }
            },
            'metric': {
                'expression': 'string',
                'variables': [
                    {
                        'name': 'string',
                        'value': {
                            'propertyId': 'string',
                            'hierarchyId': 'string',
                            'propertyPath': [
                                {
                                    'id': 'string',
                                    'name': 'string'
                                },
                            ]
                        }
                    },
                ],
                'window': {
                    'tumbling': {
                        'interval': 'string',
                        'offset': 'string'
                    }
                },
                'processingConfig': {
                    'computeLocation': 'EDGE'|'CLOUD'
                }
            }
        },
        'path': [
            {
                'id': 'string',
                'name': 'string'
            },
        ],
        'externalId': 'string'
    },
    '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',
                                'propertyPath': [
                                    {
                                        'id': 'string',
                                        'name': 'string'
                                    },
                                ]
                            }
                        },
                    ],
                    'processingConfig': {
                        'computeLocation': 'EDGE'|'CLOUD',
                        'forwardingConfig': {
                            'state': 'DISABLED'|'ENABLED'
                        }
                    }
                },
                'metric': {
                    'expression': 'string',
                    'variables': [
                        {
                            'name': 'string',
                            'value': {
                                'propertyId': 'string',
                                'hierarchyId': 'string',
                                'propertyPath': [
                                    {
                                        'id': 'string',
                                        'name': 'string'
                                    },
                                ]
                            }
                        },
                    ],
                    'window': {
                        'tumbling': {
                            'interval': 'string',
                            'offset': 'string'
                        }
                    },
                    'processingConfig': {
                        'computeLocation': 'EDGE'|'CLOUD'
                    }
                }
            },
            'path': [
                {
                    'id': 'string',
                    'name': 'string'
                },
            ],
            'externalId': 'string'
        },
        'id': 'string',
        'externalId': 'string'
    },
    'assetExternalId': 'string'
}

Response Structure

(dict) –
- assetId (string) –
  
  The ID of the asset, in UUID format.
- assetName (string) –
  
  The name of the asset.
- assetModelId (string) –
  
  The ID of the asset model, in UUID format.
- 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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
        
        hierarchyId (string) –
        
        The ID of the hierarchy to query for the property ID. You can use the hierarchy’s name instead of the hierarchy’s ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
        
        You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
        
        propertyPath (list) –
        
        The path of the property.
        
        (dict) –
        
        Represents one level between a property and the root of the asset model.
        
        id (string) –
        
        The ID of the path segment.
        
        name (string) –
        
        The name of the path segment.
      - processingConfig (dict) –
        
        The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
        
        computeLocation (string) –
        
        The compute location for the given transform property.
        
        forwardingConfig (dict) –
        
        The forwarding configuration for a given property.
        
        state (string) –
        
        The forwarding state for the given property.
    - metric (dict) –
      
      Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
      - expression (string) –
        
        The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
        
        For more information, see Quotas in the IoT SiteWise User Guide.
      - variables (list) –
        
        The list of variables used in the expression.
        
        (dict) –
        
        Contains expression variable information.
        
        name (string) –
        
        The friendly name of the variable to be used in the expression.
        
        value (dict) –
        
        The variable that identifies an asset property from which to use values.
        
        propertyId (string) –
        
        The ID of the property to use as the variable. You can use the property name if it’s from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
        
        hierarchyId (string) –
        
        The ID of the hierarchy to query for the property ID. You can use the hierarchy’s name instead of the hierarchy’s ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
        
        You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
        
        propertyPath (list) –
        
        The path of the property.
        
        (dict) –
        
        Represents one level between a property and the root of the asset model.
        
        id (string) –
        
        The ID of the path segment.
        
        name (string) –
        
        The name of the path segment.
      - window (dict) –
        
        The window (time interval) over which IoT SiteWise computes the metric’s aggregation expression. IoT SiteWise computes one data point per window.
        
        tumbling (dict) –
        
        The tumbling time interval window.
        
        interval (string) –
        
        The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
        
        IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
        
        When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
        
        offset (string) –
        
        The offset for the tumbling window. The offset parameter accepts the following:
        
        The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
        
        If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
        
        If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
        
        The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
        
        If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
        
        If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
        
        The 24-hour clock. For example, if you specify 00:03:00 for offset, 5m for interval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).
        
        The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
        
        If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
        
        If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
      - processingConfig (dict) –
        
        The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
        
        computeLocation (string) –
        
        The compute location for the given metric property.
  - path (list) –
    
    The structured path to the property from the root of the asset.
    - (dict) –
      
      Represents one level between a property and the root of the asset.
      - id (string) –
        
        The ID of the path segment.
      - name (string) –
        
        The name of the path segment.
  - externalId (string) –
    
    The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
- compositeModel (dict) –
  
  The composite 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. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
        
        hierarchyId (string) –
        
        The ID of the hierarchy to query for the property ID. You can use the hierarchy’s name instead of the hierarchy’s ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
        
        You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
        
        propertyPath (list) –
        
        The path of the property.
        
        (dict) –
        
        Represents one level between a property and the root of the asset model.
        
        id (string) –
        
        The ID of the path segment.
        
        name (string) –
        
        The name of the path segment.
        
        processingConfig (dict) –
        
        The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
        
        computeLocation (string) –
        
        The compute location for the given transform property.
        
        forwardingConfig (dict) –
        
        The forwarding configuration for a given property.
        
        state (string) –
        
        The forwarding state for the given property.
      - metric (dict) –
        
        Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
        
        expression (string) –
        
        The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
        
        For more information, see Quotas in the IoT SiteWise User Guide.
        
        variables (list) –
        
        The list of variables used in the expression.
        
        (dict) –
        
        Contains expression variable information.
        
        name (string) –
        
        The friendly name of the variable to be used in the expression.
        
        value (dict) –
        
        The variable that identifies an asset property from which to use values.
        
        propertyId (string) –
        
        The ID of the property to use as the variable. You can use the property name if it’s from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
        
        hierarchyId (string) –
        
        The ID of the hierarchy to query for the property ID. You can use the hierarchy’s name instead of the hierarchy’s ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
        
        You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
        
        propertyPath (list) –
        
        The path of the property.
        
        (dict) –
        
        Represents one level between a property and the root of the asset model.
        
        id (string) –
        
        The ID of the path segment.
        
        name (string) –
        
        The name of the path segment.
        
        window (dict) –
        
        The window (time interval) over which IoT SiteWise computes the metric’s aggregation expression. IoT SiteWise computes one data point per window.
        
        tumbling (dict) –
        
        The tumbling time interval window.
        
        interval (string) –
        
        The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
        
        IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
        
        When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
        
        offset (string) –
        
        The offset for the tumbling window. The offset parameter accepts the following:
        
        The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
        
        If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
        
        If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
        
        The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
        
        If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
        
        If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
        
        The 24-hour clock. For example, if you specify 00:03:00 for offset, 5m for interval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).
        
        The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
        
        If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
        
        If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
        
        processingConfig (dict) –
        
        The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
        
        computeLocation (string) –
        
        The compute location for the given metric property.
    - path (list) –
      
      The structured path to the property from the root of the asset.
      - (dict) –
        
        Represents one level between a property and the root of the asset.
        
        id (string) –
        
        The ID of the path segment.
        
        name (string) –
        
        The name of the path segment.
    - externalId (string) –
      
      The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
  - id (string) –
    
    The ID of the composite model that contains the property.
  - externalId (string) –
    
    The external ID of the composite model that contains the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
- assetExternalId (string) –
  
  The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.

Exceptions

IoTSiteWise.Client.exceptions.InvalidRequestException
IoTSiteWise.Client.exceptions.ResourceNotFoundException
IoTSiteWise.Client.exceptions.InternalFailureException
IoTSiteWise.Client.exceptions.ThrottlingException