UpdatePipeline
Updates a pipeline.
Request Syntax
{
"ParallelismConfiguration": {
"MaxParallelExecutionSteps": number
},
"PipelineDefinition": "string",
"PipelineDefinitionS3Location": {
"Bucket": "string",
"ObjectKey": "string",
"VersionId": "string"
},
"PipelineDescription": "string",
"PipelineDisplayName": "string",
"PipelineName": "string",
"PipelineVersionAliases": [ "string" ],
"RoleArn": "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.
- ParallelismConfiguration
-
If specified, it applies to all executions of this pipeline by default.
Type: ParallelismConfiguration object
Required: No
- PipelineDefinition
-
The JSON pipeline definition.
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
-
The 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 to update.
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
- PipelineVersionAliases
-
The aliases to assign to the new pipeline version that this update creates. You can specify aliases only when the update changes the pipeline definition. To change the aliases of an existing version, use
UpdatePipelineVersion.An alias must be unique within the pipeline. To move an alias from an existing version to the new version, first remove the alias from the existing version with
UpdatePipelineVersion.Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9._\-]{1,128}Required: No
- RoleArn
-
The Amazon Resource Name (ARN) that the pipeline uses to execute.
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: No
Response Syntax
{
"PipelineArn": "string",
"PipelineVersionId": number
}
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 updated 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/.* - PipelineVersionId
-
The ID of the pipeline version.
Type: Long
Valid Range: Minimum value of 1.
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 an
ExperimentorArtifact.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: