Struct CreateTrainingPlanFluentBuilder

pub struct CreateTrainingPlanFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateTrainingPlan.

Creates a new training plan in SageMaker to reserve compute capacity.

Amazon SageMaker Training Plan is a capability within SageMaker that allows customers to reserve and manage GPU capacity for large-scale AI model training. It provides a way to secure predictable access to computational resources within specific timelines and budgets, without the need to manage underlying infrastructure.

How it works

Plans can be created for specific resources such as SageMaker Training Jobs or SageMaker HyperPod clusters, automatically provisioning resources, setting up infrastructure, executing workloads, and handling infrastructure failures.

Plan creation workflow

• Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration) using the SearchTrainingPlanOfferings API operation.

• They create a plan that best matches their needs using the ID of the plan offering they want to use.

• After successful upfront payment, the plan's status becomes Scheduled.

• The plan can be used to:

  • Queue training jobs.

  • Allocate to an instance group of a SageMaker HyperPod cluster.

• When the plan start date arrives, it becomes Active. Based on available reserved capacity:

  • Training jobs are launched.

  • Instance groups are provisioned.

Plan composition

A plan can consist of one or more Reserved Capacities, each defined by a specific instance type, quantity, Availability Zone, duration, and start and end times. For more information about Reserved Capacity, see ReservedCapacitySummary .

Implementations

impl CreateTrainingPlanFluentBuilder

pub fn as_input(&self) -> &CreateTrainingPlanInputBuilder

Access the CreateTrainingPlan as a reference.

pub async fn send( self, ) -> Result<CreateTrainingPlanOutput, SdkError<CreateTrainingPlanError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<CreateTrainingPlanOutput, CreateTrainingPlanError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn training_plan_name(self, input: impl Into<String>) -> Self

The name of the training plan to create.

pub fn set_training_plan_name(self, input: Option<String>) -> Self

The name of the training plan to create.

pub fn get_training_plan_name(&self) -> &Option<String>

The name of the training plan to create.

pub fn training_plan_offering_id(self, input: impl Into<String>) -> Self

The unique identifier of the training plan offering to use for creating this plan.

pub fn set_training_plan_offering_id(self, input: Option<String>) -> Self

The unique identifier of the training plan offering to use for creating this plan.

pub fn get_training_plan_offering_id(&self) -> &Option<String>

The unique identifier of the training plan offering to use for creating this plan.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

An array of key-value pairs to apply to this training plan.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

An array of key-value pairs to apply to this training plan.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

An array of key-value pairs to apply to this training plan.

Trait Implementations

impl Clone for CreateTrainingPlanFluentBuilder

fn clone(&self) -> CreateTrainingPlanFluentBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateTrainingPlanFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.