AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::SageMaker::Model::SecondaryStatusTransition Class Reference

#include <SecondaryStatusTransition.h>

Public Member Functions

 SecondaryStatusTransition ()
 
 SecondaryStatusTransition (Aws::Utils::Json::JsonView jsonValue)
 
SecondaryStatusTransitionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const SecondaryStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const SecondaryStatus &value)
 
void SetStatus (SecondaryStatus &&value)
 
SecondaryStatusTransitionWithStatus (const SecondaryStatus &value)
 
SecondaryStatusTransitionWithStatus (SecondaryStatus &&value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
SecondaryStatusTransitionWithStartTime (const Aws::Utils::DateTime &value)
 
SecondaryStatusTransitionWithStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetEndTime () const
 
bool EndTimeHasBeenSet () const
 
void SetEndTime (const Aws::Utils::DateTime &value)
 
void SetEndTime (Aws::Utils::DateTime &&value)
 
SecondaryStatusTransitionWithEndTime (const Aws::Utils::DateTime &value)
 
SecondaryStatusTransitionWithEndTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetStatusMessage () const
 
bool StatusMessageHasBeenSet () const
 
void SetStatusMessage (const Aws::String &value)
 
void SetStatusMessage (Aws::String &&value)
 
void SetStatusMessage (const char *value)
 
SecondaryStatusTransitionWithStatusMessage (const Aws::String &value)
 
SecondaryStatusTransitionWithStatusMessage (Aws::String &&value)
 
SecondaryStatusTransitionWithStatusMessage (const char *value)
 

Detailed Description

An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions. 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, Amazon SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status.

See Also:

AWS API Reference

Definition at line 41 of file SecondaryStatusTransition.h.

Constructor & Destructor Documentation

◆ SecondaryStatusTransition() [1/2]

Aws::SageMaker::Model::SecondaryStatusTransition::SecondaryStatusTransition ( )

◆ SecondaryStatusTransition() [2/2]

Aws::SageMaker::Model::SecondaryStatusTransition::SecondaryStatusTransition ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ EndTimeHasBeenSet()

bool Aws::SageMaker::Model::SecondaryStatusTransition::EndTimeHasBeenSet ( ) const
inline

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.

Definition at line 250 of file SecondaryStatusTransition.h.

◆ GetEndTime()

const Aws::Utils::DateTime& Aws::SageMaker::Model::SecondaryStatusTransition::GetEndTime ( ) const
inline

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.

Definition at line 243 of file SecondaryStatusTransition.h.

◆ GetStartTime()

const Aws::Utils::DateTime& Aws::SageMaker::Model::SecondaryStatusTransition::GetStartTime ( ) const
inline

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

Definition at line 205 of file SecondaryStatusTransition.h.

◆ GetStatus()

const SecondaryStatus& Aws::SageMaker::Model::SecondaryStatusTransition::GetStatus ( ) const
inline

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

Definition at line 73 of file SecondaryStatusTransition.h.

◆ GetStatusMessage()

const Aws::String& Aws::SageMaker::Model::SecondaryStatusTransition::GetStatusMessage ( ) const
inline

A detailed description of the progress within a secondary status.

Amazon 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
  • Downloading the training image.

  • 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

Definition at line 302 of file SecondaryStatusTransition.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SageMaker::Model::SecondaryStatusTransition::Jsonize ( ) const

◆ operator=()

SecondaryStatusTransition& Aws::SageMaker::Model::SecondaryStatusTransition::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetEndTime() [1/2]

void Aws::SageMaker::Model::SecondaryStatusTransition::SetEndTime ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 264 of file SecondaryStatusTransition.h.

◆ SetEndTime() [2/2]

void Aws::SageMaker::Model::SecondaryStatusTransition::SetEndTime ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 257 of file SecondaryStatusTransition.h.

◆ SetStartTime() [1/2]

void Aws::SageMaker::Model::SecondaryStatusTransition::SetStartTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 223 of file SecondaryStatusTransition.h.

◆ SetStartTime() [2/2]

void Aws::SageMaker::Model::SecondaryStatusTransition::SetStartTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 217 of file SecondaryStatusTransition.h.

◆ SetStatus() [1/2]

void Aws::SageMaker::Model::SecondaryStatusTransition::SetStatus ( const SecondaryStatus value)
inline

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

Definition at line 123 of file SecondaryStatusTransition.h.

◆ SetStatus() [2/2]

void Aws::SageMaker::Model::SecondaryStatusTransition::SetStatus ( SecondaryStatus &&  value)
inline

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

Definition at line 148 of file SecondaryStatusTransition.h.

◆ SetStatusMessage() [1/3]

void Aws::SageMaker::Model::SecondaryStatusTransition::SetStatusMessage ( Aws::String &&  value)
inline

A detailed description of the progress within a secondary status.

Amazon 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
  • Downloading the training image.

  • 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

Definition at line 371 of file SecondaryStatusTransition.h.

◆ SetStatusMessage() [2/3]

void Aws::SageMaker::Model::SecondaryStatusTransition::SetStatusMessage ( const Aws::String value)
inline

A detailed description of the progress within a secondary status.

Amazon 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
  • Downloading the training image.

  • 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

Definition at line 348 of file SecondaryStatusTransition.h.

◆ SetStatusMessage() [3/3]

void Aws::SageMaker::Model::SecondaryStatusTransition::SetStatusMessage ( const char *  value)
inline

A detailed description of the progress within a secondary status.

Amazon 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
  • Downloading the training image.

  • 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

Definition at line 394 of file SecondaryStatusTransition.h.

◆ StartTimeHasBeenSet()

bool Aws::SageMaker::Model::SecondaryStatusTransition::StartTimeHasBeenSet ( ) const
inline

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

Definition at line 211 of file SecondaryStatusTransition.h.

◆ StatusHasBeenSet()

bool Aws::SageMaker::Model::SecondaryStatusTransition::StatusHasBeenSet ( ) const
inline

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

Definition at line 98 of file SecondaryStatusTransition.h.

◆ StatusMessageHasBeenSet()

bool Aws::SageMaker::Model::SecondaryStatusTransition::StatusMessageHasBeenSet ( ) const
inline

A detailed description of the progress within a secondary status.

Amazon 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
  • Downloading the training image.

  • 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

Definition at line 325 of file SecondaryStatusTransition.h.

◆ WithEndTime() [1/2]

SecondaryStatusTransition& Aws::SageMaker::Model::SecondaryStatusTransition::WithEndTime ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 278 of file SecondaryStatusTransition.h.

◆ WithEndTime() [2/2]

SecondaryStatusTransition& Aws::SageMaker::Model::SecondaryStatusTransition::WithEndTime ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 271 of file SecondaryStatusTransition.h.

◆ WithStartTime() [1/2]

SecondaryStatusTransition& Aws::SageMaker::Model::SecondaryStatusTransition::WithStartTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 235 of file SecondaryStatusTransition.h.

◆ WithStartTime() [2/2]

SecondaryStatusTransition& Aws::SageMaker::Model::SecondaryStatusTransition::WithStartTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 229 of file SecondaryStatusTransition.h.

◆ WithStatus() [1/2]

SecondaryStatusTransition& Aws::SageMaker::Model::SecondaryStatusTransition::WithStatus ( const SecondaryStatus value)
inline

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

Definition at line 173 of file SecondaryStatusTransition.h.

◆ WithStatus() [2/2]

SecondaryStatusTransition& Aws::SageMaker::Model::SecondaryStatusTransition::WithStatus ( SecondaryStatus &&  value)
inline

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

Definition at line 198 of file SecondaryStatusTransition.h.

◆ WithStatusMessage() [1/3]

SecondaryStatusTransition& Aws::SageMaker::Model::SecondaryStatusTransition::WithStatusMessage ( Aws::String &&  value)
inline

A detailed description of the progress within a secondary status.

Amazon 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
  • Downloading the training image.

  • 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

Definition at line 440 of file SecondaryStatusTransition.h.

◆ WithStatusMessage() [2/3]

SecondaryStatusTransition& Aws::SageMaker::Model::SecondaryStatusTransition::WithStatusMessage ( const Aws::String value)
inline

A detailed description of the progress within a secondary status.

Amazon 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
  • Downloading the training image.

  • 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

Definition at line 417 of file SecondaryStatusTransition.h.

◆ WithStatusMessage() [3/3]

SecondaryStatusTransition& Aws::SageMaker::Model::SecondaryStatusTransition::WithStatusMessage ( const char *  value)
inline

A detailed description of the progress within a secondary status.

Amazon 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
  • Downloading the training image.

  • 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

Definition at line 463 of file SecondaryStatusTransition.h.


The documentation for this class was generated from the following file: