:doc:`IoTSiteWise <../../iotsitewise>` / Paginator / ListAssetModelCompositeModels

*****************************
ListAssetModelCompositeModels
*****************************



.. py:class:: IoTSiteWise.Paginator.ListAssetModelCompositeModels

  ::

    
    paginator = client.get_paginator('list_asset_model_composite_models')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`IoTSiteWise.Client.list_asset_model_composite_models`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          assetModelId='string',
          assetModelVersion='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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, if it has one. For more information, see `Referencing objects with external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references>`__ in the *IoT SiteWise User Guide*.

      

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

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'assetModelCompositeModelSummaries': [
                {
                    'id': 'string',
                    'externalId': 'string',
                    'name': 'string',
                    'type': 'string',
                    'description': 'string',
                    'path': [
                        {
                            'id': 'string',
                            'name': 'string'
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **assetModelCompositeModelSummaries** *(list) --* 

          A list that summarizes each composite model.

          
          

          - *(dict) --* 

            Contains a summary of the composite model.

            
            

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

              The ID of the composite model that this summary describes..

              
            

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

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

              
            

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

              The name of the composite model that this summary describes..

              
            

            - **type** *(string) --* 

              The composite model type. Valid values are ``AWS/ALARM``, ``CUSTOM``, or ``AWS/L4E_ANOMALY``.

              
            

            - **description** *(string) --* 

              The description of the composite model that this summary describes..

              
            

            - **path** *(list) --* 

              The path that includes all the pieces that make up the composite model.

              
              

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

                  
            
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    