:doc:`SageMaker <../../sagemaker>` / Client / update_pipeline

***************
update_pipeline
***************



.. py:method:: SageMaker.Client.update_pipeline(**kwargs)

  

  Updates a pipeline.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdatePipeline>`_  


  **Request Syntax**
  ::

    response = client.update_pipeline(
        PipelineName='string',
        PipelineDisplayName='string',
        PipelineDefinition='string',
        PipelineDefinitionS3Location={
            'Bucket': 'string',
            'ObjectKey': 'string',
            'VersionId': 'string'
        },
        PipelineDescription='string',
        RoleArn='string',
        ParallelismConfiguration={
            'MaxParallelExecutionSteps': 123
        }
    )
    
  :type PipelineName: string
  :param PipelineName: **[REQUIRED]** 

    The name of the pipeline to update.

    

  
  :type PipelineDisplayName: string
  :param PipelineDisplayName: 

    The display name of the pipeline.

    

  
  :type PipelineDefinition: string
  :param PipelineDefinition: 

    The JSON pipeline definition.

    

  
  :type PipelineDefinitionS3Location: dict
  :param PipelineDefinitionS3Location: 

    The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

    

  
    - **Bucket** *(string) --* **[REQUIRED]** 

      Name of the S3 bucket.

      

    
    - **ObjectKey** *(string) --* **[REQUIRED]** 

      The object key (or key name) uniquely identifies the object in an S3 bucket.

      

    
    - **VersionId** *(string) --* 

      Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.

      

    
  
  :type PipelineDescription: string
  :param PipelineDescription: 

    The description of the pipeline.

    

  
  :type RoleArn: string
  :param RoleArn: 

    The Amazon Resource Name (ARN) that the pipeline uses to execute.

    

  
  :type ParallelismConfiguration: dict
  :param ParallelismConfiguration: 

    If specified, it applies to all executions of this pipeline by default.

    

  
    - **MaxParallelExecutionSteps** *(integer) --* **[REQUIRED]** 

      The max number of steps that can be executed in parallel.

      

    
  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'PipelineArn': 'string',
          'PipelineVersionId': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **PipelineArn** *(string) --* 

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

        
      

      - **PipelineVersionId** *(integer) --* 

        The ID of the pipeline version.

        
  
  **Exceptions**
  
  *   :py:class:`SageMaker.Client.exceptions.ConflictException`

  
  *   :py:class:`SageMaker.Client.exceptions.ResourceNotFound`

  