Skip to content

TrainingPlanOffering

Source code in docs_src/capo_sagemaker/types/training_plan_offering.py
class TrainingPlanOffering(TypedDict, closed=True):
    training_plan_offering_id: NotRequired[
        "capo_sagemaker.types.training_plan_offering_id.TrainingPlanOfferingId"
    ]
    """<p>The unique identifier for this training plan offering.</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) for this training plan offering.</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>"""
    requested_start_time_after: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The requested start time that the user specified when searching for the training plan offering.</p>"""
    requested_end_time_before: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The requested end time that the user specified when searching for the training plan offering.</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 offering.</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 offering.</p>"""
    upfront_fee: NotRequired["capo_sagemaker.types.string256.String256"]
    """<p>The upfront fee for this training plan offering.</p>"""
    currency_code: NotRequired["capo_sagemaker.types.currency_code.CurrencyCode"]
    """<p>The currency code for the upfront fee (e.g., USD).</p>"""
    reserved_capacity_offerings: NotRequired[
        "capo_sagemaker.types.reserved_capacity_offerings.ReservedCapacityOfferings"
    ]
    """<p>A list of reserved capacity offerings associated with this training plan offering.</p>"""

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 offering.

duration_minutes instance-attribute

duration_minutes: NotRequired[TrainingPlanDurationMinutes]

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

requested_end_time_before instance-attribute

requested_end_time_before: NotRequired[Timestamp]

The requested end time that the user specified when searching for the training plan offering.

requested_start_time_after instance-attribute

requested_start_time_after: NotRequired[Timestamp]

The requested start time that the user specified when searching for the training plan offering.

reserved_capacity_offerings instance-attribute

reserved_capacity_offerings: NotRequired[ReservedCapacityOfferings]

A list of reserved capacity offerings associated with this training plan offering.

target_resources instance-attribute

target_resources: NotRequired[SageMakerResourceNames]

The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod, SageMaker Endpoints, Studio apps) for this training plan offering.

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.

training_plan_offering_id instance-attribute

training_plan_offering_id: NotRequired[TrainingPlanOfferingId]

The unique identifier for this training plan offering.

upfront_fee instance-attribute

upfront_fee: NotRequired[String256]

The upfront fee for this training plan offering.