Skip to content

Start Pipeline Execution

sagemaker_start_pipeline_execution R Documentation

Starts a pipeline execution

Description

Starts a pipeline execution.

Usage

sagemaker_start_pipeline_execution(PipelineName,
  PipelineExecutionDisplayName, PipelineParameters,
  PipelineExecutionDescription, ClientRequestToken,
  ParallelismConfiguration, SelectiveExecutionConfig)

Arguments

PipelineName

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

PipelineExecutionDisplayName

The display name of the pipeline execution.

PipelineParameters

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

PipelineExecutionDescription

The description of the pipeline execution.

ClientRequestToken

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

ParallelismConfiguration

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

SelectiveExecutionConfig

The selective execution configuration applied to the pipeline run.

Value

A list with the following syntax:

list(
  PipelineExecutionArn = "string"
)

Request syntax

svc$start_pipeline_execution(
  PipelineName = "string",
  PipelineExecutionDisplayName = "string",
  PipelineParameters = list(
    list(
      Name = "string",
      Value = "string"
    )
  ),
  PipelineExecutionDescription = "string",
  ClientRequestToken = "string",
  ParallelismConfiguration = list(
    MaxParallelExecutionSteps = 123
  ),
  SelectiveExecutionConfig = list(
    SourcePipelineExecutionArn = "string",
    SelectedSteps = list(
      list(
        StepName = "string"
      )
    )
  )
)