SageMaker / Client / update_pipeline_execution

update_pipeline_execution#

SageMaker.Client.update_pipeline_execution(**kwargs)#

Updates a pipeline execution.

See also: AWS API Documentation

Request Syntax

response = client.update_pipeline_execution(
    PipelineExecutionArn='string',
    PipelineExecutionDescription='string',
    PipelineExecutionDisplayName='string',
    ParallelismConfiguration={
        'MaxParallelExecutionSteps': 123
    }
)
Parameters:

  • PipelineExecutionArn (string) –

    [REQUIRED]

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

  • PipelineExecutionDescription (string) – The description of the pipeline execution.

  • PipelineExecutionDisplayName (string) – The display name of the pipeline execution.

  • ParallelismConfiguration (dict) –

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

    • MaxParallelExecutionSteps (integer) – [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'PipelineExecutionArn': 'string'
}

Response Structure

  • (dict) –

    • PipelineExecutionArn (string) –

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

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound

  • SageMaker.Client.exceptions.ConflictException