Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

SearchTrainingPlanOfferings

Searches for available training plan offerings based on specified criteria.

Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration).
And then, they create a plan that best matches their needs using the ID of the plan offering they want to use.

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

Request Syntax


{
   "DurationHours": number,
   "EndTimeBefore": number,
   "InstanceCount": number,
   "InstanceType": "string",
   "StartTimeAfter": number,
   "TargetResources": [ "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.

DurationHours

The desired duration in hours for the training plan offerings.

Type: Long

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

Required: No

EndTimeBefore

A filter to search for reserved capacity offerings with an end time before a specified date.

Type: Timestamp

Required: No

InstanceCount

The number of instances you want to reserve in the training plan offerings. This allows you to specify the quantity of compute resources needed for your SageMaker training jobs or SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your requirements.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 256.

Required: Yes

InstanceType

The type of instance you want to search for in the available training plan offerings. This field allows you to filter the search results based on the specific compute resources you require for your SageMaker training jobs or SageMaker HyperPod clusters. When searching for training plan offerings, specifying the instance type helps you find Reserved Instances that match your computational needs.

Type: String

Valid Values: ml.p4d.24xlarge | ml.p5.48xlarge | ml.p5e.48xlarge | ml.p5en.48xlarge | ml.trn2.48xlarge

Required: Yes

StartTimeAfter

A filter to search for training plan offerings with a start time after a specified date.

Type: Timestamp

Required: No

TargetResources

The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) to search for in the offerings.

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: Yes

Response Syntax


{
   "TrainingPlanOfferings": [ 
      { 
         "CurrencyCode": "string",
         "DurationHours": number,
         "DurationMinutes": number,
         "RequestedEndTimeBefore": number,
         "RequestedStartTimeAfter": number,
         "ReservedCapacityOfferings": [ 
            { 
               "AvailabilityZone": "string",
               "DurationHours": number,
               "DurationMinutes": number,
               "EndTime": number,
               "InstanceCount": number,
               "InstanceType": "string",
               "StartTime": number
            }
         ],
         "TargetResources": [ "string" ],
         "TrainingPlanOfferingId": "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.

TrainingPlanOfferings

A list of training plan offerings that match the search criteria.

Type: Array of TrainingPlanOffering objects

Array Members: Minimum number of 0 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceLimitExceeded

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400