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

*************
delete_entity
*************



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

  

  Deletes an entity.

  

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


  **Request Syntax**
  ::

    response = client.delete_entity(
        workspaceId='string',
        entityId='string',
        isRecursive=True|False
    )
    
  :type workspaceId: string
  :param workspaceId: **[REQUIRED]** 

    The ID of the workspace that contains the entity to delete.

    

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

    The ID of the entity to delete.

    

  
  :type isRecursive: boolean
  :param isRecursive: 

    A Boolean value that specifies whether the operation deletes child entities.

    

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

    
    ::

      {
          'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The current state of the deleted entity.

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

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

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

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

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

  