AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This is the response object from the DescribeTrainingJob operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.SageMaker.Model.DescribeTrainingJobResponse

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

C#
public class DescribeTrainingJobResponse : AmazonWebServiceResponse

The DescribeTrainingJobResponse type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AlgorithmSpecification Amazon.SageMaker.Model.AlgorithmSpecification

Gets and sets the property AlgorithmSpecification.

Information about the algorithm used for training, and algorithm metadata.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property CreationTime System.DateTime

Gets and sets the property CreationTime.

A timestamp that indicates when the training job was created.

Public Property FailureReason System.String

Gets and sets the property FailureReason.

If the training job failed, the reason it failed.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property HyperParameters System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property HyperParameters.

Algorithm-specific parameters.

Public Property InputDataConfig System.Collections.Generic.List<Amazon.SageMaker.Model.Channel>

Gets and sets the property InputDataConfig.

An array of Channel objects that describes each data input channel.

Public Property LastModifiedTime System.DateTime

Gets and sets the property LastModifiedTime.

A timestamp that indicates when the status of the training job was last modified.

Public Property ModelArtifacts Amazon.SageMaker.Model.ModelArtifacts

Gets and sets the property ModelArtifacts.

Information about the Amazon S3 location that is configured for storing model artifacts.

Public Property OutputDataConfig Amazon.SageMaker.Model.OutputDataConfig

Gets and sets the property OutputDataConfig.

The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.

Public Property ResourceConfig Amazon.SageMaker.Model.ResourceConfig

Gets and sets the property ResourceConfig.

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property RoleArn System.String

Gets and sets the property RoleArn.

The AWS Identity and Access Management (IAM) role configured for the training job.

Public Property SecondaryStatus Amazon.SageMaker.SecondaryStatus

Gets and sets the property SecondaryStatus.

Provides granular information about the system state. For more information, see TrainingJobStatus.

  • Starting - starting the training job.

  • Downloading - downloading the input data.

  • 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 job exceeded the specified max run time and has been stopped.

  • Completed - the training job has completed.

  • Failed - the training job has failed. The failure reason is stored in the FailureReason field of DescribeTrainingJobResponse.

The valid values for SecondaryStatus are subject to change. They primarily provide information on the progress of the training job.

Public Property SecondaryStatusTransitions System.Collections.Generic.List<Amazon.SageMaker.Model.SecondaryStatusTransition>

Gets and sets the property SecondaryStatusTransitions.

To give an overview of the training job lifecycle, SecondaryStatusTransitions is a log of time-ordered secondary statuses that a training job has transitioned.

Public Property StoppingCondition Amazon.SageMaker.Model.StoppingCondition

Gets and sets the property StoppingCondition.

The condition under which to stop the training job.

Public Property TrainingEndTime System.DateTime

Gets and sets the property 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.

Public Property TrainingJobArn System.String

Gets and sets the property TrainingJobArn.

The Amazon Resource Name (ARN) of the training job.

Public Property TrainingJobName System.String

Gets and sets the property TrainingJobName.

Name of the model training job.

Public Property TrainingJobStatus Amazon.SageMaker.TrainingJobStatus

Gets and sets the property 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.

Public Property TrainingStartTime System.DateTime

Gets and sets the property 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.

Public Property TuningJobArn System.String

Gets and sets the property TuningJobArn.

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

Public Property VpcConfig Amazon.SageMaker.Model.VpcConfig

Gets and sets the property VpcConfig.

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see train-vpc.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms