IoTSiteWise / Client / describe_asset

describe_asset#

IoTSiteWise.Client.describe_asset(**kwargs)#

Retrieves information about an asset.

Request Syntax

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

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.
excludeProperties (boolean) – Whether or not to exclude asset properties from the response.

Return type:

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',
            'path': [
                {
                    'id': 'string',
                    'name': 'string'
                },
            ],
            'externalId': 'string'
        },
    ],
    'assetHierarchies': [
        {
            'id': 'string',
            'name': 'string',
            'externalId': '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',
                    'path': [
                        {
                            'id': 'string',
                            'name': 'string'
                        },
                    ],
                    'externalId': 'string'
                },
            ],
            'id': 'string',
            'externalId': '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',
    'assetCompositeModelSummaries': [
        {
            'id': 'string',
            'externalId': 'string',
            'name': 'string',
            'type': 'string',
            'description': 'string',
            'path': [
                {
                    'id': 'string',
                    'name': 'string'
                },
            ]
        },
    ],
    'assetExternalId': 'string'
}

Response Structure

(dict) –
- assetId (string) –
  
  The ID of the asset, in UUID format.
- 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.
    - 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.
- 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.
    - externalId (string) –
      
      The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you may assign an external ID if it doesn’t already have one. You can’t change the external ID of an asset hierarchy that already has one. For more information, see Using external IDs in the IoT SiteWise User Guide.
- 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.
        
        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 asset composite model.
    - externalId (string) –
      
      The external ID of the asset composite model. For more information, see Using external IDs in the IoT SiteWise User Guide.
- 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.
- assetCompositeModelSummaries (list) –
  
  The list of the immediate child custom composite model summaries for the asset.
  - (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.
- assetExternalId (string) –
  
  The external ID of the asset, if any.

describe_asset#

Request Syntax

Response Syntax

Response Structure

Exceptions