Skip to content

describe_training_plan

describe_training_plan(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    training_plan_name: Optional[TrainingPlanNameOrArn] = None,
) -> DescribeTrainingPlanResponse

Retrieves detailed information about a specific training plan.

Parameters:

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def describe_training_plan(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    training_plan_name: Optional[
        "capo_sagemaker.types.training_plan_name_or_arn.TrainingPlanNameOrArn"
    ] = None,
) -> "capo_sagemaker.types.describe_training_plan_response.DescribeTrainingPlanResponse":
    """<p>Retrieves detailed information about a specific training plan.</p>

    Args:
        training_plan_name: <p>The name of the training plan 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_training_plan_request.DescribeTrainingPlanRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.describe_training_plan_response.DescribeTrainingPlanResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_training_plan

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTrainingPlan")
    )
    input_: capo_sagemaker.types.describe_training_plan_request.DescribeTrainingPlanRequest = {}
    if training_plan_name is not None:
        input_["training_plan_name"] = training_plan_name

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