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

*************
list_entities
*************



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

  

  Lists all entities in a workspace.

  

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


  **Request Syntax**
  ::

    response = client.list_entities(
        workspaceId='string',
        filters=[
            {
                'parentEntityId': 'string',
                'componentTypeId': 'string',
                'externalId': 'string'
            },
        ],
        maxResults=123,
        nextToken='string'
    )
    
  :type workspaceId: string
  :param workspaceId: **[REQUIRED]** 

    The ID of the workspace.

    

  
  :type filters: list
  :param filters: 

    A list of objects that filter the request.

     

    .. note::

      

      Only one object is accepted as a valid input.

      

    

  
    - *(dict) --* 

      An object that filters items in a list of entities.

      .. note::    This is a Tagged Union structure. Only one of the     following top level keys can be set: ``parentEntityId``, ``componentTypeId``, ``externalId``. 

    
      - **parentEntityId** *(string) --* 

        The parent of the entities in the list.

        

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

        The ID of the component type in the entities in the list.

        

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

        The external-Id property of a component. The external-Id property is the primary key of an external storage system.

        

      
    

  :type maxResults: integer
  :param maxResults: 

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

     

    Valid Range: Minimum value of 1. Maximum value of 250.

    

  
  :type nextToken: string
  :param nextToken: 

    The string that specifies the next page of results.

    

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

    
    ::

      {
          'entitySummaries': [
              {
                  'entityId': 'string',
                  'entityName': 'string',
                  'arn': 'string',
                  'parentEntityId': 'string',
                  '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'
                      }
                  },
                  'description': 'string',
                  'hasChildEntities': True|False,
                  'creationDateTime': datetime(2015, 1, 1),
                  'updateDateTime': datetime(2015, 1, 1)
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **entitySummaries** *(list) --* 

        A list of objects that contain information about the entities.

        
        

        - *(dict) --* 

          An object that contains information about an entity.

          
          

          - **entityId** *(string) --* 

            The ID of the entity.

            
          

          - **entityName** *(string) --* 

            The name of the entity.

            
          

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

            The ARN of the entity.

            
          

          - **parentEntityId** *(string) --* 

            The ID of the parent entity.

            
          

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

            The current status of the entity.

            
            

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

                
          
        
          

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

            The description of the entity.

            
          

          - **hasChildEntities** *(boolean) --* 

            An **eventual** Boolean value that specifies whether the entity has child entities or not.

            
          

          - **creationDateTime** *(datetime) --* 

            The date and time when the entity was created.

            
          

          - **updateDateTime** *(datetime) --* 

            The last date and time when the entity was updated.

            
      
    
      

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

        The string that specifies the next page of results.

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

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

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

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

  