update-pipeline¶
Description¶
Updates a pipeline.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
update-pipeline
--pipeline-name <value>
[--pipeline-display-name <value>]
[--pipeline-definition <value>]
[--pipeline-definition-s3-location <value>]
[--pipeline-description <value>]
[--role-arn <value>]
[--parallelism-configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--pipeline-name (string)
The name of the pipeline to update.
--pipeline-display-name (string)
The display name of the pipeline.
--pipeline-definition (string)
The JSON pipeline definition.
--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)
The description of the pipeline.
--role-arn (string)
The Amazon Resource Name (ARN) that the pipeline uses to execute.
--parallelism-configuration (structure)
If specified, it applies to all executions 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 | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.