aws_sdk_sagemaker/client/
describe_training_plan.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 [`DescribeTrainingPlan`](crate::operation::describe_training_plan::builders::DescribeTrainingPlanFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`training_plan_name(impl Into<String>)`](crate::operation::describe_training_plan::builders::DescribeTrainingPlanFluentBuilder::training_plan_name) / [`set_training_plan_name(Option<String>)`](crate::operation::describe_training_plan::builders::DescribeTrainingPlanFluentBuilder::set_training_plan_name):<br>required: **true**<br><p>The name of the training plan to describe.</p><br>
7    /// - On success, responds with [`DescribeTrainingPlanOutput`](crate::operation::describe_training_plan::DescribeTrainingPlanOutput) with field(s):
8    ///   - [`training_plan_arn(Option<String>)`](crate::operation::describe_training_plan::DescribeTrainingPlanOutput::training_plan_arn): <p>The Amazon Resource Name (ARN); of the training plan.</p>
9    ///   - [`training_plan_name(Option<String>)`](crate::operation::describe_training_plan::DescribeTrainingPlanOutput::training_plan_name): <p>The name of the training plan.</p>
10    ///   - [`status(Option<TrainingPlanStatus>)`](crate::operation::describe_training_plan::DescribeTrainingPlanOutput::status): <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>
11    ///   - [`status_message(Option<String>)`](crate::operation::describe_training_plan::DescribeTrainingPlanOutput::status_message): <p>A message providing additional information about the current status of the training plan.</p>
12    ///   - [`duration_hours(Option<i64>)`](crate::operation::describe_training_plan::DescribeTrainingPlanOutput::duration_hours): <p>The number of whole hours in the total duration for this training plan.</p>
13    ///   - [`duration_minutes(Option<i64>)`](crate::operation::describe_training_plan::DescribeTrainingPlanOutput::duration_minutes): <p>The additional minutes beyond whole hours in the total duration for this training plan.</p>
14    ///   - [`start_time(Option<DateTime>)`](crate::operation::describe_training_plan::DescribeTrainingPlanOutput::start_time): <p>The start time of the training plan.</p>
15    ///   - [`end_time(Option<DateTime>)`](crate::operation::describe_training_plan::DescribeTrainingPlanOutput::end_time): <p>The end time of the training plan.</p>
16    ///   - [`upfront_fee(Option<String>)`](crate::operation::describe_training_plan::DescribeTrainingPlanOutput::upfront_fee): <p>The upfront fee for the training plan.</p>
17    ///   - [`currency_code(Option<String>)`](crate::operation::describe_training_plan::DescribeTrainingPlanOutput::currency_code): <p>The currency code for the upfront fee (e.g., USD).</p>
18    ///   - [`total_instance_count(Option<i32>)`](crate::operation::describe_training_plan::DescribeTrainingPlanOutput::total_instance_count): <p>The total number of instances reserved in this training plan.</p>
19    ///   - [`available_instance_count(Option<i32>)`](crate::operation::describe_training_plan::DescribeTrainingPlanOutput::available_instance_count): <p>The number of instances currently available for use in this training plan.</p>
20    ///   - [`in_use_instance_count(Option<i32>)`](crate::operation::describe_training_plan::DescribeTrainingPlanOutput::in_use_instance_count): <p>The number of instances currently in use from this training plan.</p>
21    ///   - [`target_resources(Option<Vec::<SageMakerResourceName>>)`](crate::operation::describe_training_plan::DescribeTrainingPlanOutput::target_resources): <p>The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) 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> </ul>
22    ///   - [`reserved_capacity_summaries(Option<Vec::<ReservedCapacitySummary>>)`](crate::operation::describe_training_plan::DescribeTrainingPlanOutput::reserved_capacity_summaries): <p>The list of Reserved Capacity providing the underlying compute resources of the plan.</p>
23    /// - On failure, responds with [`SdkError<DescribeTrainingPlanError>`](crate::operation::describe_training_plan::DescribeTrainingPlanError)
24    pub fn describe_training_plan(&self) -> crate::operation::describe_training_plan::builders::DescribeTrainingPlanFluentBuilder {
25        crate::operation::describe_training_plan::builders::DescribeTrainingPlanFluentBuilder::new(self.handle.clone())
26    }
27}
aws_sdk_sagemaker/client/describe_training_plan.rs

aws_sdk_sagemaker/client/
describe_training_plan.rs
