CreatePipeline - Amazon SageMaker (original) (raw)

Creates a pipeline using a JSON pipeline definition.

Request Syntax

{
   "ClientRequestToken": "string",
   "ParallelismConfiguration": { 
      "MaxParallelExecutionSteps": number
   },
   "PipelineDefinition": "string",
   "PipelineDefinitionS3Location": { 
      "Bucket": "string",
      "ObjectKey": "string",
      "VersionId": "string"
   },
   "PipelineDescription": "string",
   "PipelineDisplayName": "string",
   "PipelineName": "string",
   "RoleArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClientRequestToken

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

Type: String

Length Constraints: Minimum length of 32. Maximum length of 128.

Required: Yes

ParallelismConfiguration

This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.

Type: ParallelismConfiguration object

Required: No

PipelineDefinition

The JSON pipeline definition of the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1048576.

Pattern: .*(?:[ \r\n\t].*)*

Required: No

PipelineDefinitionS3Location

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

Type: PipelineDefinitionS3Location object

Required: No

PipelineDescription

A description of the pipeline.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 3072.

Pattern: .*

Required: No

PipelineDisplayName

The display name of the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}

Required: No

PipelineName

The name of the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}

Required: Yes

RoleArn

The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Required: Yes

Tags

A list of tags to apply to the created pipeline.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Response Syntax

{
   "PipelineArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PipelineArn

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:([0-9]{12}|aws):pipeline/.*

Errors

For information about the errors that are common to all actions, see Common Error Types.

ConflictException

There was a conflict when you attempted to modify a SageMaker entity such as anExperiment or Artifact.

HTTP Status Code: 400

ResourceLimitExceeded

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: