IoTSiteWise / Client / create_asset_model_composite_model

create_asset_model_composite_model#

IoTSiteWise.Client.create_asset_model_composite_model(**kwargs)#

Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models, inline and component-model-based.

Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name, a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced component model provides its associated properties to any created assets. For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.

Use inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are included and can’t be used to create multiple assets.

To create a component-model-based model, specify the composedAssetModelId of an existing asset model with assetModelType of COMPONENT_MODEL.

To create an inline model, specify the assetModelCompositeModelProperties and don’t include an composedAssetModelId.

Request Syntax

response = client.create_asset_model_composite_model(
    assetModelId='string',
    assetModelCompositeModelExternalId='string',
    parentAssetModelCompositeModelId='string',
    assetModelCompositeModelId='string',
    assetModelCompositeModelDescription='string',
    assetModelCompositeModelName='string',
    assetModelCompositeModelType='string',
    clientToken='string',
    composedAssetModelId='string',
    assetModelCompositeModelProperties=[
        {
            'id': 'string',
            'externalId': 'string',
            'name': 'string',
            'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
            'dataTypeSpec': 'string',
            'unit': 'string',
            'type': {
                'attribute': {
                    'defaultValue': 'string'
                },
                'measurement': {
                    'processingConfig': {
                        'forwardingConfig': {
                            'state': 'DISABLED'|'ENABLED'
                        }
                    }
                },
                'transform': {
                    'expression': 'string',
                    'variables': [
                        {
                            'name': 'string',
                            'value': {
                                'propertyId': 'string',
                                'hierarchyId': 'string',
                                'propertyPath': [
                                    {
                                        'id': 'string',
                                        'name': 'string'
                                    },
                                ]
                            }
                        },
                    ],
                    'processingConfig': {
                        'computeLocation': 'EDGE'|'CLOUD',
                        'forwardingConfig': {
                            'state': 'DISABLED'|'ENABLED'
                        }
                    }
                },
                'metric': {
                    'expression': 'string',
                    'variables': [
                        {
                            'name': 'string',
                            'value': {
                                'propertyId': 'string',
                                'hierarchyId': 'string',
                                'propertyPath': [
                                    {
                                        'id': 'string',
                                        'name': 'string'
                                    },
                                ]
                            }
                        },
                    ],
                    'window': {
                        'tumbling': {
                            'interval': 'string',
                            'offset': 'string'
                        }
                    },
                    'processingConfig': {
                        'computeLocation': 'EDGE'|'CLOUD'
                    }
                }
            }
        },
    ],
    ifMatch='string',
    ifNoneMatch='string',
    matchForVersionType='LATEST'|'ACTIVE'
)

Parameters:

assetModelId (string) –
[REQUIRED]

The ID of the asset model this composite model is a part of.
assetModelCompositeModelExternalId (string) –
An external ID to assign to the composite model.

If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it’s a part of.
parentAssetModelCompositeModelId (string) – The ID of the parent composite model in this asset model relationship.
assetModelCompositeModelId (string) – The ID of the composite model. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
assetModelCompositeModelDescription (string) – A description for the composite model.
assetModelCompositeModelName (string) –
[REQUIRED]

A unique name for the composite model.
assetModelCompositeModelType (string) –
[REQUIRED]

The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
clientToken (string) –
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

This field is autopopulated if not provided.
composedAssetModelId (string) – The ID of a component model which is reused to create this composite model.
assetModelCompositeModelProperties (list) –
The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.

