SageMaker / Client / start_pipeline_execution

start_pipeline_execution

SageMaker.Client.start_pipeline_execution(**kwargs)

Starts a pipeline execution.

See also: AWS API Documentation

Request Syntax

response = client.start_pipeline_execution(
    PipelineName='string',
    PipelineExecutionDisplayName='string',
    PipelineParameters=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    PipelineExecutionDescription='string',
    ClientRequestToken='string',
    ParallelismConfiguration={
        'MaxParallelExecutionSteps': 123
    },
    SelectiveExecutionConfig={
        'SourcePipelineExecutionArn': 'string',
        'SelectedSteps': [
            {
                'StepName': 'string'
            },
        ]
    }
)

Parameters:

• PipelineName (string) –

  [REQUIRED]

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

• PipelineExecutionDisplayName (string) – The display name of the pipeline execution.

• PipelineParameters (list) –

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

  • (dict) –

    Assigns a value to a named Pipeline parameter.

    • Name (string) – [REQUIRED]

      The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.

    • Value (string) – [REQUIRED]

      The literal value for the parameter.

• PipelineExecutionDescription (string) – The description of the pipeline execution.

• ClientRequestToken (string) –

  [REQUIRED]

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

  This field is autopopulated if not provided.

• ParallelismConfiguration (dict) –

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

  • MaxParallelExecutionSteps (integer) – [REQUIRED]

    The max number of steps that can be executed in parallel.

• SelectiveExecutionConfig (dict) –

  The selective execution configuration applied to the pipeline run.

  • SourcePipelineExecutionArn (string) – [REQUIRED]

    The ARN from a reference execution of the current pipeline. Used to copy input collaterals needed for the selected steps to run. The execution status of the pipeline can be either Failed or Success.

  • SelectedSteps (list) – [REQUIRED]

    A list of pipeline steps to run. All step(s) in all path(s) between two selected steps should be included.

    • (dict) –

      A step selected to run in selective execution mode.

      • StepName (string) – [REQUIRED]

        The name of the pipeline step.

Return type:

dict

Returns:

Response Syntax

{
    'PipelineExecutionArn': 'string'
}

Response Structure

• (dict) –

  • PipelineExecutionArn (string) –

    The Amazon Resource Name (ARN) of the pipeline execution.

Exceptions

• SageMaker.Client.exceptions.ResourceNotFound

• SageMaker.Client.exceptions.ResourceLimitExceeded