Skip to content

get_pipeline_execution 

get_pipeline_execution(
    pipeline_name: PipelineName,
    pipeline_execution_id: PipelineExecutionId,
    *,
    config_overrides: Optional[CodePipelineClientConfig] = None,
) -> GetPipelineExecutionOutput

Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.

Parameters:

  • pipeline_name (PipelineName) –

    The name of the pipeline about which you want to get execution details.

  • pipeline_execution_id (PipelineExecutionId) –

    The ID of the pipeline execution about which you want to get execution details.

Raises:

Source code in docs_src/capo_codepipeline/_services/code_pipeline.py 
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
def get_pipeline_execution(
    self,
    pipeline_name: "capo_codepipeline.types.pipeline_name.PipelineName",
    pipeline_execution_id: "capo_codepipeline.types.pipeline_execution_id.PipelineExecutionId",
    *,
    config_overrides: Optional[CodePipelineClientConfig] = None,
) -> "capo_codepipeline.types.get_pipeline_execution_output.GetPipelineExecutionOutput":
    """<p>Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.</p>

    Args:
        pipeline_name: <p>The name of the pipeline about which you want to get execution details.</p>
        pipeline_execution_id: <p>The ID of the pipeline execution about which you want to get execution details.</p>

    Raises:
        capo_codepipeline.errors.pipeline_execution_not_found_exception.PipelineExecutionNotFoundException: <p>The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline. </p>
        capo_codepipeline.errors.pipeline_not_found_exception.PipelineNotFoundException: <p>The pipeline was specified in an invalid format or cannot be found.</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.
    """

    def _handler(
        req: "OperationRequest[capo_codepipeline.types.get_pipeline_execution_input.GetPipelineExecutionInput]",
    ) -> OperationResponse[
        "capo_codepipeline.types.get_pipeline_execution_output.GetPipelineExecutionOutput"
    ]:
        import capo_codepipeline._operations.code_pipeline_20150709.get_pipeline_execution

        output, http_response = (
            capo_codepipeline._operations.code_pipeline_20150709.get_pipeline_execution.get_pipeline_execution(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetPipelineExecution")
    )
    input_: capo_codepipeline.types.get_pipeline_execution_input.GetPipelineExecutionInput = {
        "pipeline_name": pipeline_name,
        "pipeline_execution_id": pipeline_execution_id,
    }

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