DescribeTrainingJobResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.sagemaker.model.DescribeTrainingJobResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeTrainingJobResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeTrainingJobResult()

Constructors
Constructor and Description
`DescribeTrainingJobResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeTrainingJobResult`	`addHyperParametersEntry(String key, String value)`
`DescribeTrainingJobResult`	`clearHyperParametersEntries()` Removes all the entries added into HyperParameters.
`DescribeTrainingJobResult`	`clone()`
`boolean`	`equals(Object obj)`
`AlgorithmSpecification`	`getAlgorithmSpecification()` Information about the algorithm used for training, and algorithm metadata.
`Date`	`getCreationTime()` A timestamp that indicates when the training job was created.
`String`	`getFailureReason()` If the training job failed, the reason it failed.
`Map<String,String>`	`getHyperParameters()` Algorithm-specific parameters.
`List<Channel>`	`getInputDataConfig()` An array of `Channel` objects that describes each data input channel.
`Date`	`getLastModifiedTime()` A timestamp that indicates when the status of the training job was last modified.
`ModelArtifacts`	`getModelArtifacts()` Information about the Amazon S3 location that is configured for storing model artifacts.
`OutputDataConfig`	`getOutputDataConfig()` The S3 path where model artifacts that you configured when creating the job are stored.
`ResourceConfig`	`getResourceConfig()` Resources, including ML compute instances and ML storage volumes, that are configured for model training.
`String`	`getRoleArn()` The AWS Identity and Access Management (IAM) role configured for the training job.
`String`	`getSecondaryStatus()` Provides granular information about the system state.
`List<SecondaryStatusTransition>`	`getSecondaryStatusTransitions()` A log of time-ordered secondary statuses that a training job has transitioned.
`StoppingCondition`	`getStoppingCondition()` The condition under which to stop the training job.
`Date`	`getTrainingEndTime()` Indicates the time when the training job ends on training instances.
`String`	`getTrainingJobArn()` The Amazon Resource Name (ARN) of the training job.
`String`	`getTrainingJobName()` Name of the model training job.
`String`	`getTrainingJobStatus()` The status of the training job.
`Date`	`getTrainingStartTime()` Indicates the time when the training job starts on training instances.
`String`	`getTuningJobArn()` The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
`VpcConfig`	`getVpcConfig()` A VpcConfig object that specifies the VPC that this training job has access to.
`int`	`hashCode()`
`void`	`setAlgorithmSpecification(AlgorithmSpecification algorithmSpecification)` Information about the algorithm used for training, and algorithm metadata.
`void`	`setCreationTime(Date creationTime)` A timestamp that indicates when the training job was created.
`void`	`setFailureReason(String failureReason)` If the training job failed, the reason it failed.
`void`	`setHyperParameters(Map<String,String> hyperParameters)` Algorithm-specific parameters.
`void`	`setInputDataConfig(Collection<Channel> inputDataConfig)` An array of `Channel` objects that describes each data input channel.
`void`	`setLastModifiedTime(Date lastModifiedTime)` A timestamp that indicates when the status of the training job was last modified.
`void`	`setModelArtifacts(ModelArtifacts modelArtifacts)` Information about the Amazon S3 location that is configured for storing model artifacts.
`void`	`setOutputDataConfig(OutputDataConfig outputDataConfig)` The S3 path where model artifacts that you configured when creating the job are stored.
`void`	`setResourceConfig(ResourceConfig resourceConfig)` Resources, including ML compute instances and ML storage volumes, that are configured for model training.
`void`	`setRoleArn(String roleArn)` The AWS Identity and Access Management (IAM) role configured for the training job.
`void`	`setSecondaryStatus(String secondaryStatus)` Provides granular information about the system state.
`void`	`setSecondaryStatusTransitions(Collection<SecondaryStatusTransition> secondaryStatusTransitions)` A log of time-ordered secondary statuses that a training job has transitioned.
`void`	`setStoppingCondition(StoppingCondition stoppingCondition)` The condition under which to stop the training job.
`void`	`setTrainingEndTime(Date trainingEndTime)` Indicates the time when the training job ends on training instances.
`void`	`setTrainingJobArn(String trainingJobArn)` The Amazon Resource Name (ARN) of the training job.
`void`	`setTrainingJobName(String trainingJobName)` Name of the model training job.
`void`	`setTrainingJobStatus(String trainingJobStatus)` The status of the training job.
`void`	`setTrainingStartTime(Date trainingStartTime)` Indicates the time when the training job starts on training instances.
`void`	`setTuningJobArn(String tuningJobArn)` The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
`void`	`setVpcConfig(VpcConfig vpcConfig)` A VpcConfig object that specifies the VPC that this training job has access to.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeTrainingJobResult`	`withAlgorithmSpecification(AlgorithmSpecification algorithmSpecification)` Information about the algorithm used for training, and algorithm metadata.
`DescribeTrainingJobResult`	`withCreationTime(Date creationTime)` A timestamp that indicates when the training job was created.
`DescribeTrainingJobResult`	`withFailureReason(String failureReason)` If the training job failed, the reason it failed.
`DescribeTrainingJobResult`	`withHyperParameters(Map<String,String> hyperParameters)` Algorithm-specific parameters.
`DescribeTrainingJobResult`	`withInputDataConfig(Channel... inputDataConfig)` An array of `Channel` objects that describes each data input channel.
`DescribeTrainingJobResult`	`withInputDataConfig(Collection<Channel> inputDataConfig)` An array of `Channel` objects that describes each data input channel.
`DescribeTrainingJobResult`	`withLastModifiedTime(Date lastModifiedTime)` A timestamp that indicates when the status of the training job was last modified.
`DescribeTrainingJobResult`	`withModelArtifacts(ModelArtifacts modelArtifacts)` Information about the Amazon S3 location that is configured for storing model artifacts.
`DescribeTrainingJobResult`	`withOutputDataConfig(OutputDataConfig outputDataConfig)` The S3 path where model artifacts that you configured when creating the job are stored.
`DescribeTrainingJobResult`	`withResourceConfig(ResourceConfig resourceConfig)` Resources, including ML compute instances and ML storage volumes, that are configured for model training.
`DescribeTrainingJobResult`	`withRoleArn(String roleArn)` The AWS Identity and Access Management (IAM) role configured for the training job.
`DescribeTrainingJobResult`	`withSecondaryStatus(SecondaryStatus secondaryStatus)` Provides granular information about the system state.
`DescribeTrainingJobResult`	`withSecondaryStatus(String secondaryStatus)` Provides granular information about the system state.
`DescribeTrainingJobResult`	`withSecondaryStatusTransitions(Collection<SecondaryStatusTransition> secondaryStatusTransitions)` A log of time-ordered secondary statuses that a training job has transitioned.
`DescribeTrainingJobResult`	`withSecondaryStatusTransitions(SecondaryStatusTransition... secondaryStatusTransitions)` A log of time-ordered secondary statuses that a training job has transitioned.
`DescribeTrainingJobResult`	`withStoppingCondition(StoppingCondition stoppingCondition)` The condition under which to stop the training job.
`DescribeTrainingJobResult`	`withTrainingEndTime(Date trainingEndTime)` Indicates the time when the training job ends on training instances.
`DescribeTrainingJobResult`	`withTrainingJobArn(String trainingJobArn)` The Amazon Resource Name (ARN) of the training job.
`DescribeTrainingJobResult`	`withTrainingJobName(String trainingJobName)` Name of the model training job.
`DescribeTrainingJobResult`	`withTrainingJobStatus(String trainingJobStatus)` The status of the training job.
`DescribeTrainingJobResult`	`withTrainingJobStatus(TrainingJobStatus trainingJobStatus)` The status of the training job.
`DescribeTrainingJobResult`	`withTrainingStartTime(Date trainingStartTime)` Indicates the time when the training job starts on training instances.
`DescribeTrainingJobResult`	`withTuningJobArn(String tuningJobArn)` The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
`DescribeTrainingJobResult`	`withVpcConfig(VpcConfig vpcConfig)` A VpcConfig object that specifies the VPC that this training job has access to.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - DescribeTrainingJobResult
```
public DescribeTrainingJobResult()
```
- Method Detail
  - setTrainingJobName
```
public void setTrainingJobName(String trainingJobName)
```
    Name of the model training job.
    
    Parameters:
    
    trainingJobName - Name of the model training job.
  - getTrainingJobName
```
public String getTrainingJobName()
```
    Name of the model training job.
    
    Returns:
    
    Name of the model training job.
  - withTrainingJobName
```
public DescribeTrainingJobResult withTrainingJobName(String trainingJobName)
```
    Name of the model training job.
    
    Parameters:
    
    trainingJobName - Name of the model training job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrainingJobArn
```
public void setTrainingJobArn(String trainingJobArn)
```
    The Amazon Resource Name (ARN) of the training job.
    
    Parameters:
    
    trainingJobArn - The Amazon Resource Name (ARN) of the training job.
  - getTrainingJobArn
```
public String getTrainingJobArn()
```
    The Amazon Resource Name (ARN) of the training job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the training job.
  - withTrainingJobArn
```
public DescribeTrainingJobResult withTrainingJobArn(String trainingJobArn)
```
    The Amazon Resource Name (ARN) of the training job.
    
    Parameters:
    
    trainingJobArn - The Amazon Resource Name (ARN) of the training job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTuningJobArn
```
public void setTuningJobArn(String tuningJobArn)
```
    The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
    
    Parameters:
    
    tuningJobArn - The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
  - getTuningJobArn
```
public String getTuningJobArn()
```
    The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
  - withTuningJobArn
```
public DescribeTrainingJobResult withTuningJobArn(String tuningJobArn)
```
    The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
    
    Parameters:
    
    tuningJobArn - The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelArtifacts
```
public void setModelArtifacts(ModelArtifacts modelArtifacts)
```
    Information about the Amazon S3 location that is configured for storing model artifacts.
    
    Parameters:
    
    modelArtifacts - Information about the Amazon S3 location that is configured for storing model artifacts.
  - getModelArtifacts
```
public ModelArtifacts getModelArtifacts()
```
    Information about the Amazon S3 location that is configured for storing model artifacts.
    
    Returns:
    
    Information about the Amazon S3 location that is configured for storing model artifacts.
  - withModelArtifacts
```
public DescribeTrainingJobResult withModelArtifacts(ModelArtifacts modelArtifacts)
```
    Information about the Amazon S3 location that is configured for storing model artifacts.
    
    Parameters:
    
    modelArtifacts - Information about the Amazon S3 location that is configured for storing model artifacts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrainingJobStatus
```
public void setTrainingJobStatus(String 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.
    Parameters:
    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.
    See Also:
    
    TrainingJobStatus
  - getTrainingJobStatus
```
public String getTrainingJobStatus()
```
    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.
    Returns:
    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.
    See Also:
    
    TrainingJobStatus
  - withTrainingJobStatus
```
public DescribeTrainingJobResult withTrainingJobStatus(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TrainingJobStatus
  - withTrainingJobStatus
```
public DescribeTrainingJobResult withTrainingJobStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TrainingJobStatus
  - setSecondaryStatus
```
public void setSecondaryStatus(String secondaryStatus)
```
    Provides granular information about the system state. For more information, see TrainingJobStatus.
    - Starting - starting the training job.
    - LaunchingMLInstances - launching ML instances for the training job.
    - PreparingTrainingStack - preparing the ML instances for the training job.
    - Downloading - downloading the input data.
    - DownloadingTrainingImage - downloading the training algorithm image.
    - Training - model training is in progress.
    - Uploading - uploading the trained model.
    - Stopping - stopping the training job.
    - Stopped - the training job has stopped.
    - MaxRuntimeExceeded - the training exceed the specified the max run time, which means the training job is stopping.
    - Completed - the training job has completed.
    - Failed - the training job has failed. The failure reason is provided in the StatusMessage.
    The valid values for SecondaryStatus are subject to change. They primary provide information on the progress of the training job.
    Parameters:
    secondaryStatus - Provides granular information about the system state. For more information, see TrainingJobStatus.
    
    Starting - starting the training job.
    
    LaunchingMLInstances - launching ML instances for the training job.
    
    PreparingTrainingStack - preparing the ML instances for the training job.
    
    Downloading - downloading the input data.
    
    DownloadingTrainingImage - downloading the training algorithm image.
    
    Training - model training is in progress.
    
    Uploading - uploading the trained model.
    
    Stopping - stopping the training job.
    
    Stopped - the training job has stopped.
    
    MaxRuntimeExceeded - the training exceed the specified the max run time, which means the training job is stopping.
    
    Completed - the training job has completed.
    
    Failed - the training job has failed. The failure reason is provided in the StatusMessage.
    
    The valid values for SecondaryStatus are subject to change. They primary provide information on the progress of the training job.
    See Also:
    
    SecondaryStatus
  - getSecondaryStatus
```
public String getSecondaryStatus()
```
    Provides granular information about the system state. For more information, see TrainingJobStatus.
    - Starting - starting the training job.
    - LaunchingMLInstances - launching ML instances for the training job.
    - PreparingTrainingStack - preparing the ML instances for the training job.
    - Downloading - downloading the input data.
    - DownloadingTrainingImage - downloading the training algorithm image.
    - Training - model training is in progress.
    - Uploading - uploading the trained model.
    - Stopping - stopping the training job.
    - Stopped - the training job has stopped.
    - MaxRuntimeExceeded - the training exceed the specified the max run time, which means the training job is stopping.
    - Completed - the training job has completed.
    - Failed - the training job has failed. The failure reason is provided in the StatusMessage.
    The valid values for SecondaryStatus are subject to change. They primary provide information on the progress of the training job.
    Returns:
    Provides granular information about the system state. For more information, see TrainingJobStatus.
    
    Starting - starting the training job.
    
    LaunchingMLInstances - launching ML instances for the training job.
    
    PreparingTrainingStack - preparing the ML instances for the training job.
    
    Downloading - downloading the input data.
    
    DownloadingTrainingImage - downloading the training algorithm image.
    
    Training - model training is in progress.
    
    Uploading - uploading the trained model.
    
    Stopping - stopping the training job.
    
    Stopped - the training job has stopped.
    
    MaxRuntimeExceeded - the training exceed the specified the max run time, which means the training job is stopping.
    
    Completed - the training job has completed.
    
    Failed - the training job has failed. The failure reason is provided in the StatusMessage.
    
    The valid values for SecondaryStatus are subject to change. They primary provide information on the progress of the training job.
    See Also:
    
    SecondaryStatus
  - withSecondaryStatus
```
public DescribeTrainingJobResult withSecondaryStatus(String secondaryStatus)
```
    Provides granular information about the system state. For more information, see TrainingJobStatus.
    - Starting - starting the training job.
    - LaunchingMLInstances - launching ML instances for the training job.
    - PreparingTrainingStack - preparing the ML instances for the training job.
    - Downloading - downloading the input data.
    - DownloadingTrainingImage - downloading the training algorithm image.
    - Training - model training is in progress.
    - Uploading - uploading the trained model.
    - Stopping - stopping the training job.
    - Stopped - the training job has stopped.
    - MaxRuntimeExceeded - the training exceed the specified the max run time, which means the training job is stopping.
    - Completed - the training job has completed.
    - Failed - the training job has failed. The failure reason is provided in the StatusMessage.
    The valid values for SecondaryStatus are subject to change. They primary provide information on the progress of the training job.
    Parameters:
    secondaryStatus - Provides granular information about the system state. For more information, see TrainingJobStatus.
    
    Starting - starting the training job.
    
    LaunchingMLInstances - launching ML instances for the training job.
    
    PreparingTrainingStack - preparing the ML instances for the training job.
    
    Downloading - downloading the input data.
    
    DownloadingTrainingImage - downloading the training algorithm image.
    
    Training - model training is in progress.
    
    Uploading - uploading the trained model.
    
    Stopping - stopping the training job.
    
    Stopped - the training job has stopped.
    
    MaxRuntimeExceeded - the training exceed the specified the max run time, which means the training job is stopping.
    
    Completed - the training job has completed.
    
    Failed - the training job has failed. The failure reason is provided in the StatusMessage.
    
    The valid values for SecondaryStatus are subject to change. They primary provide information on the progress of the training job.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SecondaryStatus
  - withSecondaryStatus
```
public DescribeTrainingJobResult withSecondaryStatus(SecondaryStatus secondaryStatus)
```
    Provides granular information about the system state. For more information, see TrainingJobStatus.
    - Starting - starting the training job.
    - LaunchingMLInstances - launching ML instances for the training job.
    - PreparingTrainingStack - preparing the ML instances for the training job.
    - Downloading - downloading the input data.
    - DownloadingTrainingImage - downloading the training algorithm image.
    - Training - model training is in progress.
    - Uploading - uploading the trained model.
    - Stopping - stopping the training job.
    - Stopped - the training job has stopped.
    - MaxRuntimeExceeded - the training exceed the specified the max run time, which means the training job is stopping.
    - Completed - the training job has completed.
    - Failed - the training job has failed. The failure reason is provided in the StatusMessage.
    The valid values for SecondaryStatus are subject to change. They primary provide information on the progress of the training job.
    Parameters:
    secondaryStatus - Provides granular information about the system state. For more information, see TrainingJobStatus.
    
    Starting - starting the training job.
    
    LaunchingMLInstances - launching ML instances for the training job.
    
    PreparingTrainingStack - preparing the ML instances for the training job.
    
    Downloading - downloading the input data.
    
    DownloadingTrainingImage - downloading the training algorithm image.
    
    Training - model training is in progress.
    
    Uploading - uploading the trained model.
    
    Stopping - stopping the training job.
    
    Stopped - the training job has stopped.
    
    MaxRuntimeExceeded - the training exceed the specified the max run time, which means the training job is stopping.
    
    Completed - the training job has completed.
    
    Failed - the training job has failed. The failure reason is provided in the StatusMessage.
    
    The valid values for SecondaryStatus are subject to change. They primary provide information on the progress of the training job.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SecondaryStatus
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    If the training job failed, the reason it failed.
    
    Parameters:
    
    failureReason - If the training job failed, the reason it failed.
  - getFailureReason
```
public String getFailureReason()
```
    If the training job failed, the reason it failed.
    
    Returns:
    
    If the training job failed, the reason it failed.
  - withFailureReason
```
public DescribeTrainingJobResult withFailureReason(String failureReason)
```
    If the training job failed, the reason it failed.
    
    Parameters:
    
    failureReason - If the training job failed, the reason it failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getHyperParameters
```
public Map<String,String> getHyperParameters()
```
    Algorithm-specific parameters.
    
    Returns:
    
    Algorithm-specific parameters.
  - setHyperParameters
```
public void setHyperParameters(Map<String,String> hyperParameters)
```
    Algorithm-specific parameters.
    
    Parameters:
    
    hyperParameters - Algorithm-specific parameters.
  - withHyperParameters
```
public DescribeTrainingJobResult withHyperParameters(Map<String,String> hyperParameters)
```
    Algorithm-specific parameters.
    
    Parameters:
    
    hyperParameters - Algorithm-specific parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addHyperParametersEntry
```
public DescribeTrainingJobResult addHyperParametersEntry(String key,
                                                         String value)
```
  - clearHyperParametersEntries
```
public DescribeTrainingJobResult clearHyperParametersEntries()
```
    Removes all the entries added into HyperParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAlgorithmSpecification
```
public void setAlgorithmSpecification(AlgorithmSpecification algorithmSpecification)
```
    Information about the algorithm used for training, and algorithm metadata.
    
    Parameters:
    
    algorithmSpecification - Information about the algorithm used for training, and algorithm metadata.
  - getAlgorithmSpecification
```
public AlgorithmSpecification getAlgorithmSpecification()
```
    Information about the algorithm used for training, and algorithm metadata.
    
    Returns:
    
    Information about the algorithm used for training, and algorithm metadata.
  - withAlgorithmSpecification
```
public DescribeTrainingJobResult withAlgorithmSpecification(AlgorithmSpecification algorithmSpecification)
```
    Information about the algorithm used for training, and algorithm metadata.
    
    Parameters:
    
    algorithmSpecification - Information about the algorithm used for training, and algorithm metadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The AWS Identity and Access Management (IAM) role configured for the training job.
    
    Parameters:
    
    roleArn - The AWS Identity and Access Management (IAM) role configured for the training job.
  - getRoleArn
```
public String getRoleArn()
```
    The AWS Identity and Access Management (IAM) role configured for the training job.
    
    Returns:
    
    The AWS Identity and Access Management (IAM) role configured for the training job.
  - withRoleArn
```
public DescribeTrainingJobResult withRoleArn(String roleArn)
```
    The AWS Identity and Access Management (IAM) role configured for the training job.
    
    Parameters:
    
    roleArn - The AWS Identity and Access Management (IAM) role configured for the training job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInputDataConfig
```
public List<Channel> getInputDataConfig()
```
    An array of Channel objects that describes each data input channel.
    
    Returns:
    
    An array of Channel objects that describes each data input channel.
  - setInputDataConfig
```
public void setInputDataConfig(Collection<Channel> inputDataConfig)
```
    An array of Channel objects that describes each data input channel.
    
    Parameters:
    
    inputDataConfig - An array of Channel objects that describes each data input channel.
  - withInputDataConfig
```
public DescribeTrainingJobResult withInputDataConfig(Channel... inputDataConfig)
```
    An array of Channel objects that describes each data input channel.
    
    NOTE: This method appends the values to the existing list (if any). Use setInputDataConfig(java.util.Collection) or withInputDataConfig(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    inputDataConfig - An array of Channel objects that describes each data input channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInputDataConfig
```
public DescribeTrainingJobResult withInputDataConfig(Collection<Channel> inputDataConfig)
```
    An array of Channel objects that describes each data input channel.
    
    Parameters:
    
    inputDataConfig - An array of Channel objects that describes each data input channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputDataConfig
```
public void setOutputDataConfig(OutputDataConfig outputDataConfig)
```
    The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
    
    Parameters:
    
    outputDataConfig - The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
  - getOutputDataConfig
```
public OutputDataConfig getOutputDataConfig()
```
    The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
    
    Returns:
    
    The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
  - withOutputDataConfig
```
public DescribeTrainingJobResult withOutputDataConfig(OutputDataConfig outputDataConfig)
```
    The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
    
    Parameters:
    
    outputDataConfig - The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceConfig
```
public void setResourceConfig(ResourceConfig resourceConfig)
```
    Resources, including ML compute instances and ML storage volumes, that are configured for model training.
    
    Parameters:
    
    resourceConfig - Resources, including ML compute instances and ML storage volumes, that are configured for model training.
  - getResourceConfig
```
public ResourceConfig getResourceConfig()
```
    Resources, including ML compute instances and ML storage volumes, that are configured for model training.
    
    Returns:
    
    Resources, including ML compute instances and ML storage volumes, that are configured for model training.
  - withResourceConfig
```
public DescribeTrainingJobResult withResourceConfig(ResourceConfig resourceConfig)
```
    Resources, including ML compute instances and ML storage volumes, that are configured for model training.
    
    Parameters:
    
    resourceConfig - Resources, including ML compute instances and ML storage volumes, that are configured for model training.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpcConfig
```
public void setVpcConfig(VpcConfig vpcConfig)
```
    A VpcConfig object that specifies the VPC that this training job has access to. For more information, see train-vpc.
    
    Parameters:
    
    vpcConfig - A VpcConfig object that specifies the VPC that this training job has access to. For more information, see train-vpc.
  - getVpcConfig
```
public VpcConfig getVpcConfig()
```
    A VpcConfig object that specifies the VPC that this training job has access to. For more information, see train-vpc.
    
    Returns:
    
    A VpcConfig object that specifies the VPC that this training job has access to. For more information, see train-vpc.
  - withVpcConfig
```
public DescribeTrainingJobResult withVpcConfig(VpcConfig vpcConfig)
```
    A VpcConfig object that specifies the VPC that this training job has access to. For more information, see train-vpc.
    
    Parameters:
    
    vpcConfig - A VpcConfig object that specifies the VPC that this training job has access to. For more information, see train-vpc.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStoppingCondition
```
public void setStoppingCondition(StoppingCondition stoppingCondition)
```
    The condition under which to stop the training job.
    
    Parameters:
    
    stoppingCondition - The condition under which to stop the training job.
  - getStoppingCondition
```
public StoppingCondition getStoppingCondition()
```
    The condition under which to stop the training job.
    
    Returns:
    
    The condition under which to stop the training job.
  - withStoppingCondition
```
public DescribeTrainingJobResult withStoppingCondition(StoppingCondition stoppingCondition)
```
    The condition under which to stop the training job.
    
    Parameters:
    
    stoppingCondition - The condition under which to stop the training job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    A timestamp that indicates when the training job was created.
    
    Parameters:
    
    creationTime - A timestamp that indicates when the training job was created.
  - getCreationTime
```
public Date getCreationTime()
```
    A timestamp that indicates when the training job was created.
    
    Returns:
    
    A timestamp that indicates when the training job was created.
  - withCreationTime
```
public DescribeTrainingJobResult withCreationTime(Date creationTime)
```
    A timestamp that indicates when the training job was created.
    
    Parameters:
    
    creationTime - A timestamp that indicates when the training job was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrainingStartTime
```
public void setTrainingStartTime(Date trainingStartTime)
```
    Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.
    
    Parameters:
    
    trainingStartTime - Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.
  - getTrainingStartTime
```
public Date getTrainingStartTime()
```
    Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.
    
    Returns:
    
    Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.
  - withTrainingStartTime
```
public DescribeTrainingJobResult withTrainingStartTime(Date trainingStartTime)
```
    Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.
    
    Parameters:
    
    trainingStartTime - Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrainingEndTime
```
public void setTrainingEndTime(Date trainingEndTime)
```
    Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.
    
    Parameters:
    
    trainingEndTime - Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.
  - getTrainingEndTime
```
public Date getTrainingEndTime()
```
    Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.
    
    Returns:
    
    Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.
  - withTrainingEndTime
```
public DescribeTrainingJobResult withTrainingEndTime(Date trainingEndTime)
```
    Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.
    
    Parameters:
    
    trainingEndTime - Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    A timestamp that indicates when the status of the training job was last modified.
    
    Parameters:
    
    lastModifiedTime - A timestamp that indicates when the status of the training job was last modified.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    A timestamp that indicates when the status of the training job was last modified.
    
    Returns:
    
    A timestamp that indicates when the status of the training job was last modified.
  - withLastModifiedTime
```
public DescribeTrainingJobResult withLastModifiedTime(Date lastModifiedTime)
```
    A timestamp that indicates when the status of the training job was last modified.
    
    Parameters:
    
    lastModifiedTime - A timestamp that indicates when the status of the training job was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSecondaryStatusTransitions
```
public List<SecondaryStatusTransition> getSecondaryStatusTransitions()
```
    A log of time-ordered secondary statuses that a training job has transitioned.
    
    Returns:
    
    A log of time-ordered secondary statuses that a training job has transitioned.
  - setSecondaryStatusTransitions
```
public void setSecondaryStatusTransitions(Collection<SecondaryStatusTransition> secondaryStatusTransitions)
```
    A log of time-ordered secondary statuses that a training job has transitioned.
    
    Parameters:
    
    secondaryStatusTransitions - A log of time-ordered secondary statuses that a training job has transitioned.
  - withSecondaryStatusTransitions
```
public DescribeTrainingJobResult withSecondaryStatusTransitions(SecondaryStatusTransition... secondaryStatusTransitions)
```
    A log of time-ordered secondary statuses that a training job has transitioned.
    
    NOTE: This method appends the values to the existing list (if any). Use setSecondaryStatusTransitions(java.util.Collection) or withSecondaryStatusTransitions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    secondaryStatusTransitions - A log of time-ordered secondary statuses that a training job has transitioned.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSecondaryStatusTransitions
```
public DescribeTrainingJobResult withSecondaryStatusTransitions(Collection<SecondaryStatusTransition> secondaryStatusTransitions)
```
    A log of time-ordered secondary statuses that a training job has transitioned.
    
    Parameters:
    
    secondaryStatusTransitions - A log of time-ordered secondary statuses that a training job has transitioned.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeTrainingJobResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DescribeTrainingJobResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeTrainingJobResult

Method Detail

setTrainingJobName

getTrainingJobName

withTrainingJobName

setTrainingJobArn

getTrainingJobArn

withTrainingJobArn

setTuningJobArn

getTuningJobArn

withTuningJobArn

setModelArtifacts

getModelArtifacts

withModelArtifacts

setTrainingJobStatus

getTrainingJobStatus

withTrainingJobStatus

withTrainingJobStatus

setSecondaryStatus

getSecondaryStatus

withSecondaryStatus

withSecondaryStatus

setFailureReason

getFailureReason

withFailureReason

getHyperParameters

setHyperParameters

withHyperParameters

addHyperParametersEntry

clearHyperParametersEntries

setAlgorithmSpecification

getAlgorithmSpecification

withAlgorithmSpecification

setRoleArn

getRoleArn

withRoleArn

getInputDataConfig

setInputDataConfig

withInputDataConfig

withInputDataConfig

setOutputDataConfig

getOutputDataConfig

withOutputDataConfig

setResourceConfig

getResourceConfig

withResourceConfig

setVpcConfig

getVpcConfig

withVpcConfig

setStoppingCondition

getStoppingCondition

withStoppingCondition

setCreationTime

getCreationTime

withCreationTime

setTrainingStartTime

getTrainingStartTime

withTrainingStartTime

setTrainingEndTime

getTrainingEndTime

withTrainingEndTime

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

getSecondaryStatusTransitions

setSecondaryStatusTransitions

withSecondaryStatusTransitions

withSecondaryStatusTransitions

toString

equals

hashCode

clone