Method
runPipeline POST
Copy POST

Runs a specified pipeline with the arguments provided.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes pipelineId str The ID of the pipeline to run.
No pipelineVariableMappings List[PythonFunctionArgument] List of Python function arguments for the pipeline.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result PipelineVersion
KEY TYPE Description
pipelineName str The name of the pipeline this step is a part of.
pipelineId str The reference to the pipeline this step belongs to.
pipelineVersion str The reference to this pipeline version.
createdAt str The date and time which this pipeline version was created.
updatedAt str The date and time which this pipeline version was updated.
completedAt str The date and time which this pipeline version was updated.
status str The status of the pipeline version.
error str The relevant error, if the status is FAILED.
stepVersions PipelineStepVersion A list of the pipeline step versions.
KEY TYPE Description
stepName str The name of the step.
pipelineStepVersion str The reference to the pipeline step version.
pipelineStepId str The reference to this step.
pipelineId str The reference to the pipeline this step belongs to.
pipelineVersion str The reference to the pipeline version.
createdAt str The date and time which this step was created.
updatedAt str The date and time when this step was last updated.
status str The status of the pipeline version.
error str The error message if the pipeline step failed.
outputErrors str The error message of a pipeline step's output.
pythonFunctionId str The reference to the python function
functionVariableMappings dict The mappings for function parameters' names.
stepDependencies List[str] List of steps this step depends on.
outputVariableMappings dict The mappings for the output variables to the step.
cpuSize str CPU size specified for the step function.
memory int Memory in GB specified for the step function.
timeout int The timeout in minutes for the pipeline step.
pipelineStepVersionReferences PipelineStepVersionReference A list to the output instances of the pipeline step version.
KEY TYPE Description
pipelineStepVersionReferenceId str The id of the reference.
pipelineStepVersion str The pipeline step version the reference is connected to.
objectType str The object type of the reference.
datasetVersion str The dataset version the reference is connected to.
modelVersion str The model version the reference is connected to.
deploymentVersion str The deployment version the reference is connected to.
batchPredictionId str The batch prediction id the reference is connected to.
modelMonitorVersion str The model monitor version the reference is connected to.
notebookVersion str The notebook version the reference is connected to.
featureGroupVersion str The feature group version the reference is connected to.
status str The status of the reference
error str The error message if the reference is in an error state.
codeSource CodeSource Information about the source code of the pipeline step version.
KEY TYPE Description
sourceType str The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR
sourceCode str If the type of the source is TEXT, the raw text of the function
applicationConnectorId str The Application Connector to fetch the code from
applicationConnectorInfo str Args passed to the application connector to fetch the code
packageRequirements list The pip package dependencies required to run the code
status str The status of the code and validations
error str If the status is failed, an error message describing what went wrong
publishingMsg dict Warnings in the source code
moduleDependencies list The list of internal modules dependencies required to run the code
codeSource CodeSource information on the source code
KEY TYPE Description
sourceType str The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR
sourceCode str If the type of the source is TEXT, the raw text of the function
applicationConnectorId str The Application Connector to fetch the code from
applicationConnectorInfo str Args passed to the application connector to fetch the code
packageRequirements list The pip package dependencies required to run the code
status str The status of the code and validations
error str If the status is failed, an error message describing what went wrong
publishingMsg dict Warnings in the source code
moduleDependencies list The list of internal modules dependencies required to run the code
pipelineVariableMappings PythonFunctionArgument A description of the function variables into the pipeline.
KEY TYPE Description
variableType PythonFunctionArgumentType The type of the python function argument
name str The name of the python function variable
pipelineVariable str The name of the pipeline variable to use as the value
isRequired bool Whether the argument is required
value Any The value of the argument

Exceptions:

TYPE WHEN
DataNotFoundError

pipelineId is not found.
Language:

© Copyright