:doc:`IoTSiteWise <../../iotsitewise>` / Client / describe_asset_model_interface_relationship

*******************************************
describe_asset_model_interface_relationship
*******************************************



.. py:method:: IoTSiteWise.Client.describe_asset_model_interface_relationship(**kwargs)

  

  Retrieves information about an interface relationship between an asset model and an interface asset model.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAssetModelInterfaceRelationship>`_  


  **Request Syntax**
  ::

    response = client.describe_asset_model_interface_relationship(
        assetModelId='string',
        interfaceAssetModelId='string'
    )
    
  :type assetModelId: string
  :param assetModelId: **[REQUIRED]** 

    The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.

    

  
  :type interfaceAssetModelId: string
  :param interfaceAssetModelId: **[REQUIRED]** 

    The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'assetModelId': 'string',
          'interfaceAssetModelId': 'string',
          'propertyMappings': [
              {
                  'assetModelPropertyId': 'string',
                  'interfaceAssetModelPropertyId': 'string'
              },
          ],
          'hierarchyMappings': [
              {
                  'assetModelHierarchyId': 'string',
                  'interfaceAssetModelHierarchyId': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **assetModelId** *(string) --* 

        The ID of the asset model.

        
      

      - **interfaceAssetModelId** *(string) --* 

        The ID of the interface asset model.

        
      

      - **propertyMappings** *(list) --* 

        A list of property mappings between the interface asset model and the asset model where the interface is applied.

        
        

        - *(dict) --* 

          Maps a property from an interface asset model to a property in the asset model where the interface is applied.

          
          

          - **assetModelPropertyId** *(string) --* 

            The ID of the property in the asset model where the interface is applied.

            
          

          - **interfaceAssetModelPropertyId** *(string) --* 

            The ID of the property in the interface asset model.

            
      
    
      

      - **hierarchyMappings** *(list) --* 

        A list of hierarchy mappings between the interface asset model and the asset model where the interface is applied.

        
        

        - *(dict) --* 

          Maps a hierarchy from an interface asset model to a hierarchy in the asset model where the interface is applied.

          
          

          - **assetModelHierarchyId** *(string) --* 

            The ID of the hierarchy in the asset model where the interface is applied.

            
          

          - **interfaceAssetModelHierarchyId** *(string) --* 

            The ID of the hierarchy in the interface asset model.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`IoTSiteWise.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.InternalFailureException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.ThrottlingException`

  