Class SecondaryStatusTransition
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
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.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends SecondaryStatusTransition.Builder> final Instant
A timestamp that shows when the training job transitioned to the current secondary status state.final SecondaryStatus
status()
Contains a secondary status information from a training job.final String
Contains a secondary status information from a training job.final String
A detailed description of the progress within a secondary status.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 supportFile
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 theFailureReason
field ofDescribeTrainingJobResponse
.
-
- 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 returnSecondaryStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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 supportFile
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 theFailureReason
field ofDescribeTrainingJobResponse
.
-
- 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:
-
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 supportFile
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 theFailureReason
field ofDescribeTrainingJobResponse
.
-
- 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 returnSecondaryStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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 supportFile
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 theFailureReason
field ofDescribeTrainingJobResponse
.
-
- 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:
-
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
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
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
andSecondaryStatus
in DescribeTrainingJob, andStatusMessage
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
-
-
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
andSecondaryStatus
in DescribeTrainingJob, andStatusMessage
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SecondaryStatusTransition.Builder,
SecondaryStatusTransition> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-