Struct DescribeTrainingPlanOutput

#[non_exhaustive]
pub struct DescribeTrainingPlanOutput {

    pub training_plan_arn: Option<String>,
    pub training_plan_name: Option<String>,
    pub status: Option<TrainingPlanStatus>,
    pub status_message: Option<String>,
    pub duration_hours: Option<i64>,
    pub duration_minutes: Option<i64>,
    pub start_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub upfront_fee: Option<String>,
    pub currency_code: Option<String>,
    pub total_instance_count: Option<i32>,
    pub available_instance_count: Option<i32>,
    pub in_use_instance_count: Option<i32>,
    pub target_resources: Option<Vec<SageMakerResourceName>>,
    pub reserved_capacity_summaries: Option<Vec<ReservedCapacitySummary>>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

training_plan_arn: Option<String>

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

training_plan_name: Option<String>

The name of the training plan.

status: Option<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: Option<String>

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

duration_hours: Option<i64>

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

duration_minutes: Option<i64>

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

start_time: Option<DateTime>

The start time of the training plan.

end_time: Option<DateTime>

The end time of the training plan.

upfront_fee: Option<String>

The upfront fee for the training plan.

currency_code: Option<String>

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

total_instance_count: Option<i32>

The total number of instances reserved in this training plan.

available_instance_count: Option<i32>

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

in_use_instance_count: Option<i32>

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

target_resources: Option<Vec<SageMakerResourceName>>

The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) 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.

reserved_capacity_summaries: Option<Vec<ReservedCapacitySummary>>

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

Implementations

impl DescribeTrainingPlanOutput

pub fn training_plan_arn(&self) -> Option<&str>

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

pub fn training_plan_name(&self) -> Option<&str>

The name of the training plan.

pub fn status(&self) -> Option<&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.

pub fn status_message(&self) -> Option<&str>

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

pub fn duration_hours(&self) -> Option<i64>

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

pub fn duration_minutes(&self) -> Option<i64>

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

pub fn start_time(&self) -> Option<&DateTime>

The start time of the training plan.

pub fn end_time(&self) -> Option<&DateTime>

The end time of the training plan.

pub fn upfront_fee(&self) -> Option<&str>

The upfront fee for the training plan.

pub fn currency_code(&self) -> Option<&str>

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

pub fn total_instance_count(&self) -> Option<i32>

The total number of instances reserved in this training plan.

pub fn available_instance_count(&self) -> Option<i32>

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

pub fn in_use_instance_count(&self) -> Option<i32>

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

pub fn target_resources(&self) -> &[SageMakerResourceName]

The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) 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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .target_resources.is_none().

pub fn reserved_capacity_summaries(&self) -> &[ReservedCapacitySummary]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .reserved_capacity_summaries.is_none().

impl DescribeTrainingPlanOutput

pub fn builder() -> DescribeTrainingPlanOutputBuilder

Creates a new builder-style object to manufacture DescribeTrainingPlanOutput.

Trait Implementations

impl Clone for DescribeTrainingPlanOutput

fn clone(&self) -> DescribeTrainingPlanOutput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeTrainingPlanOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DescribeTrainingPlanOutput

fn eq(&self, other: &DescribeTrainingPlanOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DescribeTrainingPlanOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeTrainingPlanOutput