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

******************************
list_composition_relationships
******************************



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

  

  Retrieves a paginated list of composition relationships for an asset model of type ``COMPONENT_MODEL``.

  

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


  **Request Syntax**
  ::

    response = client.list_composition_relationships(
        assetModelId='string',
        nextToken='string',
        maxResults=123
    )
    
  :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 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

    

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

    
    ::

      {
          'compositionRelationshipSummaries': [
              {
                  'assetModelId': 'string',
                  'assetModelCompositeModelId': 'string',
                  'assetModelCompositeModelType': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **compositionRelationshipSummaries** *(list) --* 

        A list that summarizes each composition relationship.

        
        

        - *(dict) --* 

          Contains a summary of the components of the composite model.

          
          

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

            The ID of the asset model, in UUID format.

            
          

          - **assetModelCompositeModelId** *(string) --* 

            The ID of a composite model on this asset model.

            
          

          - **assetModelCompositeModelType** *(string) --* 

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

            
      
    
      

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

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

  