Package software.amazon.awssdk.services.cleanroomsml.model

Class CreateTrainedModelRequest

    • Method Detail

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

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

        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.

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

      • 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