IoTSiteWise / Client / describe_asset_composite_model

describe_asset_composite_model#

IoTSiteWise.Client.describe_asset_composite_model(**kwargs)#

Retrieves information about an asset composite model (also known as an asset component). An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel.

Request Syntax

response = client.describe_asset_composite_model(
    assetId='string',
    assetCompositeModelId='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.
assetCompositeModelId (string) –
[REQUIRED]

The ID of a composite model on this 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.

Return type:

dict

Returns:

Response Syntax

{
    'assetId': 'string',
    'assetCompositeModelId': 'string',
    'assetCompositeModelExternalId': 'string',
    'assetCompositeModelPath': [
        {
            'id': 'string',
            'name': 'string'
        },
    ],
    'assetCompositeModelName': 'string',
    'assetCompositeModelDescription': 'string',
    'assetCompositeModelType': 'string',
    'assetCompositeModelProperties': [
        {
            'id': 'string',
            'name': 'string',
            'alias': 'string',
            'notification': {
                'topic': 'string',
                'state': 'ENABLED'|'DISABLED'
            },
            'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
            'dataTypeSpec': 'string',
            'unit': 'string',
            'path': [
                {
                    'id': 'string',
                    'name': 'string'
                },
            ],
            'externalId': 'string'
        },
    ],
    'assetCompositeModelSummaries': [
        {
            'id': 'string',
            'externalId': 'string',
            'name': 'string',
            'type': 'string',
            'description': 'string',
            'path': [
                {
                    'id': 'string',
                    'name': 'string'
                },
            ]
        },
    ],
    'actionDefinitions': [
        {
            'actionDefinitionId': 'string',
            'actionName': 'string',
            'actionType': 'string'
        },
    ]
}

Response Structure

(dict) –
- assetId (string) –
  
  The ID of the asset, in UUID format. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs.
- assetCompositeModelId (string) –
  
  The ID of a composite model on this asset.
- assetCompositeModelExternalId (string) –
  
  An external ID to assign to the asset model.
  
  If the composite model is a component-based 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.
- assetCompositeModelPath (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.
    - id (string) –
      
      The ID of the path segment.
    - name (string) –
      
      The name of the path segment.
- assetCompositeModelName (string) –
  
  The unique, friendly name for the composite model.
- assetCompositeModelDescription (string) –
  
  A description for the composite model.
- assetCompositeModelType (string) –
  
  The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
- assetCompositeModelProperties (list) –
  
  The property definitions of the composite model that was used to create the asset.
  - (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.
    - 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.
- assetCompositeModelSummaries (list) –
  
  The list of composite model summaries.
  - (dict) –
    
    Contains a summary of the composite model for a specific asset.
    - id (string) –
      
      The ID of the composite model that this summary describes.
    - externalId (string) –
      
      An external ID to assign to the asset 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.
    - name (string) –
      
      The name of the composite model that this summary describes.
    - type (string) –
      
      The type of asset model.
      - ASSET_MODEL – (default) An asset model that you can use to create assets. Can’t be included as a component in another asset model.
      - COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can’t create assets directly from this type of asset model.
    - description (string) –
      
      A description of the composite model that this summary describes.
    - path (list) –
      
      The path that includes all the components of the asset model for the asset.
      - (dict) –
        
        Represents one level between a composite model and the root of the asset.
        
        id (string) –
        
        The ID of the path segment.
        
        name (string) –
        
        The name of the path segment.
- actionDefinitions (list) –
  
  The available actions for a composite model on this asset.
  - (dict) –
    
    Contains a definition for an action.
    - actionDefinitionId (string) –
      
      The ID of the action definition.
    - actionName (string) –
      
      The name of the action definition.
    - actionType (string) –
      
      The type of the action definition.

describe_asset_composite_model#

Request Syntax

Response Syntax

Response Structure

Exceptions