Class TrainingPlanSummary

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.TrainingPlanSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TrainingPlanSummary.Builder,TrainingPlanSummary>
@Generated("software.amazon.awssdk:codegen") public final class TrainingPlanSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TrainingPlanSummary.Builder,TrainingPlanSummary>

Details of the training plan.

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

See Also:

  • Method Details

    • trainingPlanArn

      public final String trainingPlanArn()

      The Amazon Resource Name (ARN); of the training plan.

      Returns:
      The Amazon Resource Name (ARN); of the training plan.

    • trainingPlanName

      public final String trainingPlanName()

      The name of the training plan.

      Returns:
      The name of the training plan.

    • status

      public final TrainingPlanStatus status()

      The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.

      If the service returns an enum value that is not available in the current SDK version, status will return TrainingPlanStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.

      If the service returns an enum value that is not available in the current SDK version, status will return TrainingPlanStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.
      See Also:

    • statusMessage

      public final String statusMessage()

      A message providing additional information about the current status of the training plan.

      Returns:
      A message providing additional information about the current status of the training plan.

    • durationHours

      public final Long durationHours()

      The number of whole hours in the total duration for this training plan.

      Returns:
      The number of whole hours in the total duration for this training plan.

    • durationMinutes

      public final Long durationMinutes()

      The additional minutes beyond whole hours in the total duration for this training plan.

      Returns:
      The additional minutes beyond whole hours in the total duration for this training plan.

    • startTime

      public final Instant startTime()

      The start time of the training plan.

      Returns:
      The start time of the training plan.

    • endTime

      public final Instant endTime()

      The end time of the training plan.

      Returns:
      The end time of the training plan.

    • upfrontFee

      public final String upfrontFee()

      The upfront fee for the training plan.

      Returns:
      The upfront fee for the training plan.

    • currencyCode

      public final String currencyCode()

      The currency code for the upfront fee (e.g., USD).

      Returns:
      The currency code for the upfront fee (e.g., USD).

    • totalInstanceCount

      public final Integer totalInstanceCount()

      The total number of instances reserved in this training plan.

      Returns:
      The total number of instances reserved in this training plan.

    • availableInstanceCount

      public final Integer availableInstanceCount()

      The number of instances currently available for use in this training plan.

      Returns:
      The number of instances currently available for use in this training plan.

    • inUseInstanceCount

      public final Integer inUseInstanceCount()

      The number of instances currently in use from this training plan.

      Returns:
      The number of instances currently in use from this training plan.

    • targetResources

      public final List<SageMakerResourceName> targetResources()

      The target resources (e.g., training jobs, HyperPod clusters) that can use this training plan.

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargetResources() method.

      Returns:
      The target resources (e.g., training jobs, HyperPod clusters) that can use this training plan.

      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.

    • hasTargetResources

      public final boolean hasTargetResources()
      For responses, this returns true if the service returned a value for the TargetResources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • targetResourcesAsStrings

      public final List<String> targetResourcesAsStrings()

      The target resources (e.g., training jobs, HyperPod clusters) that can use this training plan.

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargetResources() method.

      Returns:
      The target resources (e.g., training jobs, HyperPod clusters) that can use this training plan.

      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.

    • hasReservedCapacitySummaries

      public final boolean hasReservedCapacitySummaries()
      For responses, this returns true if the service returned a value for the ReservedCapacitySummaries property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • reservedCapacitySummaries

      public final List<ReservedCapacitySummary> reservedCapacitySummaries()

      A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReservedCapacitySummaries() method.

      Returns:
      A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.

    • toBuilder

      public TrainingPlanSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<TrainingPlanSummary.Builder,TrainingPlanSummary>
      Returns:
      a builder for type T

    • builder

      public static TrainingPlanSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TrainingPlanSummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.