Skip to content

get_pipeline_execution async

get_pipeline_execution(
    pipeline_name: PipelineName,
    pipeline_execution_id: PipelineExecutionId,
    *,
    config_overrides: Optional[AsyncCodePipelineClientConfig] = 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/async_code_pipeline.py
async 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[AsyncCodePipelineClientConfig] = 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.
    """

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

        (
            output,
            http_response,
        ) = await capo_codepipeline._operations.code_pipeline_20150709.get_pipeline_execution.async_get_pipeline_execution(
            req.options, req.input
        )
        return AsyncOperationResponse(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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output