Skip to content

update_pipeline async

update_pipeline(
    pipeline: PipelineDeclaration,
    *,
    config_overrides: Optional[AsyncCodePipelineClientConfig] = None,
) -> UpdatePipelineOutput

Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.

Parameters:

Raises:

Source code in docs_src/capo_codepipeline/_services/async_code_pipeline.py
async def update_pipeline(
    self,
    pipeline: "capo_codepipeline.types.pipeline_declaration.PipelineDeclaration",
    *,
    config_overrides: Optional[AsyncCodePipelineClientConfig] = None,
) -> "capo_codepipeline.types.update_pipeline_output.UpdatePipelineOutput":
    """<p>Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and <code>UpdatePipeline</code> to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.</p>

    Args:
        pipeline: <p>The name of the pipeline to be updated.</p>

    Raises:
        capo_codepipeline.errors.invalid_action_declaration_exception.InvalidActionDeclarationException: <p>The action declaration was specified in an invalid format.</p>
        capo_codepipeline.errors.invalid_blocker_declaration_exception.InvalidBlockerDeclarationException: <p>Reserved for future use.</p>
        capo_codepipeline.errors.invalid_stage_declaration_exception.InvalidStageDeclarationException: <p>The stage declaration was specified in an invalid format.</p>
        capo_codepipeline.errors.invalid_structure_exception.InvalidStructureException: <p>The structure was specified in an invalid format.</p>
        capo_codepipeline.errors.limit_exceeded_exception.LimitExceededException: <p>The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.</p>
        capo_codepipeline.errors.validation_exception.ValidationException: <p>The validation was specified in an invalid format.</p>
        capo_codepipeline.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_codepipeline.types.update_pipeline_input.UpdatePipelineInput]",
    ) -> AsyncOperationResponse[
        "capo_codepipeline.types.update_pipeline_output.UpdatePipelineOutput"
    ]:
        import capo_codepipeline._operations.code_pipeline_20150709.update_pipeline

        (
            output,
            http_response,
        ) = await capo_codepipeline._operations.code_pipeline_20150709.update_pipeline.async_update_pipeline(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdatePipeline")
    )
    input_: capo_codepipeline.types.update_pipeline_input.UpdatePipelineInput = {
        "pipeline": pipeline
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output