Skip to content

SearchTrainingPlanOfferingsRequest

Source code in docs_src/capo_sagemaker/types/search_training_plan_offerings_request.py
class SearchTrainingPlanOfferingsRequest(TypedDict, closed=True):
    instance_type: NotRequired[
        "capo_sagemaker.types.reserved_capacity_instance_type.ReservedCapacityInstanceType"
    ]
    """<p>The type of instance you want to search for in the available training plan offerings. This field allows you to filter the search results based on the specific compute resources you require for your SageMaker training jobs or SageMaker HyperPod clusters. When searching for training plan offerings, specifying the instance type helps you find Reserved Instances that match your computational needs.</p>"""
    instance_count: NotRequired[
        "capo_sagemaker.types.reserved_capacity_instance_count.ReservedCapacityInstanceCount"
    ]
    """<p>The number of instances you want to reserve in the training plan offerings. This allows you to specify the quantity of compute resources needed for your SageMaker training jobs or SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your requirements.</p>"""
    ultra_server_type: NotRequired[
        "capo_sagemaker.types.ultra_server_type.UltraServerType"
    ]
    """<p>The type of UltraServer to search for, such as ml.u-p6e-gb200x72.</p>"""
    ultra_server_count: NotRequired[
        "capo_sagemaker.types.ultra_server_count.UltraServerCount"
    ]
    """<p>The number of UltraServers to search for.</p>"""
    start_time_after: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>A filter to search for training plan offerings with a start time after a specified date.</p>"""
    end_time_before: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>A filter to search for reserved capacity offerings with an end time before a specified date.</p>"""
    duration_hours: NotRequired[
        "capo_sagemaker.types.training_plan_duration_hours_input.TrainingPlanDurationHoursInput"
    ]
    """<p>The desired duration in hours for the training plan offerings.</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) to search for in the offerings.</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>"""
    training_plan_arn: NotRequired["capo_sagemaker.types.string.String"]
    """<p>The Amazon Resource Name (ARN); of an existing training plan to search for extension offerings. When specified, the API returns extension offerings that can be used to extend the specified training plan.</p>"""

duration_hours instance-attribute

duration_hours: NotRequired[TrainingPlanDurationHoursInput]

The desired duration in hours for the training plan offerings.

end_time_before instance-attribute

end_time_before: NotRequired[Timestamp]

A filter to search for reserved capacity offerings with an end time before a specified date.

instance_count instance-attribute

instance_count: NotRequired[ReservedCapacityInstanceCount]

The number of instances you want to reserve in the training plan offerings. This allows you to specify the quantity of compute resources needed for your SageMaker training jobs or SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your requirements.

instance_type instance-attribute

instance_type: NotRequired[ReservedCapacityInstanceType]

The type of instance you want to search for in the available training plan offerings. This field allows you to filter the search results based on the specific compute resources you require for your SageMaker training jobs or SageMaker HyperPod clusters. When searching for training plan offerings, specifying the instance type helps you find Reserved Instances that match your computational needs.

start_time_after instance-attribute

start_time_after: NotRequired[Timestamp]

A filter to search for training plan offerings with a start time after a specified date.

target_resources instance-attribute

target_resources: NotRequired[SageMakerResourceNames]

The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod, SageMaker Endpoints, Studio apps) to search for in the offerings.

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_arn instance-attribute

training_plan_arn: NotRequired[String]

The Amazon Resource Name (ARN); of an existing training plan to search for extension offerings. When specified, the API returns extension offerings that can be used to extend the specified training plan.

ultra_server_count instance-attribute

ultra_server_count: NotRequired[UltraServerCount]

The number of UltraServers to search for.

ultra_server_type instance-attribute

ultra_server_type: NotRequired[UltraServerType]

The type of UltraServer to search for, such as ml.u-p6e-gb200x72.