pyapacheatlas.core.client.PurviewClient.delete_entity_labels#

PurviewClient.delete_entity_labels(labels, guid=None, typeName=None, qualifiedName=None)#

Delete the given labels for one entity. Provide a list of strings that should be removed. You can either provide the guid of the entity or the typeName and qualifiedName of the entity.

If you want to clear out an entity without knowing all the labels, you should consider update_entity_labels instead and set force_update to True.

Parameters

  • labels (list(str)) – The label(s) that should be removed.

  • guid (str) – The guid of the entity to be updated. Optional if using typeName and qualifiedName.

  • typeName (str) – The type name of the entity to be updated. Must also use qualifiedname with typeName. Not used if guid is provided.

  • qualifiedName (str) – The qualified name of the entity to be updated. Must also use typeName with qualifiedName. Not used if guid is provided.

Returns

A dict containing a message indicating success. Otherwise it will raise an AtlasException.

Return type

dict(str, str)