:doc:`IoTTwinMaker <../../iottwinmaker>` / Client / list_components

***************
list_components
***************



.. py:method:: IoTTwinMaker.Client.list_components(**kwargs)

  

  This API lists the components of an entity.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/ListComponents>`_  


  **Request Syntax**
  ::

    response = client.list_components(
        workspaceId='string',
        entityId='string',
        componentPath='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type workspaceId: string
  :param workspaceId: **[REQUIRED]** 

    The workspace ID.

    

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

    The ID for the entity whose metadata (component/properties) is returned by the operation.

    

  
  :type componentPath: string
  :param componentPath: 

    This string specifies the path to the composite component, starting from the top-level component.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results returned at one time. The default is 25.

    

  
  :type nextToken: string
  :param nextToken: 

    The string that specifies the next page of results.

    

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

    
    ::

      {
          'componentSummaries': [
              {
                  'componentName': 'string',
                  'componentTypeId': 'string',
                  'definedIn': 'string',
                  'description': 'string',
                  'propertyGroups': {
                      'string': {
                          'groupType': 'TABULAR',
                          'propertyNames': [
                              'string',
                          ],
                          'isInherited': True|False
                      }
                  },
                  'status': {
                      'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR',
                      'error': {
                          'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE',
                          'message': 'string'
                      }
                  },
                  'syncSource': 'string',
                  'componentPath': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **componentSummaries** *(list) --* 

        A list of objects that contain information about the components.

        
        

        - *(dict) --* 

          An object that returns information about a component summary.

          
          

          - **componentName** *(string) --* 

            The name of the component.

            
          

          - **componentTypeId** *(string) --* 

            The ID of the component type.

            
          

          - **definedIn** *(string) --* 

            The name of the property definition set in the request.

            
          

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

            The description of the component request.

            
          

          - **propertyGroups** *(dict) --* 

            The property groups.

            
            

            - *(string) --* 
              

              - *(dict) --* 

                The component property group response.

                
                

                - **groupType** *(string) --* 

                  The group type.

                  
                

                - **propertyNames** *(list) --* 

                  The names of properties

                  
                  

                  - *(string) --* 
              
                

                - **isInherited** *(boolean) --* 

                  A Boolean value that specifies whether the property group is inherited from a parent entity

                  
            
        
      
          

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

            The status of the component type.

            
            

            - **state** *(string) --* 

              The current state of the entity, component, component type, or workspace.

              
            

            - **error** *(dict) --* 

              The error message.

              
              

              - **code** *(string) --* 

                The error code.

                
              

              - **message** *(string) --* 

                The error message.

                
          
        
          

          - **syncSource** *(string) --* 

            The ``syncSource`` of the sync job, if this entity was created by a sync job.

            
          

          - **componentPath** *(string) --* 

            This string specifies the path to the composite component, starting from the top-level component.

            
      
    
      

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

        The string that specifies the next page of component results.

        
  
  **Exceptions**
  
  *   :py:class:`IoTTwinMaker.Client.exceptions.InternalServerException`

  
  *   :py:class:`IoTTwinMaker.Client.exceptions.AccessDeniedException`

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

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

  
  *   :py:class:`IoTTwinMaker.Client.exceptions.ValidationException`

  