SageMaker / Client / update_pipeline_version

update_pipeline_version

SageMaker.Client.update_pipeline_version(**kwargs)

Updates a pipeline version.

See also: AWS API Documentation

Request Syntax

response = client.update_pipeline_version(
    PipelineArn='string',
    PipelineVersionId=123,
    PipelineVersionDisplayName='string',
    PipelineVersionDescription='string',
    PipelineVersionAliasOperations={
        'Add': [
            'string',
        ],
        'Remove': [
            'string',
        ]
    }
)
Parameters:

  • PipelineArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the pipeline.

  • PipelineVersionId (integer) –

    [REQUIRED]

    The pipeline version ID to update.

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

  • PipelineVersionDescription (string) – The description of the pipeline version.

  • PipelineVersionAliasOperations (dict) –

    The aliases to add to or remove from the pipeline version.

    • Add (list) –

      The aliases to add to the pipeline version. If you assigned an alias to another version of the same pipeline, you must remove it from that version before you add it here.

      • (string) –

    • Remove (list) –

      The aliases to remove from the pipeline version.

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'PipelineArn': 'string',
    'PipelineVersionId': 123
}

Response Structure

  • (dict) –

    • PipelineArn (string) –

      The Amazon Resource Name (ARN) of the pipeline.

    • PipelineVersionId (integer) –

      The ID of the pipeline version.

Exceptions