Skip to content

get_pipeline_state

get_pipeline_state(
    name: PipelineName, *, config_overrides: Optional[CodePipelineClientConfig] = None
) -> GetPipelineStateOutput

Returns information about the state of a pipeline, including the stages and actions.

Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.

Parameters:

  • name (PipelineName) –

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

Raises:

Source code in docs_src/capo_codepipeline/_services/code_pipeline.py
def get_pipeline_state(
    self,
    name: "capo_codepipeline.types.pipeline_name.PipelineName",
    *,
    config_overrides: Optional[CodePipelineClientConfig] = None,
) -> "capo_codepipeline.types.get_pipeline_state_output.GetPipelineStateOutput":
    """<p>Returns information about the state of a pipeline, including the stages and actions.</p> <note> <p>Values returned in the <code>revisionId</code> and <code>revisionUrl</code> fields indicate the source revision information, such as the commit ID, for the current state.</p> </note>

    Args:
        name: <p>The name of the pipeline about which you want to get information.</p>

    Raises:
        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_state_input.GetPipelineStateInput]",
    ) -> OperationResponse[
        "capo_codepipeline.types.get_pipeline_state_output.GetPipelineStateOutput"
    ]:
        import capo_codepipeline._operations.code_pipeline_20150709.get_pipeline_state

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetPipelineState")
    )
    input_: capo_codepipeline.types.get_pipeline_state_input.GetPipelineStateInput = {
        "name": name
    }

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