SageMaker / Client / search_training_plan_offerings

search_training_plan_offerings#

SageMaker.Client.search_training_plan_offerings(**kwargs)#

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

response = client.search_training_plan_offerings(
    InstanceType='ml.p4d.24xlarge'|'ml.p5.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.trn2.48xlarge',
    InstanceCount=123,
    StartTimeAfter=datetime(2015, 1, 1),
    EndTimeBefore=datetime(2015, 1, 1),
    DurationHours=123,
    TargetResources=[
        'training-job'|'hyperpod-cluster',
    ]
)

Parameters:

InstanceType (string) –
[REQUIRED]

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.
InstanceCount (integer) –
[REQUIRED]

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.
StartTimeAfter (datetime) – A filter to search for training plan offerings with a start time after a specified date.
EndTimeBefore (datetime) – A filter to search for reserved capacity offerings with an end time before a specified date.
DurationHours (integer) – The desired duration in hours for the training plan offerings.
TargetResources (list) –
[REQUIRED]

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.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'TrainingPlanOfferings': [
        {
            'TrainingPlanOfferingId': 'string',
            'TargetResources': [
                'training-job'|'hyperpod-cluster',
            ],
            'RequestedStartTimeAfter': datetime(2015, 1, 1),
            'RequestedEndTimeBefore': datetime(2015, 1, 1),
            'DurationHours': 123,
            'DurationMinutes': 123,
            'UpfrontFee': 'string',
            'CurrencyCode': 'string',
            'ReservedCapacityOfferings': [
                {
                    'InstanceType': 'ml.p4d.24xlarge'|'ml.p5.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.trn2.48xlarge',
                    'InstanceCount': 123,
                    'AvailabilityZone': 'string',
                    'DurationHours': 123,
                    'DurationMinutes': 123,
                    'StartTime': datetime(2015, 1, 1),
                    'EndTime': datetime(2015, 1, 1)
                },
            ]
        },
    ]
}

Response Structure

(dict) –
- TrainingPlanOfferings (list) –
  
  A list of training plan offerings that match the search criteria.
  - (dict) –
    
    Details about a training plan offering.
    
    For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.
    - TrainingPlanOfferingId (string) –
      
      The unique identifier for this training plan offering.
    - TargetResources (list) –
      
      The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) for this training plan offering.
      
      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.
      - (string) –
    - RequestedStartTimeAfter (datetime) –
      
      The requested start time that the user specified when searching for the training plan offering.
    - RequestedEndTimeBefore (datetime) –
      
      The requested end time that the user specified when searching for the training plan offering.
    - DurationHours (integer) –
      
      The number of whole hours in the total duration for this training plan offering.
    - DurationMinutes (integer) –
      
      The additional minutes beyond whole hours in the total duration for this training plan offering.
    - UpfrontFee (string) –
      
      The upfront fee for this training plan offering.
    - CurrencyCode (string) –
      
      The currency code for the upfront fee (e.g., USD).
    - ReservedCapacityOfferings (list) –
      
      A list of reserved capacity offerings associated with this training plan offering.
      - (dict) –
        
        Details about a reserved capacity offering for a training plan offering.
        
        For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.
        
        InstanceType (string) –
        
        The instance type for the reserved capacity offering.
        
        InstanceCount (integer) –
        
        The number of instances in the reserved capacity offering.
        
        AvailabilityZone (string) –
        
        The availability zone for the reserved capacity offering.
        
        DurationHours (integer) –
        
        The number of whole hours in the total duration for this reserved capacity offering.
        
        DurationMinutes (integer) –
        
        The additional minutes beyond whole hours in the total duration for this reserved capacity offering.
        
        StartTime (datetime) –
        
        The start time of the reserved capacity offering.
        
        EndTime (datetime) –
        
        The end time of the reserved capacity offering.

Exceptions

SageMaker.Client.exceptions.ResourceLimitExceeded