IoTTwinMaker / Client / delete_entity
delete_entity#
- IoTTwinMaker.Client.delete_entity(**kwargs)#
Deletes an entity.
See also: AWS API Documentation
Request Syntax
response = client.delete_entity( workspaceId='string', entityId='string', isRecursive=True|False )
- Parameters:
workspaceId (string) –
[REQUIRED]
The ID of the workspace that contains the entity to delete.
entityId (string) –
[REQUIRED]
The ID of the entity to delete.
isRecursive (boolean) – A Boolean value that specifies whether the operation deletes child entities.
- Return type:
dict
- Returns:
Response Syntax
{ 'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'ERROR' }
Response Structure
(dict) –
state (string) –
The current state of the deleted entity.
Exceptions
IoTTwinMaker.Client.exceptions.InternalServerException
IoTTwinMaker.Client.exceptions.ResourceNotFoundException
IoTTwinMaker.Client.exceptions.ThrottlingException
IoTTwinMaker.Client.exceptions.ValidationException
IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException