TrainingPlanSummary

Details of the training plan.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan.

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.

Type: String

Valid Values: Pending | Active | Scheduled | Expired | Failed

Required: Yes

TrainingPlanArn

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

Type: String

Length Constraints: Minimum length of 50. Maximum length of 2048.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-plan/.*

Required: Yes

TrainingPlanName

The name of the training plan.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}

Required: Yes

AvailableInstanceCount

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

Type: Integer

Valid Range: Minimum value of 0.

Required: No

CurrencyCode

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

Type: String

Required: No

DurationHours

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

Type: Long

Valid Range: Minimum value of 0. Maximum value of 87600.

Required: No

DurationMinutes

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

Type: Long

Valid Range: Minimum value of 0. Maximum value of 59.

Required: No

EndTime

The end time of the training plan.

Type: Timestamp

Required: No

InUseInstanceCount

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

Type: Integer

Valid Range: Minimum value of 0.

Required: No

ReservedCapacitySummaries

A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.

Type: Array of ReservedCapacitySummary objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: No

StartTime

The start time of the training plan.

Type: Timestamp

Required: No

StatusMessage

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

TargetResources

The target resources (e.g., training jobs, HyperPod clusters) 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.

Type: Array of strings

Array Members: Minimum number of 1 item.

Valid Values: training-job | hyperpod-cluster

Required: No

TotalInstanceCount

The total number of instances reserved in this training plan.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

UpfrontFee

The upfront fee for the training plan.

Type: String

Length Constraints: Maximum length of 256.

Required: No

TrainingPlanSummary

Contents

See Also