pyapacheatlas.core.client.PurviewClient.update_entity_labels#

PurviewClient.update_entity_labels(labels, guid=None, typeName=None, qualifiedName=None, force_update=False)#

Update the given labels for one entity. Provide a list of strings that should be added. You can either provide the guid of the entity or the typeName and qualifiedName of the entity. By using force_update set to True you will overwrite the existing entity. force_update set to False will append to the existing entity.

Parameters

  • labels (list(str)) – The label(s) that should be appended or set.

  • 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)