Skip to content

DescribeTrainingPlanResponse

Source code in docs_src/capo_sagemaker/types/describe_training_plan_response.py
class DescribeTrainingPlanResponse(TypedDict, closed=True):
    training_plan_arn: NotRequired[
        "capo_sagemaker.types.training_plan_arn.TrainingPlanArn"
    ]
    """<p>The Amazon Resource Name (ARN); of the training plan.</p>"""
    training_plan_name: NotRequired[
        "capo_sagemaker.types.training_plan_name.TrainingPlanName"
    ]
    """<p>The name of the training plan.</p>"""
    status: NotRequired["capo_sagemaker.types.training_plan_status.TrainingPlanStatus"]
    """<p>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 <code>Status</code> attribute within the <code> <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingPlanSummary.html">TrainingPlanSummary</a> </code> object.</p>"""
    status_message: NotRequired[
        "capo_sagemaker.types.training_plan_status_message.TrainingPlanStatusMessage"
    ]
    """<p>A message providing additional information about the current status of the training plan.</p>"""
    duration_hours: NotRequired[
        "capo_sagemaker.types.training_plan_duration_hours.TrainingPlanDurationHours"
    ]
    """<p>The number of whole hours in the total duration for this training plan.</p>"""
    duration_minutes: NotRequired[
        "capo_sagemaker.types.training_plan_duration_minutes.TrainingPlanDurationMinutes"
    ]
    """<p>The additional minutes beyond whole hours in the total duration for this training plan.</p>"""
    start_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The start time of the training plan.</p>"""
    end_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The end time of the training plan.</p>"""
    upfront_fee: NotRequired["capo_sagemaker.types.string256.String256"]
    """<p>The upfront fee for the training plan.</p>"""
    currency_code: NotRequired["capo_sagemaker.types.currency_code.CurrencyCode"]
    """<p>The currency code for the upfront fee (e.g., USD).</p>"""
    total_instance_count: NotRequired[
        "capo_sagemaker.types.total_instance_count.TotalInstanceCount"
    ]
    """<p>The total number of instances reserved in this training plan.</p>"""
    available_instance_count: NotRequired[
        "capo_sagemaker.types.available_instance_count.AvailableInstanceCount"
    ]
    """<p>The number of instances currently available for use in this training plan.</p>"""
    in_use_instance_count: NotRequired[
        "capo_sagemaker.types.in_use_instance_count.InUseInstanceCount"
    ]
    """<p>The number of instances currently in use from this training plan.</p>"""
    unhealthy_instance_count: NotRequired[
        "capo_sagemaker.types.unhealthy_instance_count.UnhealthyInstanceCount"
    ]
    """<p>The number of instances in the training plan that are currently in an unhealthy state.</p>"""
    available_spare_instance_count: NotRequired[
        "capo_sagemaker.types.available_spare_instance_count.AvailableSpareInstanceCount"
    ]
    """<p>The number of available spare instances in the training plan.</p>"""
    total_ultra_server_count: NotRequired[
        "capo_sagemaker.types.ultra_server_count.UltraServerCount"
    ]
    """<p>The total number of UltraServers reserved to this training plan.</p>"""
    target_resources: NotRequired[
        "capo_sagemaker.types.sage_maker_resource_names.SageMakerResourceNames"
    ]
    """<p>The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod, SageMaker Endpoints, Studio apps) that can use this training plan.</p> <p>Training plans are specific to their target resource.</p> <ul> <li> <p>A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.</p> </li> <li> <p>A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.</p> </li> <li> <p>A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment.</p> </li> <li> <p>A training plan for Studio apps can be used to launch JupyterLab and Code Editor apps on reserved training plan capacity.</p> </li> </ul>"""
    reserved_capacity_summaries: NotRequired[
        "capo_sagemaker.types.reserved_capacity_summaries.ReservedCapacitySummaries"
    ]
    """<p>The list of Reserved Capacity providing the underlying compute resources of the plan. </p>"""

available_instance_count instance-attribute

available_instance_count: NotRequired[AvailableInstanceCount]

The number of instances currently available for use in this training plan.

available_spare_instance_count instance-attribute

available_spare_instance_count: NotRequired[AvailableSpareInstanceCount]

The number of available spare instances in the training plan.

currency_code instance-attribute

currency_code: NotRequired[CurrencyCode]

The currency code for the upfront fee (e.g., USD).

duration_hours instance-attribute

duration_hours: NotRequired[TrainingPlanDurationHours]

The number of whole hours in the total duration for this training plan.

duration_minutes instance-attribute

duration_minutes: NotRequired[TrainingPlanDurationMinutes]

The additional minutes beyond whole hours in the total duration for this training plan.

end_time instance-attribute

end_time: NotRequired[Timestamp]

The end time of the training plan.

in_use_instance_count instance-attribute

in_use_instance_count: NotRequired[InUseInstanceCount]

The number of instances currently in use from this training plan.

reserved_capacity_summaries instance-attribute

reserved_capacity_summaries: NotRequired[ReservedCapacitySummaries]

The list of Reserved Capacity providing the underlying compute resources of the plan.

start_time instance-attribute

start_time: NotRequired[Timestamp]

The start time of the training plan.

status instance-attribute

status: NotRequired[TrainingPlanStatus]

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.

status_message instance-attribute

status_message: NotRequired[TrainingPlanStatusMessage]

A message providing additional information about the current status of the training plan.

target_resources instance-attribute

target_resources: NotRequired[SageMakerResourceNames]

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.

total_instance_count instance-attribute

total_instance_count: NotRequired[TotalInstanceCount]

The total number of instances reserved in this training plan.

total_ultra_server_count instance-attribute

total_ultra_server_count: NotRequired[UltraServerCount]

The total number of UltraServers reserved to this training plan.

training_plan_arn instance-attribute

training_plan_arn: NotRequired[TrainingPlanArn]

The Amazon Resource Name (ARN); of the training plan.

training_plan_name instance-attribute

training_plan_name: NotRequired[TrainingPlanName]

The name of the training plan.

unhealthy_instance_count instance-attribute

unhealthy_instance_count: NotRequired[UnhealthyInstanceCount]

The number of instances in the training plan that are currently in an unhealthy state.

upfront_fee instance-attribute

upfront_fee: NotRequired[String256]

The upfront fee for the training plan.