Skip to content

update_pipeline_version

update_pipeline_version(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    pipeline_arn: Optional[PipelineArn] = None,
    pipeline_version_id: Optional[PipelineVersionId] = None,
    pipeline_version_display_name: Optional[PipelineVersionName] = None,
    pipeline_version_description: Optional[PipelineVersionDescription] = None,
) -> UpdatePipelineVersionResponse

Updates a pipeline version.

Parameters:

Raises:

  • ConflictException –

    There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.

  • ResourceNotFound –

    Resource being access is not found.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def update_pipeline_version(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    pipeline_arn: Optional["capo_sagemaker.types.pipeline_arn.PipelineArn"] = None,
    pipeline_version_id: Optional[
        "capo_sagemaker.types.pipeline_version_id.PipelineVersionId"
    ] = None,
    pipeline_version_display_name: Optional[
        "capo_sagemaker.types.pipeline_version_name.PipelineVersionName"
    ] = None,
    pipeline_version_description: Optional[
        "capo_sagemaker.types.pipeline_version_description.PipelineVersionDescription"
    ] = None,
) -> "capo_sagemaker.types.update_pipeline_version_response.UpdatePipelineVersionResponse":
    """<p>Updates a pipeline version.</p>

    Args:
        pipeline_arn: <p>The Amazon Resource Name (ARN) of the pipeline.</p>
        pipeline_version_id: <p>The pipeline version ID to update.</p>
        pipeline_version_display_name: <p>The display name of the pipeline version.</p>
        pipeline_version_description: <p>The description of the pipeline version.</p>

    Raises:
        capo_sagemaker.errors.conflict_exception.ConflictException: <p>There was a conflict when you attempted to modify a SageMaker entity such as an <code>Experiment</code> or <code>Artifact</code>.</p>
        capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.update_pipeline_version_request.UpdatePipelineVersionRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.update_pipeline_version_response.UpdatePipelineVersionResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.update_pipeline_version

        output, http_response = (
            capo_sagemaker._operations.sage_maker.update_pipeline_version.update_pipeline_version(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdatePipelineVersion")
    )
    input_: capo_sagemaker.types.update_pipeline_version_request.UpdatePipelineVersionRequest = {}
    if pipeline_arn is not None:
        input_["pipeline_arn"] = pipeline_arn
    if pipeline_version_id is not None:
        input_["pipeline_version_id"] = pipeline_version_id
    if pipeline_version_display_name is not None:
        input_["pipeline_version_display_name"] = pipeline_version_display_name
    if pipeline_version_description is not None:
        input_["pipeline_version_description"] = pipeline_version_description

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output