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

Inheritance Hierarchy

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

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

Syntax

C#
public class DescribeTrainingPlanResponse : AmazonWebServiceResponse

The DescribeTrainingPlanResponse type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AvailableInstanceCount System.Int32

Gets and sets the property AvailableInstanceCount.

The number of instances currently available for use in this training plan.

Public Property AvailableSpareInstanceCount System.Int32

Gets and sets the property AvailableSpareInstanceCount.

The number of available spare instances in the training plan.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property CurrencyCode System.String

Gets and sets the property CurrencyCode.

The currency code for the upfront fee (e.g., USD).

Public Property DurationHours System.Int64

Gets and sets the property DurationHours.

The number of whole hours in the total duration for this training plan.

Public Property DurationMinutes System.Int64

Gets and sets the property DurationMinutes.

The additional minutes beyond whole hours in the total duration for this training plan.

Public Property EndTime System.DateTime

Gets and sets the property EndTime.

The end time of the training plan.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property InUseInstanceCount System.Int32

Gets and sets the property InUseInstanceCount.

The number of instances currently in use from this training plan.

Public Property ReservedCapacitySummaries System.Collections.Generic.List<Amazon.SageMaker.Model.ReservedCapacitySummary>

Gets and sets the property ReservedCapacitySummaries.

The list of Reserved Capacity providing the underlying compute resources of the plan.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property StartTime System.DateTime

Gets and sets the property StartTime.

The start time of the training plan.

Public Property Status Amazon.SageMaker.TrainingPlanStatus

Gets and sets the property Status.

The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.

Public Property StatusMessage System.String

Gets and sets the property StatusMessage.

A message providing additional information about the current status of the training plan.

Public Property TargetResources System.Collections.Generic.List<System.String>

Gets and sets the property TargetResources.

The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) that can use this training plan.

Training plans are specific to their target resource.

  • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

  • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

Public Property TotalInstanceCount System.Int32

Gets and sets the property TotalInstanceCount.

The total number of instances reserved in this training plan.

Public Property TotalUltraServerCount System.Int32

Gets and sets the property TotalUltraServerCount.

The total number of UltraServers reserved to this training plan.

Public Property TrainingPlanArn System.String

Gets and sets the property TrainingPlanArn.

The Amazon Resource Name (ARN); of the training plan.

Public Property TrainingPlanName System.String

Gets and sets the property TrainingPlanName.

The name of the training plan.

Public Property UnhealthyInstanceCount System.Int32

Gets and sets the property UnhealthyInstanceCount.

The number of instances in the training plan that are currently in an unhealthy state.

Public Property UpfrontFee System.String

Gets and sets the property UpfrontFee.

The upfront fee for the training plan.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5