Search Training Plan Offerings

sagemaker_search_training_plan_offerings

R Documentation

Searches for available training plan offerings based on specified criteria

Description

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 create_training_plan.

Usage

sagemaker_search_training_plan_offerings(InstanceType, InstanceCount,
  UltraServerType, UltraServerCount, StartTimeAfter, EndTimeBefore,
  DurationHours, TargetResources, TrainingPlanArn)

Arguments

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.
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.
UltraServerType	The type of UltraServer to search for, such as ml.u-p6e-gb200x72.
UltraServerCount	The number of UltraServers to search for.
StartTimeAfter	A filter to search for training plan offerings with a start time after a specified date.
EndTimeBefore	A filter to search for reserved capacity offerings with an end time before a specified date.
DurationHours	The desired duration in hours for the training plan offerings.
TargetResources	The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod, SageMaker Endpoints, Studio apps) 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. A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment. A training plan for Studio apps can be used to launch JupyterLab and Code Editor apps on reserved training plan capacity.
TrainingPlanArn	The Amazon Resource Name (ARN); of an existing training plan to search for extension offerings. When specified, the API returns extension offerings that can be used to extend the specified training plan.

Value

A list with the following syntax:

list(
  TrainingPlanOfferings = list(
    list(
      TrainingPlanOfferingId = "string",
      TargetResources = list(
        "training-job"|"hyperpod-cluster"|"endpoint"|"studio-apps"
      ),
      RequestedStartTimeAfter = as.POSIXct(
        "2015-01-01"
      ),
      RequestedEndTimeBefore = as.POSIXct(
        "2015-01-01"
      ),
      DurationHours = 123,
      DurationMinutes = 123,
      UpfrontFee = "string",
      CurrencyCode = "string",
      ReservedCapacityOfferings = list(
        list(
          ReservedCapacityType = "UltraServer"|"Instance",
          UltraServerType = "string",
          UltraServerCount = 123,
          InstanceType = "ml.p4d.24xlarge"|"ml.p5.48xlarge"|"ml.p5e.48xlarge"|"ml.p5en.48xlarge"|"ml.trn1.32xlarge"|"ml.trn2.48xlarge"|"ml.p6-b200.48xlarge"|"ml.p4de.24xlarge"|"ml.p6e-gb200.36xlarge"|"ml.p5.4xlarge"|"ml.p6-b300.48xlarge",
          InstanceCount = 123,
          AvailabilityZone = "string",
          DurationHours = 123,
          DurationMinutes = 123,
          StartTime = as.POSIXct(
            "2015-01-01"
          ),
          EndTime = as.POSIXct(
            "2015-01-01"
          ),
          ExtensionStartTime = as.POSIXct(
            "2015-01-01"
          ),
          ExtensionEndTime = as.POSIXct(
            "2015-01-01"
          )
        )
      )
    )
  ),
  TrainingPlanExtensionOfferings = list(
    list(
      TrainingPlanExtensionOfferingId = "string",
      AvailabilityZone = "string",
      StartDate = as.POSIXct(
        "2015-01-01"
      ),
      EndDate = as.POSIXct(
        "2015-01-01"
      ),
      DurationHours = 123,
      UpfrontFee = "string",
      CurrencyCode = "string"
    )
  )
)

Request syntax

svc$search_training_plan_offerings(
  InstanceType = "ml.p4d.24xlarge"|"ml.p5.48xlarge"|"ml.p5e.48xlarge"|"ml.p5en.48xlarge"|"ml.trn1.32xlarge"|"ml.trn2.48xlarge"|"ml.p6-b200.48xlarge"|"ml.p4de.24xlarge"|"ml.p6e-gb200.36xlarge"|"ml.p5.4xlarge"|"ml.p6-b300.48xlarge",
  InstanceCount = 123,
  UltraServerType = "string",
  UltraServerCount = 123,
  StartTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  EndTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  DurationHours = 123,
  TargetResources = list(
    "training-job"|"hyperpod-cluster"|"endpoint"|"studio-apps"
  ),
  TrainingPlanArn = "string"
)