DeletePipeline
Deletes a pipeline if there are no running instances of the pipeline. To delete a
pipeline, you must stop all running instances of the pipeline using the
StopPipelineExecution API. When you delete a pipeline, all instances of the
pipeline are deleted.
Request Syntax
{
"ClientRequestToken": "string",
"PipelineName": "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.
- ClientRequestToken
-
A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 128.
Required: Yes
- PipelineName
-
The name of the pipeline to delete.
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
Response Syntax
{
"PipelineArn": "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.
- PipelineArn
-
The Amazon Resource Name (ARN) of the pipeline to delete.
Type: String
Length Constraints: Maximum length of 2048.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline/.*
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:
