Cancel transformation run by id

async AsyncCogniteClient.transformations.cancel(

transformation_id: int | None = None,

transformation_external_id: str | None = None,

) → None

Cancel a running transformation.

Parameters:

• transformation_id (int | None) – Transformation internal id

• transformation_external_id (str | None) – Transformation external id

Examples

Wait transformation for 1 minute and cancel if still running:

>>> from cognite.client import CogniteClient
>>> from cognite.client.data_classes import TransformationJobStatus
>>> client = CogniteClient()
>>>
>>> res = client.transformations.run(transformation_id=1, timeout=60.0)
>>> if res.status == TransformationJobStatus.RUNNING:
>>>     res.cancel()