java.lang.Object
- software.amazon.awssdk.services.sagemaker.model.SecondaryStatusTransition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SecondaryStatusTransition.Builder,SecondaryStatusTransition>
```
@Generated("software.amazon.awssdk:codegen")
public final class SecondaryStatusTransition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SecondaryStatusTransition.Builder,SecondaryStatusTransition>
```
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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SecondaryStatusTransition.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SecondaryStatusTransition.Builder`	`builder()`
`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.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SecondaryStatusTransition.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()`	A timestamp that shows when the training job transitioned to the current secondary status state.
`SecondaryStatus`	`status()`	Contains a secondary status information from a training job.
`String`	`statusAsString()`	Contains a secondary status information from a training job.
`String`	`statusMessage()`	A detailed description of the progress within a secondary status.
`SecondaryStatusTransition.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - status
```
public final 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
    
    If the service returns an enum value that is not available in the current SDK version, status will return SecondaryStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    
    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
    
    See Also:
    
    SecondaryStatus
  - statusAsString
```
public final String statusAsString()
```
    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
    
    If the service returns an enum value that is not available in the current SDK version, status will return SecondaryStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    
    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
    
    See Also:
    
    SecondaryStatus
  - startTime
```
public final Instant startTime()
```
    A timestamp that shows when the training job transitioned to the current secondary status state.
    
    Returns:
    
    A timestamp that shows when the training job transitioned to the current secondary status state.
  - endTime
```
public final 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.
    
    Returns:
    
    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.
  - statusMessage
```
public final 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
    
    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
    Returns:
    
    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
    
    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
  - toBuilder
```
public SecondaryStatusTransition.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SecondaryStatusTransition.Builder,SecondaryStatusTransition>
  - builder
```
public static SecondaryStatusTransition.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SecondaryStatusTransition.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SecondaryStatusTransition

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

status

statusAsString

startTime

endTime

statusMessage

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields