Skip to content

StartPipelineExecutionRequest

Source code in docs_src/capo_sagemaker/types/start_pipeline_execution_request.py
class StartPipelineExecutionRequest(TypedDict, closed=True):
    pipeline_name: NotRequired[
        "capo_sagemaker.types.pipeline_name_or_arn.PipelineNameOrArn"
    ]
    """<p>The name or Amazon Resource Name (ARN) of the pipeline.</p>"""
    pipeline_execution_display_name: NotRequired[
        "capo_sagemaker.types.pipeline_execution_name.PipelineExecutionName"
    ]
    """<p>The display name of the pipeline execution.</p>"""
    pipeline_parameters: NotRequired[
        "capo_sagemaker.types.parameter_list.ParameterList"
    ]
    """<p>Contains a list of pipeline parameters. This list can be empty. </p>"""
    pipeline_execution_description: NotRequired[
        "capo_sagemaker.types.pipeline_execution_description.PipelineExecutionDescription"
    ]
    """<p>The description of the pipeline execution.</p>"""
    client_request_token: NotRequired[
        "capo_sagemaker.types.idempotency_token.IdempotencyToken"
    ]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.</p>"""
    parallelism_configuration: NotRequired[
        "capo_sagemaker.types.parallelism_configuration.ParallelismConfiguration"
    ]
    """<p>This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.</p>"""
    selective_execution_config: NotRequired[
        "capo_sagemaker.types.selective_execution_config.SelectiveExecutionConfig"
    ]
    """<p>The selective execution configuration applied to the pipeline run.</p>"""
    pipeline_version_id: NotRequired[
        "capo_sagemaker.types.pipeline_version_id.PipelineVersionId"
    ]
    """<p>The ID of the pipeline version to start execution from.</p>"""
    mlflow_experiment_name: NotRequired[
        "capo_sagemaker.types.mlflow_experiment_entity_name.MlflowExperimentEntityName"
    ]
    """<p> The MLflow experiment name of the pipeline execution. </p>"""

client_request_token instance-attribute

client_request_token: NotRequired[IdempotencyToken]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

mlflow_experiment_name instance-attribute

mlflow_experiment_name: NotRequired[MlflowExperimentEntityName]

The MLflow experiment name of the pipeline execution.

parallelism_configuration instance-attribute

parallelism_configuration: NotRequired[ParallelismConfiguration]

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

pipeline_execution_description instance-attribute

pipeline_execution_description: NotRequired[PipelineExecutionDescription]

The description of the pipeline execution.

pipeline_execution_display_name instance-attribute

pipeline_execution_display_name: NotRequired[PipelineExecutionName]

The display name of the pipeline execution.

pipeline_name instance-attribute

pipeline_name: NotRequired[PipelineNameOrArn]

The name or Amazon Resource Name (ARN) of the pipeline.

pipeline_parameters instance-attribute

pipeline_parameters: NotRequired[ParameterList]

Contains a list of pipeline parameters. This list can be empty.

pipeline_version_id instance-attribute

pipeline_version_id: NotRequired[PipelineVersionId]

The ID of the pipeline version to start execution from.

selective_execution_config instance-attribute

selective_execution_config: NotRequired[SelectiveExecutionConfig]

The selective execution configuration applied to the pipeline run.