SageMaker / Client / update_pipeline

update_pipeline

SageMaker.Client.update_pipeline(**kwargs)

Updates a pipeline.

See also: AWS API Documentation

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
    },
    PipelineVersionAliases=[
        'string',
    ]
)
Parameters:

  • PipelineName (string) –

    [REQUIRED]

    The name of the pipeline to update.

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

  • PipelineDefinition (string) – The JSON pipeline definition.

  • PipelineDefinitionS3Location (dict) –

    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.

  • PipelineDescription (string) – The description of the pipeline.

  • RoleArn (string) – The Amazon Resource Name (ARN) that the pipeline uses to execute.

  • ParallelismConfiguration (dict) –

    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.

  • PipelineVersionAliases (list) –

    The aliases to assign to the new pipeline version that this update creates. You can specify aliases only when the update changes the pipeline definition. To change the aliases of an existing version, use UpdatePipelineVersion.

    An alias must be unique within the pipeline. To move an alias from an existing version to the new version, first remove the alias from the existing version with UpdatePipelineVersion.

    • (string) –

Return type:

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