SageMaker / Client / delete_pipeline

delete_pipeline#

SageMaker.Client.delete_pipeline(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_pipeline(
    PipelineName='string',
    ClientRequestToken='string'
)
Parameters:

  • PipelineName (string) –

    [REQUIRED]

    The name of the pipeline to delete.

  • ClientRequestToken (string) –

    [REQUIRED]

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'PipelineArn': 'string'
}

Response Structure

  • (dict) –

    • PipelineArn (string) –

      The Amazon Resource Name (ARN) of the pipeline to delete.

Exceptions