You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.
- (dict) –
  
  Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
  - id (string) –
    
    The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
  - externalId (string) –
    
    An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
  - name (string) – [REQUIRED]
    
    The name of the property definition.
  - dataType (string) – [REQUIRED]
    
    The data type of the property definition.
    
    If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.
  - dataTypeSpec (string) –
    
    The data type of the structure for this property. This parameter is required on properties that have the STRUCT data type.
    
    The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models.
  - unit (string) –
    
    The unit of the property definition, such as Newtons or RPM.
  - type (dict) – [REQUIRED]
    
    The property definition type (see PropertyType). You can only specify one type in a property definition.
    - attribute (dict) –
      
      Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
      - defaultValue (string) –
        
        The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute’s value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide.
    - measurement (dict) –
      
      Specifies an asset measurement property. A measurement represents a device’s raw sensor data stream, such as timestamped temperature values or timestamped power values.
      - processingConfig (dict) –
        
        The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.
        
        forwardingConfig (dict) – [REQUIRED]
        
        The forwarding configuration for the given measurement property.
        
        state (string) – [REQUIRED]
        
        The forwarding state for the given property.
    - transform (dict) –
      
      Specifies an asset transform property. A transform contains a mathematical expression that maps a property’s data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
      - expression (string) – [REQUIRED]
        
        The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
        
        For more information, see Quotas in the IoT SiteWise User Guide.
      - variables (list) – [REQUIRED]
        
        The list of variables used in the expression.
        
        (dict) –
        
        Contains expression variable information.
        
        name (string) – [REQUIRED]
        
        The friendly name of the variable to be used in the expression.
        
        value (dict) – [REQUIRED]
        
        The variable that identifies an asset property from which to use values.
        
        propertyId (string) –
        
        The ID of the property to use as the variable. You can use the property name if it’s from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
        
        hierarchyId (string) –
        
        The ID of the hierarchy to query for the property ID. You can use the hierarchy’s name instead of the hierarchy’s ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
        
        You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
        
        propertyPath (list) –
        
        The path of the property.
        
        (dict) –
        
        Represents one level between a property and the root of the asset model.
        
        id (string) –
        
        The ID of the path segment.
        
        name (string) –
        
        The name of the path segment.
      - processingConfig (dict) –
        
        The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
        
        computeLocation (string) – [REQUIRED]
        
        The compute location for the given transform property.
        
        forwardingConfig (dict) –
        
        The forwarding configuration for a given property.
        
        state (string) – [REQUIRED]
        
        The forwarding state for the given property.
    - metric (dict) –
      
      Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
      - expression (string) – [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) –
        
        The ID of the property to use as the variable. You can use the property name if it’s from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
        
        hierarchyId (string) –
        
        The ID of the hierarchy to query for the property ID. You can use the hierarchy’s name instead of the hierarchy’s ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
        
        You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.
        
        propertyPath (list) –
        
        The path of the property.
        
        (dict) –
        
        Represents one level between a property and the root of the asset model.
        
        id (string) –
        
        The ID of the path segment.
        
        name (string) –
        
        The name of the path segment.
      - window (dict) – [REQUIRED]
        
        The window (time interval) over which IoT SiteWise computes the metric’s aggregation expression. IoT SiteWise computes one data point per window.
        
        tumbling (dict) –
        
        The tumbling time interval window.
        
        interval (string) – [REQUIRED]
        
        The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.
        
        IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.
        
        When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.
        
        offset (string) –
        
        The offset for the tumbling window. The offset parameter accepts the following:
        
        The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
        
        If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
        
        If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
        
        The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
        
        If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
        
        If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
        
        The 24-hour clock. For example, if you specify 00:03:00 for offset, 5m for interval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).
        
        The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:
        
        If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
        
        If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
      - processingConfig (dict) –
        
        The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
        
        computeLocation (string) – [REQUIRED]
        
        The compute location for the given metric property.
ifMatch (string) – The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The create request is rejected if the tag does not match the latest or active version’s current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.
ifNoneMatch (string) – Accepts * to reject the create request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
matchForVersionType (string) – Specifies the asset model version type ( LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the create operation.

Return type:

dict

Returns:

Response Syntax

{
    'assetModelCompositeModelId': 'string',
    'assetModelCompositeModelPath': [
        {
            'id': 'string',
            'name': 'string'
        },
    ],
    'assetModelStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'PROPAGATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string',
            'details': [
                {
                    'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message': 'string'
                },
            ]
        }
    }
}

Response Structure

(dict) –
- assetModelCompositeModelId (string) –
  
  The ID of the composed asset model. You can use this ID when you call other IoT SiteWise APIs.
- assetModelCompositeModelPath (list) –
  
  The path to the composite model listing the parent composite models.
  - (dict) –
    
    Represents one level between a composite model and the root of the asset model.
    - id (string) –
      
      The ID of the path segment.
    - name (string) –
      
      The name of the path segment.
- assetModelStatus (dict) –
  
  Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide.
  - state (string) –
    
    The current state of the asset model.
  - error (dict) –
    
    Contains associated error information, if any.
    - code (string) –
      
      The error code.
    - message (string) –
      
      The error message.
    - details (list) –
      
      A list of detailed errors.
      - (dict) –
        
        Contains detailed error information.
        
        code (string) –
        
        The error code.
        
        message (string) –
        
        The error message.

create_asset_model_composite_model#

Request Syntax

Response Syntax

Response Structure

Exceptions