UpdatePipelineVersion
Updates a pipeline version.
Request Syntax
{
"PipelineArn": "string",
"PipelineVersionDescription": "string",
"PipelineVersionDisplayName": "string",
"PipelineVersionId": number
}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.
- PipelineArn
-
The Amazon Resource Name (ARN) of the 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}:pipeline/.*Required: Yes
- PipelineVersionDescription
-
The description of the pipeline version.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 3072.
Pattern:
.*Required: No
- PipelineVersionDisplayName
-
The display name of the pipeline version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 82.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}Required: No
- PipelineVersionId
-
The pipeline version ID to update.
Type: Long
Valid Range: Minimum value of 1.
Required: Yes
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 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}: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 Errors.
- 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:
