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 AutoMLJobArn System.String

Gets and sets the property AutoMLJobArn.

The Amazon Resource Name (ARN) of an AutoML job.

Public Property BillableTimeInSeconds System.Int32

Gets and sets the property BillableTimeInSeconds.

The billable time in seconds. Billable time refers to the absolute wall-clock time.

Multiply BillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run distributed training. The formula is as follows: BillableTimeInSeconds * InstanceCount .

You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.

Public Property CheckpointConfig Amazon.SageMaker.Model.CheckpointConfig

Gets and sets the property CheckpointConfig.

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 DebugHookConfig Amazon.SageMaker.Model.DebugHookConfig

Gets and sets the property DebugHookConfig.

Public Property DebugRuleConfigurations System.Collections.Generic.List<Amazon.SageMaker.Model.DebugRuleConfiguration>

Gets and sets the property DebugRuleConfigurations.

Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

Public Property DebugRuleEvaluationStatuses System.Collections.Generic.List<Amazon.SageMaker.Model.DebugRuleEvaluationStatus>

Gets and sets the property DebugRuleEvaluationStatuses.

Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.

Public Property EnableInterContainerTrafficEncryption System.Boolean

Gets and sets the property EnableInterContainerTrafficEncryption.

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.

Public Property EnableManagedSpotTraining System.Boolean

Gets and sets the property EnableManagedSpotTraining.

A Boolean indicating whether managed spot training is enabled (True) or not (False).

Public Property EnableNetworkIsolation System.Boolean

Gets and sets the property EnableNetworkIsolation.

If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

Public Property Environment System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Environment.

The environment variables to set in the Docker container.

Public Property ExperimentConfig Amazon.SageMaker.Model.ExperimentConfig

Gets and sets the property ExperimentConfig.

Public Property FailureReason System.String

Gets and sets the property FailureReason.

If the training job failed, the reason it failed.

Public Property FinalMetricDataList System.Collections.Generic.List<Amazon.SageMaker.Model.MetricData>

Gets and sets the property FinalMetricDataList.

A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.

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 InfraCheckConfig Amazon.SageMaker.Model.InfraCheckConfig

Gets and sets the property InfraCheckConfig.

Contains information about the infrastructure health check configuration for the training job.

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 LabelingJobArn System.String

Gets and sets the property LabelingJobArn.

The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the transform or training job.

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. SageMaker creates subfolders for model artifacts.

Public Property ProfilerConfig Amazon.SageMaker.Model.ProfilerConfig

Gets and sets the property ProfilerConfig.

Public Property ProfilerRuleConfigurations System.Collections.Generic.List<Amazon.SageMaker.Model.ProfilerRuleConfiguration>

Gets and sets the property ProfilerRuleConfigurations.

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

Public Property ProfilerRuleEvaluationStatuses System.Collections.Generic.List<Amazon.SageMaker.Model.ProfilerRuleEvaluationStatus>

Gets and sets the property ProfilerRuleEvaluationStatuses.

Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.

Public Property ProfilingStatus Amazon.SageMaker.ProfilingStatus

Gets and sets the property ProfilingStatus.

Profiling status of a training job.

Public Property RemoteDebugConfig Amazon.SageMaker.Model.RemoteDebugConfig

Gets and sets the property RemoteDebugConfig.

Configuration for remote debugging. To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.

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 RetryStrategy Amazon.SageMaker.Model.RetryStrategy

Gets and sets the property RetryStrategy.

The number of times to retry the job when the job fails due to an InternalServerError.

Public Property RoleArn System.String

Gets and sets the property RoleArn.

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

Public Property SecondaryStatus Amazon.SageMaker.SecondaryStatus

Gets and sets the property SecondaryStatus.

Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

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.

  • Interrupted - The job stopped because the managed spot training instances were interrupted.

  • 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.

  • MaxWaitTimeExceeded - The job stopped because it exceeded the maximum allowed wait time.

  • Stopped - The training job has stopped.

Stopping
  • Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTraining

  • DownloadingTrainingImage

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

Gets and sets the property SecondaryStatusTransitions.

A history of all of the secondary statuses that the training job has transitioned through.

Public Property StoppingCondition Amazon.SageMaker.Model.StoppingCondition

Gets and sets the property StoppingCondition.

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

Public Property TensorBoardOutputConfig Amazon.SageMaker.Model.TensorBoardOutputConfig

Gets and sets the property TensorBoardOutputConfig.

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 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.

SageMaker provides the following training job statuses:

  • InProgress - The training is in progress.

  • Completed - The training job has completed.

  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

  • Stopping - The training job is stopping.

  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

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 TrainingTimeInSeconds System.Int32

Gets and sets the property TrainingTimeInSeconds.

The training time in seconds.

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 Protect Training Jobs by Using an Amazon Virtual Private Cloud.

Public Property WarmPoolStatus Amazon.SageMaker.Model.WarmPoolStatus

Gets and sets the property WarmPoolStatus.

The status of the warm pool associated with the training job.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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