Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdatePipelineExecution

Updates a pipeline execution.

Request Syntax


{
   "ParallelismConfiguration": { 
      "MaxParallelExecutionSteps": number
   },
   "PipelineExecutionArn": "string",
   "PipelineExecutionDescription": "string",
   "PipelineExecutionDisplayName": "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

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

Type: ParallelismConfiguration object

Required: No

PipelineExecutionArn

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

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*$

Required: Yes

PipelineExecutionDescription

The description of the pipeline execution.

Type: String

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

Pattern: .*

Required: No

PipelineExecutionDisplayName

The display name of the pipeline execution.

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

Response Syntax


{
   "PipelineExecutionArn": "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.

PipelineExecutionArn

The Amazon Resource Name (ARN) of the updated pipeline execution.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*$

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 Experiment or Artifact.

HTTP Status Code: 400

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400