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

*****************
list_asset_models
*****************



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

  

  Retrieves a paginated list of summaries of all asset models.

  

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


  **Request Syntax**
  ::

    response = client.list_asset_models(
        assetModelTypes=[
            'ASSET_MODEL'|'COMPONENT_MODEL'|'INTERFACE',
        ],
        nextToken='string',
        maxResults=123,
        assetModelVersion='string'
    )
    
  :type assetModelTypes: list
  :param assetModelTypes: 

    The type of asset model. If you don't provide an ``assetModelTypes``, all types of asset models are returned.

     

    
    * **ASSET_MODEL** – 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.
     
    * **INTERFACE** – An interface is a type of model that defines a standard structure that can be applied to different asset models.
    

    

  
    - *(string) --* 

    

  :type nextToken: string
  :param nextToken: 

    The token to be used for the next set of paginated results.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return for each paginated request.

     

    Default: 50

    

  
  :type assetModelVersion: string
  :param assetModelVersion: 

    The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is ``LATEST``. See `Asset model versions <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html>`__ in the *IoT SiteWise User Guide*.

    

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

    
    ::

      {
          'assetModelSummaries': [
              {
                  'id': 'string',
                  'externalId': 'string',
                  'arn': 'string',
                  'name': 'string',
                  'assetModelType': 'ASSET_MODEL'|'COMPONENT_MODEL'|'INTERFACE',
                  'description': 'string',
                  'creationDate': datetime(2015, 1, 1),
                  'lastUpdateDate': datetime(2015, 1, 1),
                  'status': {
                      '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'
                              },
                          ]
                      }
                  },
                  'version': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **assetModelSummaries** *(list) --* 

        A list that summarizes each asset model.

        
        

        - *(dict) --* 

          Contains a summary of an asset model.

          
          

          - **id** *(string) --* 

            The ID of the asset model (used with IoT SiteWise API operations).

            
          

          - **externalId** *(string) --* 

            The external ID of the asset model. For more information, see `Using external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids>`__ in the *IoT SiteWise User Guide*.

            
          

          - **arn** *(string) --* 

            The `ARN <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ of the asset model, which has the following format.

             

            ``arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}``

            
          

          - **name** *(string) --* 

            The name of the asset model.

            
          

          - **assetModelType** *(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) --* 

            The asset model description.

            
          

          - **creationDate** *(datetime) --* 

            The date the asset model was created, in Unix epoch time.

            
          

          - **lastUpdateDate** *(datetime) --* 

            The date the asset model was last updated, in Unix epoch time.

            
          

          - **status** *(dict) --* 

            The current status of the asset model.

            
            

            - **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.

                    
              
            
          
        
          

          - **version** *(string) --* 

            The version number of the asset model.

            
      
    
      

      - **nextToken** *(string) --* 

        The token for the next set of results, or null if there are no additional results.

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

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

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

  