Struct aws_sdk_sagemaker::types::builders::WarmPoolStatusBuilder

#[non_exhaustive]
pub struct WarmPoolStatusBuilder { /* private fields */ }

A builder for WarmPoolStatus.

Implementations

impl WarmPoolStatusBuilder

pub fn status(self, input: WarmPoolResourceStatus) -> Self

The status of the warm pool.

• InUse: The warm pool is in use for the training job.

• Available: The warm pool is available to reuse for a matching training job.

• Reused: The warm pool moved to a matching training job for reuse.

• Terminated: The warm pool is no longer available. Warm pools are unavailable if they are terminated by a user, terminated for a patch update, or terminated for exceeding the specified KeepAlivePeriodInSeconds.

This field is required.

pub fn set_status(self, input: Option<WarmPoolResourceStatus>) -> Self

The status of the warm pool.

• InUse: The warm pool is in use for the training job.

• Available: The warm pool is available to reuse for a matching training job.

• Reused: The warm pool moved to a matching training job for reuse.

• Terminated: The warm pool is no longer available. Warm pools are unavailable if they are terminated by a user, terminated for a patch update, or terminated for exceeding the specified KeepAlivePeriodInSeconds.

pub fn get_status(&self) -> &Option<WarmPoolResourceStatus>

The status of the warm pool.

• InUse: The warm pool is in use for the training job.

• Available: The warm pool is available to reuse for a matching training job.

• Reused: The warm pool moved to a matching training job for reuse.

• Terminated: The warm pool is no longer available. Warm pools are unavailable if they are terminated by a user, terminated for a patch update, or terminated for exceeding the specified KeepAlivePeriodInSeconds.

pub fn resource_retained_billable_time_in_seconds(self, input: i32) -> Self

The billable time in seconds used by the warm pool. Billable time refers to the absolute wall-clock time.

Multiply ResourceRetainedBillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run warm pool training. The formula is as follows: ResourceRetainedBillableTimeInSeconds * InstanceCount.

pub fn set_resource_retained_billable_time_in_seconds( self, input: Option<i32>, ) -> Self

The billable time in seconds used by the warm pool. Billable time refers to the absolute wall-clock time.

Multiply ResourceRetainedBillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run warm pool training. The formula is as follows: ResourceRetainedBillableTimeInSeconds * InstanceCount.

pub fn get_resource_retained_billable_time_in_seconds(&self) -> &Option<i32>

The billable time in seconds used by the warm pool. Billable time refers to the absolute wall-clock time.

Multiply ResourceRetainedBillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run warm pool training. The formula is as follows: ResourceRetainedBillableTimeInSeconds * InstanceCount.

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

The name of the matching training job that reused the warm pool.

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

The name of the matching training job that reused the warm pool.

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

The name of the matching training job that reused the warm pool.

pub fn build(self) -> WarmPoolStatus

Consumes the builder and constructs a WarmPoolStatus.

Trait Implementations

impl Clone for WarmPoolStatusBuilder

fn clone(&self) -> WarmPoolStatusBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WarmPoolStatusBuilder

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

Formats the value using the given formatter.

impl Default for WarmPoolStatusBuilder

fn default() -> WarmPoolStatusBuilder

Returns the “default value” for a type.

impl PartialEq for WarmPoolStatusBuilder

fn eq(&self, other: &WarmPoolStatusBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WarmPoolStatusBuilder