- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
StartPipelineExecutionCommand
Starts a pipeline execution.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SageMakerClient, StartPipelineExecutionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import
// const { SageMakerClient, StartPipelineExecutionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import
const client = new SageMakerClient(config);
const input = { // StartPipelineExecutionRequest
PipelineName: "STRING_VALUE", // required
PipelineExecutionDisplayName: "STRING_VALUE",
PipelineParameters: [ // ParameterList
{ // Parameter
Name: "STRING_VALUE", // required
Value: "STRING_VALUE", // required
},
],
PipelineExecutionDescription: "STRING_VALUE",
ClientRequestToken: "STRING_VALUE", // required
ParallelismConfiguration: { // ParallelismConfiguration
MaxParallelExecutionSteps: Number("int"), // required
},
SelectiveExecutionConfig: { // SelectiveExecutionConfig
SourcePipelineExecutionArn: "STRING_VALUE",
SelectedSteps: [ // SelectedStepList // required
{ // SelectedStep
StepName: "STRING_VALUE", // required
},
],
},
};
const command = new StartPipelineExecutionCommand(input);
const response = await client.send(command);
// { // StartPipelineExecutionResponse
// PipelineExecutionArn: "STRING_VALUE",
// };
StartPipelineExecutionCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
PipelineName Required | string | undefined | The name or Amazon Resource Name (ARN) of the pipeline. |
ClientRequestToken | string | undefined | A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once. |
ParallelismConfiguration | ParallelismConfiguration | undefined | This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run. |
PipelineExecutionDescription | string | undefined | The description of the pipeline execution. |
PipelineExecutionDisplayName | string | undefined | The display name of the pipeline execution. |
PipelineParameters | Parameter[] | undefined | Contains a list of pipeline parameters. This list can be empty. |
SelectiveExecutionConfig | SelectiveExecutionConfig | undefined | The selective execution configuration applied to the pipeline run. |
StartPipelineExecutionCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
PipelineExecutionArn | string | undefined | The Amazon Resource Name (ARN) of the pipeline execution. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ConflictException | client | There was a conflict when you attempted to modify a SageMaker entity such as an |
ResourceLimitExceeded | client | You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created. |
ResourceNotFound | client | Resource being access is not found. |
SageMakerServiceException | Base exception class for all service exceptions from SageMaker service. |