Skip to content

describe_model

describe_model(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    model_name: Optional[ModelName] = None,
) -> DescribeModelOutput

Describes a model that you created using the CreateModel API.

Parameters:

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def describe_model(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    model_name: Optional["capo_sagemaker.types.model_name.ModelName"] = None,
) -> "capo_sagemaker.types.describe_model_output.DescribeModelOutput":
    """<p>Describes a model that you created using the <code>CreateModel</code> API.</p>

    Args:
        model_name: <p>The name of the model.</p>

    Raises:
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.describe_model_input.DescribeModelInput]",
    ) -> OperationResponse[
        "capo_sagemaker.types.describe_model_output.DescribeModelOutput"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_model

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeModel")
    )
    input_: capo_sagemaker.types.describe_model_input.DescribeModelInput = {}
    if model_name is not None:
        input_["model_name"] = model_name

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