DescribeTrainingPlan
Retrieves detailed information about a specific training plan.
Request Syntax
{
"TrainingPlanName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- TrainingPlanName
-
The name of the training plan to describe.
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
Response Syntax
{
"AvailableInstanceCount": number,
"CurrencyCode": "string",
"DurationHours": number,
"DurationMinutes": number,
"EndTime": number,
"InUseInstanceCount": number,
"ReservedCapacitySummaries": [
{
"AvailabilityZone": "string",
"DurationHours": number,
"DurationMinutes": number,
"EndTime": number,
"InstanceType": "string",
"ReservedCapacityArn": "string",
"StartTime": number,
"Status": "string",
"TotalInstanceCount": number
}
],
"StartTime": number,
"Status": "string",
"StatusMessage": "string",
"TargetResources": [ "string" ],
"TotalInstanceCount": number,
"TrainingPlanArn": "string",
"TrainingPlanName": "string",
"UpfrontFee": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AvailableInstanceCount
-
The number of instances currently available for use in this training plan.
Type: Integer
Valid Range: Minimum value of 0.
- CurrencyCode
-
The currency code for the upfront fee (e.g., USD).
Type: String
- 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.
- 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.
- EndTime
-
The end time of the training plan.
Type: Timestamp
- InUseInstanceCount
-
The number of instances currently in use from this training plan.
Type: Integer
Valid Range: Minimum value of 0.
- ReservedCapacitySummaries
-
The list of Reserved Capacity providing the underlying compute resources of the plan.
Type: Array of ReservedCapacitySummary objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
- StartTime
-
The start time of the training plan.
Type: Timestamp
- 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
Statusattribute within theTrainingPlanSummaryobject.Type: String
Valid Values:
Pending | Active | Scheduled | Expired | Failed - 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.
- 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.
Type: Array of strings
Array Members: Minimum number of 1 item.
Valid Values:
training-job | hyperpod-cluster -
- TotalInstanceCount
-
The total number of instances reserved in this training plan.
Type: Integer
Valid Range: Minimum value of 0.
- 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/.* - 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} - UpfrontFee
-
The upfront fee for the training plan.
Type: String
Length Constraints: Maximum length of 256.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
