Package software.amazon.awssdk.services.sagemaker.model

Interface SecondaryStatusTransition.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SecondaryStatusTransition.Builder,SecondaryStatusTransition>, SdkBuilder<SecondaryStatusTransition.Builder,SecondaryStatusTransition>, SdkPojo

Enclosing class:

SecondaryStatusTransition

public static interface SecondaryStatusTransition.Builder
extends SdkPojo, CopyableBuilder<SecondaryStatusTransition.Builder,SecondaryStatusTransition>

Method Summary

Modifier and Type	Method	Description
SecondaryStatusTransition.Builder	endTime(Instant endTime)	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.
SecondaryStatusTransition.Builder	startTime(Instant startTime)	A timestamp that shows when the training job transitioned to the current secondary status state.
SecondaryStatusTransition.Builder	status(String status)	Contains a secondary status information from a training job.
SecondaryStatusTransition.Builder	status(SecondaryStatus status)	Contains a secondary status information from a training job.
SecondaryStatusTransition.Builder	statusMessage(String statusMessage)	A detailed description of the progress within a secondary status.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

status

SecondaryStatusTransition.Builder status(String status)

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

Parameters:

status - 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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SecondaryStatus, SecondaryStatus

status

SecondaryStatusTransition.Builder status(SecondaryStatus status)

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

Parameters:

status - 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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SecondaryStatus, SecondaryStatus

startTime

SecondaryStatusTransition.Builder startTime(Instant startTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

endTime

SecondaryStatusTransition.Builder endTime(Instant endTime)

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.

Parameters:

endTime - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

statusMessage

SecondaryStatusTransition.Builder statusMessage(String statusMessage)

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

Parameters:

statusMessage - 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

Returns:

Returns a reference to this object so that method calls can be chained together.