aws_sdk_sagemaker/client/
search_training_plan_offerings.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`SearchTrainingPlanOfferings`](crate::operation::search_training_plan_offerings::builders::SearchTrainingPlanOfferingsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`instance_type(ReservedCapacityInstanceType)`](crate::operation::search_training_plan_offerings::builders::SearchTrainingPlanOfferingsFluentBuilder::instance_type) / [`set_instance_type(Option<ReservedCapacityInstanceType>)`](crate::operation::search_training_plan_offerings::builders::SearchTrainingPlanOfferingsFluentBuilder::set_instance_type):<br>required: **true**<br><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><br>
7    ///   - [`instance_count(i32)`](crate::operation::search_training_plan_offerings::builders::SearchTrainingPlanOfferingsFluentBuilder::instance_count) / [`set_instance_count(Option<i32>)`](crate::operation::search_training_plan_offerings::builders::SearchTrainingPlanOfferingsFluentBuilder::set_instance_count):<br>required: **true**<br><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><br>
8    ///   - [`start_time_after(DateTime)`](crate::operation::search_training_plan_offerings::builders::SearchTrainingPlanOfferingsFluentBuilder::start_time_after) / [`set_start_time_after(Option<DateTime>)`](crate::operation::search_training_plan_offerings::builders::SearchTrainingPlanOfferingsFluentBuilder::set_start_time_after):<br>required: **false**<br><p>A filter to search for training plan offerings with a start time after a specified date.</p><br>
9    ///   - [`end_time_before(DateTime)`](crate::operation::search_training_plan_offerings::builders::SearchTrainingPlanOfferingsFluentBuilder::end_time_before) / [`set_end_time_before(Option<DateTime>)`](crate::operation::search_training_plan_offerings::builders::SearchTrainingPlanOfferingsFluentBuilder::set_end_time_before):<br>required: **false**<br><p>A filter to search for reserved capacity offerings with an end time before a specified date.</p><br>
10    ///   - [`duration_hours(i64)`](crate::operation::search_training_plan_offerings::builders::SearchTrainingPlanOfferingsFluentBuilder::duration_hours) / [`set_duration_hours(Option<i64>)`](crate::operation::search_training_plan_offerings::builders::SearchTrainingPlanOfferingsFluentBuilder::set_duration_hours):<br>required: **true**<br><p>The desired duration in hours for the training plan offerings.</p><br>
11    ///   - [`target_resources(SageMakerResourceName)`](crate::operation::search_training_plan_offerings::builders::SearchTrainingPlanOfferingsFluentBuilder::target_resources) / [`set_target_resources(Option<Vec::<SageMakerResourceName>>)`](crate::operation::search_training_plan_offerings::builders::SearchTrainingPlanOfferingsFluentBuilder::set_target_resources):<br>required: **true**<br><p>The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) 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> </ul><br>
12    /// - On success, responds with [`SearchTrainingPlanOfferingsOutput`](crate::operation::search_training_plan_offerings::SearchTrainingPlanOfferingsOutput) with field(s):
13    ///   - [`training_plan_offerings(Option<Vec::<TrainingPlanOffering>>)`](crate::operation::search_training_plan_offerings::SearchTrainingPlanOfferingsOutput::training_plan_offerings): <p>A list of training plan offerings that match the search criteria.</p>
14    /// - On failure, responds with [`SdkError<SearchTrainingPlanOfferingsError>`](crate::operation::search_training_plan_offerings::SearchTrainingPlanOfferingsError)
15    pub fn search_training_plan_offerings(
16        &self,
17    ) -> crate::operation::search_training_plan_offerings::builders::SearchTrainingPlanOfferingsFluentBuilder {
18        crate::operation::search_training_plan_offerings::builders::SearchTrainingPlanOfferingsFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_sagemaker/client/search_training_plan_offerings.rs

aws_sdk_sagemaker/client/
search_training_plan_offerings.rs
