Class CreateTrainedModelRequest

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

  • Method Details

    • membershipIdentifier

      public final String membershipIdentifier()

      The membership ID of the member that is creating the trained model.

      Returns:
      The membership ID of the member that is creating the trained model.

    • name

      public final String name()

      The name of the trained model.

      Returns:
      The name of the trained model.

    • configuredModelAlgorithmAssociationArn

      public final String configuredModelAlgorithmAssociationArn()

      The associated configured model algorithm used to train this model.

      Returns:
      The associated configured model algorithm used to train this model.

    • hasHyperparameters

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

    • hyperparameters

      public final Map<String,String> hyperparameters()

      Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process.

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

      Returns:
      Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process.

    • hasEnvironment

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

    • environment

      public final Map<String,String> environment()

      The environment variables to set in the Docker container.

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

      Returns:
      The environment variables to set in the Docker container.

    • resourceConfig

      public final ResourceConfig resourceConfig()

      Information about the EC2 resources that are used to train this model.

      Returns:
      Information about the EC2 resources that are used to train this model.

    • stoppingCondition

      public final StoppingCondition stoppingCondition()

      The criteria that is used to stop model training.

      Returns:
      The criteria that is used to stop model training.

    • hasIncrementalTrainingDataChannels

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

    • incrementalTrainingDataChannels

      public final List<IncrementalTrainingDataChannel> incrementalTrainingDataChannels()

      Specifies the incremental training data channels for the trained model.

      Incremental training allows you to create a new trained model with updates without retraining from scratch. You can specify up to one incremental training data channel that references a previously trained model and its version.

      Limit: Maximum of 20 channels total (including both incrementalTrainingDataChannels and dataChannels).

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

      Returns:
      Specifies the incremental training data channels for the trained model.

      Incremental training allows you to create a new trained model with updates without retraining from scratch. You can specify up to one incremental training data channel that references a previously trained model and its version.

      Limit: Maximum of 20 channels total (including both incrementalTrainingDataChannels and dataChannels).

    • hasDataChannels

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

    • dataChannels

      public final List<ModelTrainingDataChannel> dataChannels()

      Defines the data channels that are used as input for the trained model request.

      Limit: Maximum of 20 channels total (including both dataChannels and incrementalTrainingDataChannels).

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

      Returns:
      Defines the data channels that are used as input for the trained model request.

      Limit: Maximum of 20 channels total (including both dataChannels and incrementalTrainingDataChannels).

    • trainingInputMode

      public final TrainingInputMode trainingInputMode()

      The input mode for accessing the training data. This parameter determines how the training data is made available to the training algorithm. Valid values are:

      • File - The training data is downloaded to the training instance and made available as files.

      • FastFile - The training data is streamed directly from Amazon S3 to the training algorithm, providing faster access for large datasets.

      • Pipe - The training data is streamed to the training algorithm using named pipes, which can improve performance for certain algorithms.

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

      Returns:
      The input mode for accessing the training data. This parameter determines how the training data is made available to the training algorithm. Valid values are:

      • File - The training data is downloaded to the training instance and made available as files.

      • FastFile - The training data is streamed directly from Amazon S3 to the training algorithm, providing faster access for large datasets.

      • Pipe - The training data is streamed to the training algorithm using named pipes, which can improve performance for certain algorithms.

      See Also:

    • trainingInputModeAsString

      public final String trainingInputModeAsString()

      The input mode for accessing the training data. This parameter determines how the training data is made available to the training algorithm. Valid values are:

      • File - The training data is downloaded to the training instance and made available as files.

      • FastFile - The training data is streamed directly from Amazon S3 to the training algorithm, providing faster access for large datasets.

      • Pipe - The training data is streamed to the training algorithm using named pipes, which can improve performance for certain algorithms.

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

      Returns:
      The input mode for accessing the training data. This parameter determines how the training data is made available to the training algorithm. Valid values are:

      • File - The training data is downloaded to the training instance and made available as files.

      • FastFile - The training data is streamed directly from Amazon S3 to the training algorithm, providing faster access for large datasets.

      • Pipe - The training data is streamed to the training algorithm using named pipes, which can improve performance for certain algorithms.

      See Also:

    • description

      public final String description()

      The description of the trained model.

      Returns:
      The description of the trained model.

    • kmsKeyArn

      public final String kmsKeyArn()

      The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and the associated data.

      Returns:
      The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and the associated data.

    • 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 Map<String,String> tags()

      The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50.

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8.

      • Maximum value length - 256 Unicode characters in UTF-8.

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

      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 optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50.

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8.

      • Maximum value length - 256 Unicode characters in UTF-8.

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

    • toBuilder

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

    • builder

      public static CreateTrainedModelRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateTrainedModelRequest.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.