Method
createPipelineStep POST
Copy POST

Creates a step in a given pipeline.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes pipelineId str The ID of the pipeline to run.
Yes stepName str The name of the step.
No functionName str The name of the Python function.
No sourceCode str Contents of a valid Python source code file. The source code should contain the transform feature group functions. A list of allowed imports and system libraries for each language is specified in the user functions documentation section.
No stepInputMappings List[PythonFunctionArgument] List of Python function arguments.
No outputVariableMappings List[OutputVariableMapping] List of Python function outputs.
No stepDependencies List[str] List of step names this step depends on.
No packageRequirements list List of package requirement strings. For example: ['numpy==1.2.3', 'pandas>=1.4.0'].
No cpuSize str Size of the CPU for the step function.
No memory int Memory (in GB) for the step function.
No timeout int Timeout for the step in minutes, default is 300 minutes.
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 Pipeline
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.
createdAt str The date and time which the pipeline was created.
notebookId str The reference to the notebook this pipeline belongs to.
cron str A cron-style string that describes when this refresh policy is to be executed in UTC
nextRunTime str The next time this pipeline will be run.
isProd bool Whether this pipeline is a production pipeline.
warning str Warning message for possible errors that might occur if the pipeline is run.
createdBy str The email of the user who created the pipeline
steps PipelineStep A list of the pipeline steps attached to the pipeline.
pipelineReferences PipelineReference A list of references from the pipeline to other objects
latestPipelineVersion PipelineVersion The latest version of the pipeline.
codeSource CodeSource information on the source code
pipelineVariableMappings PythonFunctionArgument A description of the function variables into the pipeline.

Exceptions:

TYPE WHEN
DataNotFoundError

pipelineId is not found.
InvalidEnumParameterError

An invalid value is passed for cpuSize.
Language:

python

Request
client.createPipelineStep(pipeline_id='c277bc341',
                          step_name='double_things',
                          function_name='double_val',
                          source_code='def double_val(some_constant: int):\n    return {'doubled': some_constant * 2}\n',
                          step_input_mappings=[
                              {'name': 'some_constant', 'variable_type': 'INTEGER', 'pipeline_variable': 'dataset_refresh.constant_val'}],
                          output_variable_mappings=[
                              {'name': 'doubled', 'variable_type': 'INTEGER'}],
                          step_dependencies=['dataset_refresh'])

Response
Pipeline(
    created_at='2023-04-13T15:39:55+00:00',
    pipeline_id='c277bc341',
    pipeline_name='test_pipeline',
    pipeline_variable_mappings=[
        PythonFunctionArgument(
            is_required=True,
            name='dataset_id',
            variable_type='STRING'
        )
    ],
    steps=[
        PipelineStep(
            created_at='2023-04-13T15:39:55+00:00',
            pipeline_id='c277bc341',
            pipeline_step_id='c63168d41',
            python_function=PythonFunction(
                function_type'='STEP_FUNCTION',
                function_variable_mappings=[{'is_required': True,
                                             'name': 'dataset_id',
                                             'variable_type': 'STRING'}],
                notebook_id='9df7a9a82',
                output_variable_mappings=[{'name': 'new_dataset_id',
                                           'variable_type': 'STRING'},
                                          {'name': 'constant_val',
                                           'variable_type': 'INTEGER'}],
                python_function_id='139ad50341'},
            python_function_id='139ad50341',
            step_name='dataset_refresh',
            created_at='2023-04-13T15:39:55+00:00',
        ),
        PipelineStep(
            created_at='2023-04-13T15:39:55+00:00',
            pipeline_id='c277bc341',
            pipeline_step_id='136b44f482',
            'pythonFunction'=PythonFunction(
                function_type'='STEP_FUNCTION',
                function_variable_mappings=[{'is_required': True,
                                             'name': 'some_constant',
                                             'pipeline_variable': 'dataset_refresh.constant_val',
                                             'variable_type': 'INTEGER'}],
                notebook_id='10e7a901c3',
                output_variable_mappings=[{'name': 'doubled',
                                           'variable_type': 'INTEGER'}],
                python_function_id='35a8c8282'},
            python_function_id='35a8c8282',
            step_name='double_things',
            created_at='2023-04-13T15:39:55+00:00',
        )
    ]
)
© Copyright 2025