Values_2.DescribeTrainingPlanResponseSourceRetrieves detailed information about a specific training plan.
type nonrec t = {trainingPlanArn : Values_0.TrainingPlanArn.t option;The Amazon Resource Name (ARN); of the training plan.
*)trainingPlanName : Values_1.TrainingPlanName.t option;The name of the training plan.
*)status : TrainingPlanStatus.t option;The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.
*)statusMessage : TrainingPlanStatusMessage.t option;A message providing additional information about the current status of the training plan.
*)durationHours : TrainingPlanDurationHours.t option;The number of whole hours in the total duration for this training plan.
*)durationMinutes : TrainingPlanDurationMinutes.t option;The additional minutes beyond whole hours in the total duration for this training plan.
*)startTime : Values_0.Timestamp.t option;The start time of the training plan.
*)endTime : Values_0.Timestamp.t option;The end time of the training plan.
*)upfrontFee : Values_0.String256.t option;The upfront fee for the training plan.
*)currencyCode : Values_1.CurrencyCode.t option;The currency code for the upfront fee (e.g., USD).
*)totalInstanceCount : Values_1.TotalInstanceCount.t option;The total number of instances reserved in this training plan.
*)availableInstanceCount : Values_0.AvailableInstanceCount.t option;The number of instances currently available for use in this training plan.
*)inUseInstanceCount : Values_1.InUseInstanceCount.t option;The number of instances currently in use from this training plan.
*)unhealthyInstanceCount : Values_1.UnhealthyInstanceCount.t option;The number of instances in the training plan that are currently in an unhealthy state.
*)availableSpareInstanceCount : Values_0.AvailableSpareInstanceCount.t option;The number of available spare instances in the training plan.
*)totalUltraServerCount : Values_1.UltraServerCount.t option;The total number of UltraServers reserved to this training plan.
*)targetResources : SageMakerResourceNames.t option;The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod, SageMaker Endpoints, Studio apps) that can use this training plan. Training plans are specific to their target resource. A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs. A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group. A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment. A training plan for Studio apps can be used to launch JupyterLab and Code Editor apps on reserved training plan capacity.
*)reservedCapacitySummaries : ReservedCapacitySummaries.t option;The list of Reserved Capacity providing the underlying compute resources of the plan.
*)}type nonrec error = [ | `ResourceNotFound of Values_0.ResourceNotFound.t| `Unknown_operation_error of string * string option ]val make :
?trainingPlanArn:??? ->
?trainingPlanName:??? ->
?status:??? ->
?statusMessage:??? ->
?durationHours:??? ->
?durationMinutes:??? ->
?startTime:??? ->
?endTime:??? ->
?upfrontFee:??? ->
?currencyCode:??? ->
?totalInstanceCount:??? ->
?availableInstanceCount:??? ->
?inUseInstanceCount:??? ->
?unhealthyInstanceCount:??? ->
?availableSpareInstanceCount:??? ->
?totalUltraServerCount:??? ->
?targetResources:??? ->
?reservedCapacitySummaries:??? ->
unit ->
tval error_of_json :
string ->
Yojson.Safe.t ->
[> `ResourceNotFound of Values_0.ResourceNotFound.t
| `Unknown_operation_error of string * string option ]val error_of_xml :
string ->
Awso.Xml.t ->
[> `ResourceNotFound of Values_0.ResourceNotFound.t
| `Unknown_operation_error of string * string option ]val to_value :
t ->
[> `Structure of
(string
* [> `Enum of string
| `Integer of Values_1.TotalInstanceCount.t
| `List of
[> `Enum of string
| `Structure of
(string
* [> `Enum of string
| `Integer of Values_1.UltraServerCount.t
| `Long of Values_1.ReservedCapacityDurationHours.t
| `String of Values_1.ReservedCapacityArn.t
| `Timestamp of Values_0.Timestamp.t ])
list ]
list
| `Long of TrainingPlanDurationHours.t
| `String of Values_0.TrainingPlanArn.t
| `Timestamp of Values_0.Timestamp.t ])
list ]