- 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.
CreatePipelineCommand
Creates a pipeline using a JSON pipeline definition.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SageMakerClient, CreatePipelineCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import
// const { SageMakerClient, CreatePipelineCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import
const client = new SageMakerClient(config);
const input = { // CreatePipelineRequest
PipelineName: "STRING_VALUE", // required
PipelineDisplayName: "STRING_VALUE",
PipelineDefinition: "STRING_VALUE",
PipelineDefinitionS3Location: { // PipelineDefinitionS3Location
Bucket: "STRING_VALUE", // required
ObjectKey: "STRING_VALUE", // required
VersionId: "STRING_VALUE",
},
PipelineDescription: "STRING_VALUE",
ClientRequestToken: "STRING_VALUE", // required
RoleArn: "STRING_VALUE", // required
Tags: [ // TagList
{ // Tag
Key: "STRING_VALUE", // required
Value: "STRING_VALUE", // required
},
],
ParallelismConfiguration: { // ParallelismConfiguration
MaxParallelExecutionSteps: Number("int"), // required
},
};
const command = new CreatePipelineCommand(input);
const response = await client.send(command);
// { // CreatePipelineResponse
// PipelineArn: "STRING_VALUE",
// };
CreatePipelineCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
PipelineName Required | string | undefined | The name of the pipeline. |
RoleArn Required | string | undefined | The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources. |
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 one time. |
ParallelismConfiguration | ParallelismConfiguration | undefined | This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default. |
PipelineDefinition | string | undefined | The JSON pipeline definition of the pipeline. |
PipelineDefinitionS3Location | PipelineDefinitionS3Location | undefined | The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location. |
PipelineDescription | string | undefined | A description of the pipeline. |
PipelineDisplayName | string | undefined | The display name of the pipeline. |
Tags | Tag[] | undefined | A list of tags to apply to the created pipeline. |
CreatePipelineCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
PipelineArn | string | undefined | The Amazon Resource Name (ARN) of the created pipeline. |
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. |