update_pipeline ¶

def update_pipeline(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    pipeline_name: Optional[
        "capo_sagemaker.types.pipeline_name.PipelineName"
    ] = None,
    pipeline_display_name: Optional[
        "capo_sagemaker.types.pipeline_name.PipelineName"
    ] = None,
    pipeline_definition: Optional[
        "capo_sagemaker.types.pipeline_definition.PipelineDefinition"
    ] = None,
    pipeline_definition_s3_location: Optional[
        "capo_sagemaker.types.pipeline_definition_s3_location.PipelineDefinitionS3Location"
    ] = None,
    pipeline_description: Optional[
        "capo_sagemaker.types.pipeline_description.PipelineDescription"
    ] = None,
    role_arn: Optional["capo_sagemaker.types.role_arn.RoleArn"] = None,
    parallelism_configuration: Optional[
        "capo_sagemaker.types.parallelism_configuration.ParallelismConfiguration"
    ] = None,
) -> "capo_sagemaker.types.update_pipeline_response.UpdatePipelineResponse":
    """<p>Updates a pipeline.</p>

    Args:
        pipeline_name: <p>The name of the pipeline to update.</p>
        pipeline_display_name: <p>The display name of the pipeline.</p>
        pipeline_definition: <p>The JSON pipeline definition.</p>
        pipeline_definition_s3_location: <p>The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.</p>
        pipeline_description: <p>The description of the pipeline.</p>
        role_arn: <p>The Amazon Resource Name (ARN) that the pipeline uses to execute.</p>
        parallelism_configuration: <p>If specified, it applies to all executions of this pipeline by default.</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_request.UpdatePipelineRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.update_pipeline_response.UpdatePipelineResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.update_pipeline

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdatePipeline")
    )
    input_: capo_sagemaker.types.update_pipeline_request.UpdatePipelineRequest = {}
    if pipeline_name is not None:
        input_["pipeline_name"] = pipeline_name
    if pipeline_display_name is not None:
        input_["pipeline_display_name"] = pipeline_display_name
    if pipeline_definition is not None:
        input_["pipeline_definition"] = pipeline_definition
    if pipeline_definition_s3_location is not None:
        input_["pipeline_definition_s3_location"] = pipeline_definition_s3_location
    if pipeline_description is not None:
        input_["pipeline_description"] = pipeline_description
    if role_arn is not None:
        input_["role_arn"] = role_arn
    if parallelism_configuration is not None:
        input_["parallelism_configuration"] = parallelism_configuration

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