Package software.amazon.awssdk.services.sagemaker.model

Class SearchTrainingPlanOfferingsRequest

    • Method Detail

      • instanceType

        public final ReservedCapacityInstanceType 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.

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

        Returns:
        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.
        See Also:
        ReservedCapacityInstanceType

      • instanceTypeAsString

        public final String instanceTypeAsString()

        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.

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

        Returns:
        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.
        See Also:
        ReservedCapacityInstanceType

      • instanceCount

        public final Integer 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.

        Returns:
        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

        public final Instant startTimeAfter()

        A filter to search for training plan offerings with a start time after a specified date.

        Returns:
        A filter to search for training plan offerings with a start time after a specified date.

      • endTimeBefore

        public final Instant endTimeBefore()

        A filter to search for reserved capacity offerings with an end time before a specified date.

        Returns:
        A filter to search for reserved capacity offerings with an end time before a specified date.

      • durationHours

        public final Long durationHours()

        The desired duration in hours for the training plan offerings.

        Returns:
        The desired duration in hours for the training plan offerings.

      • targetResources

        public final List<SageMakerResourceName> targetResources()

        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.

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

      • 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., 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.

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

      • 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