Class CreateAiRecommendationJobRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.sagemaker.model.SageMakerRequest
software.amazon.awssdk.services.sagemaker.model.CreateAiRecommendationJobRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateAiRecommendationJobRequest.Builder,CreateAiRecommendationJobRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateAiRecommendationJobRequest extends SageMakerRequest implements ToCopyableBuilder<CreateAiRecommendationJobRequest.Builder,CreateAiRecommendationJobRequest>

  • Method Details

    • aiRecommendationJobName

      public final String aiRecommendationJobName()

      The name of the AI recommendation job. The name must be unique within your Amazon Web Services account in the current Amazon Web Services Region.

      Returns:
      The name of the AI recommendation job. The name must be unique within your Amazon Web Services account in the current Amazon Web Services Region.

    • modelSource

      public final AIModelSource modelSource()

      The source of the model to optimize. Specify the Amazon S3 location of the model artifacts.

      Returns:
      The source of the model to optimize. Specify the Amazon S3 location of the model artifacts.

    • outputConfig

      public final AIRecommendationOutputConfig outputConfig()

      The output configuration for the recommendation job, including the Amazon S3 location for results and an optional model package group where the optimized model is registered.

      Returns:
      The output configuration for the recommendation job, including the Amazon S3 location for results and an optional model package group where the optimized model is registered.

    • aiWorkloadConfigIdentifier

      public final String aiWorkloadConfigIdentifier()

      The name or Amazon Resource Name (ARN) of the AI workload configuration to use for this recommendation job.

      Returns:
      The name or Amazon Resource Name (ARN) of the AI workload configuration to use for this recommendation job.

    • performanceTarget

      public final AIRecommendationPerformanceTarget performanceTarget()

      The performance targets for the recommendation job. Specify constraints on metrics such as time to first token ( ttft-ms), throughput, or cost.

      Returns:
      The performance targets for the recommendation job. Specify constraints on metrics such as time to first token (ttft-ms), throughput, or cost.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

      Returns:
      The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

    • inferenceSpecification

      public final AIRecommendationInferenceSpecification inferenceSpecification()

      The inference framework configuration. Specify the framework (such as LMI or vLLM) for the recommendation job.

      Returns:
      The inference framework configuration. Specify the framework (such as LMI or vLLM) for the recommendation job.

    • optimizeModel

      public final Boolean optimizeModel()

      Whether to allow model optimization techniques such as quantization, speculative decoding, and kernel tuning. The default is true.

      Returns:
      Whether to allow model optimization techniques such as quantization, speculative decoding, and kernel tuning. The default is true.

    • computeSpec

      public final AIRecommendationComputeSpec computeSpec()

      The compute resource specification for the recommendation job. You can specify up to 3 instance types to consider, and optionally provide capacity reservation configuration.

      Returns:
      The compute resource specification for the recommendation job. You can specify up to 3 instance types to consider, and optionally provide capacity reservation configuration.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.

      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 hasTags() method.

      Returns:
      The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.

    • toBuilder

      public CreateAiRecommendationJobRequest.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<CreateAiRecommendationJobRequest.Builder,CreateAiRecommendationJobRequest>
      Specified by:
      toBuilder in class SageMakerRequest
      Returns:
      a builder for type T

    • builder

      public static CreateAiRecommendationJobRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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