Skip to content

describe_pipeline

describe_pipeline(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    pipeline_name: Optional[PipelineNameOrArn] = None,
    pipeline_version_id: Optional[PipelineVersionId] = None,
) -> DescribePipelineResponse

Describes the details of a pipeline.

Parameters:

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def describe_pipeline(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    pipeline_name: Optional[
        "capo_sagemaker.types.pipeline_name_or_arn.PipelineNameOrArn"
    ] = None,
    pipeline_version_id: Optional[
        "capo_sagemaker.types.pipeline_version_id.PipelineVersionId"
    ] = None,
) -> "capo_sagemaker.types.describe_pipeline_response.DescribePipelineResponse":
    """<p>Describes the details of a pipeline.</p>

    Args:
        pipeline_name: <p>The name or Amazon Resource Name (ARN) of the pipeline to describe.</p>
        pipeline_version_id: <p>The ID of the pipeline version to describe.</p>

    Raises:
        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.describe_pipeline_request.DescribePipelineRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.describe_pipeline_response.DescribePipelineResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_pipeline

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribePipeline")
    )
    input_: capo_sagemaker.types.describe_pipeline_request.DescribePipelineRequest = {}
    if pipeline_name is not None:
        input_["pipeline_name"] = pipeline_name
    if pipeline_version_id is not None:
        input_["pipeline_version_id"] = pipeline_version_id

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