Method
describePipelineStepByName GET
Copy GET

Describes a pipeline step by the step name.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes pipelineId str The ID of the pipeline.
Yes stepName str The name of the step.
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 PipelineStep
KEY TYPE Description
pipelineStepId str The reference to this step.
pipelineId str The reference to the pipeline this step belongs to.
stepName str The name of the step.
pipelineName str The name of the pipeline this step is a part of.
createdAt str The date and time which this step was created.
updatedAt str The date and time when this step was last updated.
pythonFunctionId str The python function_id.
stepDependencies List[str] List of steps this step depends on.
cpuSize str CPU size specified for the step function.
memory int Memory in GB specified for the step function.
timeout int Timeout for the step in minutes, default is 300 minutes.
pythonFunction PythonFunction Information about the python function for the step.
KEY TYPE Description
notebookId str The unique identifier of the notebook used to spin up the notebook upon creation.
name str The name to identify the algorithm, only uppercase letters, numbers, and underscores allowed (i.e. it must be a valid Python identifier)
createdAt str The ISO-8601 string representing when the Python function was created.
functionVariableMappings dict A description of the function variables.
outputVariableMappings dict A description of the variables returned by the function
functionName str The name of the Python function to be used.
pythonFunctionId str The unique identifier of the Python function.
functionType str The type of the Python function.
packageRequirements list The pip package dependencies required to run the code
codeSource CodeSource Information about the source code of the Python function.
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 about the source code of the step function.
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

Exceptions:

TYPE WHEN
DataNotFoundError

pipelineId is not found.
Language:

© Copyright