Struct SecondaryStatusTransition

#[non_exhaustive]
pub struct SecondaryStatusTransition {
    pub status: Option<SecondaryStatus>,
    pub start_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub status_message: Option<String>,
}

An array element of SecondaryStatusTransitions for DescribeTrainingJob. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status.

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.

status: Option<SecondaryStatus>

Contains a secondary status information from a training job.

Status might be one of the following secondary statuses:

InProgress

• Starting - Starting the training job.

• Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

• Training - Training is in progress.

• Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

• Completed - The training job has completed.

Failed

• Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

• MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

• Stopped - The training job has stopped.

Stopping

• Stopping - Stopping the training job.

We no longer support the following secondary statuses:

• LaunchingMLInstances

• PreparingTrainingStack

• DownloadingTrainingImage

start_time: Option<DateTime>

A timestamp that shows when the training job transitioned to the current secondary status state.

end_time: Option<DateTime>

A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.

status_message: Option<String>

A detailed description of the progress within a secondary status.

SageMaker provides secondary statuses and status messages that apply to each of them:

Starting

• Starting the training job.

• Launching requested ML instances.

• Insufficient capacity error from EC2 while launching instances, retrying!

• Launched instance was unhealthy, replacing it!

• Preparing the instances for training.

Training

• Training image download completed. Training in progress.

Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.

To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

• TrainingJobStatus - InProgress

• SecondaryStatus - Training

• StatusMessage - Downloading the training image

Implementations

impl SecondaryStatusTransition

pub fn status(&self) -> Option<&SecondaryStatus>

Contains a secondary status information from a training job.

Status might be one of the following secondary statuses:

InProgress

• Starting - Starting the training job.

• Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

• Training - Training is in progress.

• Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

• Completed - The training job has completed.

Failed

• Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

• MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

• Stopped - The training job has stopped.

Stopping

• Stopping - Stopping the training job.

We no longer support the following secondary statuses:

• LaunchingMLInstances

• PreparingTrainingStack

• DownloadingTrainingImage

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

A timestamp that shows when the training job transitioned to the current secondary status state.

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

A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.

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

A detailed description of the progress within a secondary status.

SageMaker provides secondary statuses and status messages that apply to each of them:

Starting

• Starting the training job.

• Launching requested ML instances.

• Insufficient capacity error from EC2 while launching instances, retrying!

• Launched instance was unhealthy, replacing it!

• Preparing the instances for training.

Training

• Training image download completed. Training in progress.

Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.

To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

• TrainingJobStatus - InProgress

• SecondaryStatus - Training

• StatusMessage - Downloading the training image

impl SecondaryStatusTransition

pub fn builder() -> SecondaryStatusTransitionBuilder

Creates a new builder-style object to manufacture SecondaryStatusTransition.

Trait Implementations

impl Clone for SecondaryStatusTransition

fn clone(&self) -> SecondaryStatusTransition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecondaryStatusTransition

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

Formats the value using the given formatter.

impl PartialEq for SecondaryStatusTransition

fn eq(&self, other: &SecondaryStatusTransition) -> 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 StructuralPartialEq for SecondaryStatusTransition