feature: support for custom pipeline execution name (#2335)

Co-authored-by: Ahsan Khan <[email protected]>

Author: melzareix

src/sagemaker/workflow/pipeline.py

@@ -20,7 +20,6 @@
 
 import attr
 import botocore
-
 from botocore.exceptions import ClientError
 
 from sagemaker._studio import _append_project_tags
@@ -197,13 +196,15 @@ def delete(self) -> Dict[str, Any]:
     def start(
         self,
         parameters: Dict[str, Any] = None,
+        execution_display_name: str = None,
         execution_description: str = None,
     ):
         """Starts a Pipeline execution in the Workflow service.
 
         Args:
             parameters (List[Dict[str, str]]): A list of parameter dicts of the form
                 {"Name": "string", "Value": "string"}.
+            execution_display_name (str): The display name of the pipeline execution.
             execution_description (str): A description of the execution.
 
         Returns:
@@ -220,11 +221,13 @@ def start(
                 "This pipeline is not associated with a Pipeline in SageMaker. "
                 "Please invoke create() first before attempting to invoke start()."
             )
+
         kwargs = dict(PipelineName=self.name)
         update_args(
             kwargs,
             PipelineParameters=format_start_parameters(parameters),
             PipelineExecutionDescription=execution_description,
+            PipelineExecutionDisplayName=execution_display_name,
         )
         response = self.sagemaker_session.sagemaker_client.start_pipeline_execution(**kwargs)
         return _PipelineExecution(

tests/unit/sagemaker/workflow/test_pipeline.py

@@ -159,6 +159,12 @@ def test_pipeline_start(sagemaker_session_mock):
     assert sagemaker_session_mock.start_pipeline_execution.called_with(
         PipelineName="MyPipeline",
     )
+
+    pipeline.start(execution_display_name="pipeline-execution")
+    assert sagemaker_session_mock.start_pipeline_execution.called_with(
+        PipelineName="MyPipeline", PipelineExecutionDisplayName="pipeline-execution"
+    )
+
     pipeline.start(parameters=dict(alpha="epsilon"))
     assert sagemaker_session_mock.start_pipeline_execution.called_with(
         PipelineName="MyPipeline", PipelineParameters=[{"Name": "alpha", "Value": "epsilon"}]