arcgis.datapipelines module

run_data_pipeline

arcgis.datapipelines.run_data_pipeline(item: Item, gis: GIS | None = None) → PipelineRun

Runs the data pipeline item. Running data pipelines consumes credits for the time it takes the run to complete.

Note

This method is experimental. All parameters and return types are subject to change.

Note

This method is supported with ArcGIS Online only.

Parameter	Description
item	Required `Item`. The item of type Data Pipeline to run.
gis	Optional `GIS`. The Web GIS connection used to run the operation. If the value is None, then the item’s GIS object will be used.

Note

Raises an Exception if the user or organization does not have access to Data Pipelines or if a run is already in progress for the item.

class arcgis.datapipelines._pipelines.PipelineRun(url: str, session: EsriSession)

Represents a single run of a Data Pipeline process.

Note

This class is experimental. All properties, methods, and responses are subject to change.

Parameter	Description
url	Required String. The url of the data pipeline endpoint.
session	Required EsriSession. The connection object.

cancel() → bool

Terminates the current run.

:returns:bool

property properties: dict[str, Any]

Returns the properties of the run

result() → dict[str, Any]

Gets the run results. This operation will pause the thread when called until the data pipeline run finishes.

property status: RunStatus | dict[str, Any]

Checks the Job’s status