Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]

create-pipeline

Description

Creates a pipeline using a JSON pipeline definition.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-pipeline
--pipeline-name <value>
[--pipeline-display-name <value>]
[--pipeline-definition <value>]
[--pipeline-definition-s3-location <value>]
[--pipeline-description <value>]
[--client-request-token <value>]
--role-arn <value>
[--tags <value>]
[--parallelism-configuration <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--pipeline-name (string)

The name of the pipeline.

--pipeline-display-name (string)

The display name of the pipeline.

--pipeline-definition (string)

The JSON pipeline definition of the pipeline.

--pipeline-definition-s3-location (structure)

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

Bucket -> (string)

Name of the S3 bucket.

ObjectKey -> (string)

The object key (or key name) uniquely identifies the object in an S3 bucket.

VersionId -> (string)

Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.

Shorthand Syntax:

Bucket=string,ObjectKey=string,VersionId=string

JSON Syntax:

{
  "Bucket": "string",
  "ObjectKey": "string",
  "VersionId": "string"
}

--pipeline-description (string)

A description of the pipeline.

--client-request-token (string)

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

--role-arn (string)

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

--tags (list)

A list of tags to apply to the created pipeline.

(structure)

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags .

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources . For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy .

Key -> (string)

The tag key. Tag keys must be unique per resource.

Value -> (string)

The tag value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--parallelism-configuration (structure)

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

MaxParallelExecutionSteps -> (integer)

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

Shorthand Syntax:

MaxParallelExecutionSteps=integer

JSON Syntax:

{
  "MaxParallelExecutionSteps": integer
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

PipelineArn -> (string)

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