@Generated(value="software.amazon.awssdk:codegen") public final class DescribeTrainingJobResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeTrainingJobResponse.Builder,DescribeTrainingJobResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeTrainingJobResponse.Builder |
Modifier and Type | Method and Description |
---|---|
AlgorithmSpecification |
algorithmSpecification()
Information about the algorithm used for training, and algorithm metadata.
|
static DescribeTrainingJobResponse.Builder |
builder() |
Instant |
creationTime()
A timestamp that indicates when the training job was created.
|
boolean |
equals(Object obj) |
String |
failureReason()
If the training job failed, the reason it failed.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
Map<String,String> |
hyperParameters()
Algorithm-specific parameters.
|
List<Channel> |
inputDataConfig()
An array of
Channel objects that describes each data input channel. |
Instant |
lastModifiedTime()
A timestamp that indicates when the status of the training job was last modified.
|
ModelArtifacts |
modelArtifacts()
Information about the Amazon S3 location that is configured for storing model artifacts.
|
OutputDataConfig |
outputDataConfig()
The S3 path where model artifacts that you configured when creating the job are stored.
|
ResourceConfig |
resourceConfig()
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
|
String |
roleArn()
The AWS Identity and Access Management (IAM) role configured for the training job.
|
SecondaryStatus |
secondaryStatus()
Provides granular information about the system state.
|
String |
secondaryStatusAsString()
Provides granular information about the system state.
|
static Class<? extends DescribeTrainingJobResponse.Builder> |
serializableBuilderClass() |
StoppingCondition |
stoppingCondition()
The condition under which to stop the training job.
|
DescribeTrainingJobResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Instant |
trainingEndTime()
A timestamp that indicates when model training ended.
|
String |
trainingJobArn()
The Amazon Resource Name (ARN) of the training job.
|
String |
trainingJobName()
Name of the model training job.
|
TrainingJobStatus |
trainingJobStatus()
The status of the training job.
|
String |
trainingJobStatusAsString()
The status of the training job.
|
Instant |
trainingStartTime()
A timestamp that indicates when training started.
|
sdkHttpResponse
copy
public String trainingJobName()
Name of the model training job.
public String trainingJobArn()
The Amazon Resource Name (ARN) of the training job.
public ModelArtifacts modelArtifacts()
Information about the Amazon S3 location that is configured for storing model artifacts.
public TrainingJobStatus trainingJobStatus()
The status of the training job.
For the InProgress
status, Amazon SageMaker can return these secondary statuses:
Starting - Preparing for training.
Downloading - Optional stage for algorithms that support File training input mode. It indicates data is being downloaded to ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and model upload is in progress.
For the Stopped
training status, Amazon SageMaker can return these secondary statuses:
MaxRuntimeExceeded - Job stopped as a result of maximum allowed runtime exceeded.
If the service returns an enum value that is not available in the current SDK version, trainingJobStatus
will return TrainingJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from trainingJobStatusAsString()
.
For the InProgress
status, Amazon SageMaker can return these secondary statuses:
Starting - Preparing for training.
Downloading - Optional stage for algorithms that support File training input mode. It indicates data is being downloaded to ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and model upload is in progress.
For the Stopped
training status, Amazon SageMaker can return these secondary statuses:
MaxRuntimeExceeded - Job stopped as a result of maximum allowed runtime exceeded.
TrainingJobStatus
public String trainingJobStatusAsString()
The status of the training job.
For the InProgress
status, Amazon SageMaker can return these secondary statuses:
Starting - Preparing for training.
Downloading - Optional stage for algorithms that support File training input mode. It indicates data is being downloaded to ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and model upload is in progress.
For the Stopped
training status, Amazon SageMaker can return these secondary statuses:
MaxRuntimeExceeded - Job stopped as a result of maximum allowed runtime exceeded.
If the service returns an enum value that is not available in the current SDK version, trainingJobStatus
will return TrainingJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from trainingJobStatusAsString()
.
For the InProgress
status, Amazon SageMaker can return these secondary statuses:
Starting - Preparing for training.
Downloading - Optional stage for algorithms that support File training input mode. It indicates data is being downloaded to ML storage volumes.
Training - Training is in progress.
Uploading - Training is complete and model upload is in progress.
For the Stopped
training status, Amazon SageMaker can return these secondary statuses:
MaxRuntimeExceeded - Job stopped as a result of maximum allowed runtime exceeded.
TrainingJobStatus
public SecondaryStatus secondaryStatus()
Provides granular information about the system state. For more information, see TrainingJobStatus
.
If the service returns an enum value that is not available in the current SDK version, secondaryStatus
will return SecondaryStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from secondaryStatusAsString()
.
TrainingJobStatus
.SecondaryStatus
public String secondaryStatusAsString()
Provides granular information about the system state. For more information, see TrainingJobStatus
.
If the service returns an enum value that is not available in the current SDK version, secondaryStatus
will return SecondaryStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from secondaryStatusAsString()
.
TrainingJobStatus
.SecondaryStatus
public String failureReason()
If the training job failed, the reason it failed.
public Map<String,String> hyperParameters()
Algorithm-specific parameters.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public AlgorithmSpecification algorithmSpecification()
Information about the algorithm used for training, and algorithm metadata.
public String roleArn()
The AWS Identity and Access Management (IAM) role configured for the training job.
public List<Channel> inputDataConfig()
An array of Channel
objects that describes each data input channel.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Channel
objects that describes each data input channel.public OutputDataConfig outputDataConfig()
The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
public ResourceConfig resourceConfig()
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
public StoppingCondition stoppingCondition()
The condition under which to stop the training job.
public Instant creationTime()
A timestamp that indicates when the training job was created.
public Instant trainingStartTime()
A timestamp that indicates when training started.
public Instant trainingEndTime()
A timestamp that indicates when model training ended.
public Instant lastModifiedTime()
A timestamp that indicates when the status of the training job was last modified.
public DescribeTrainingJobResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeTrainingJobResponse.Builder,DescribeTrainingJobResponse>
toBuilder
in class AwsResponse
public static DescribeTrainingJobResponse.Builder builder()
public static Class<? extends DescribeTrainingJobResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.