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

Class GetTrainedModelResponse

    • Method Detail

      • membershipIdentifier

        public final String membershipIdentifier()

        The membership ID of the member that created the trained model.

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

      • collaborationIdentifier

        public final String collaborationIdentifier()

        The collaboration ID of the collaboration that contains the trained model.

        Returns:
        The collaboration ID of the collaboration that contains the trained model.

      • trainedModelArn

        public final String trainedModelArn()

        The Amazon Resource Name (ARN) of the trained model.

        Returns:
        The Amazon Resource Name (ARN) of the trained model.

      • name

        public final String name()

        The name of the trained model.

        Returns:
        The name of the trained model.

      • description

        public final String description()

        The description of the trained model.

        Returns:
        The description of the trained model.

      • statusDetails

        public final StatusDetails statusDetails()
        Returns the value of the StatusDetails property for this object.
        Returns:
        The value of the StatusDetails property for this object.

      • configuredModelAlgorithmAssociationArn

        public final String configuredModelAlgorithmAssociationArn()

        The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create the trained model.

        Returns:
        The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create the trained model.

      • resourceConfig

        public final ResourceConfig resourceConfig()

        The EC2 resource configuration that was used to create the trained model.

        Returns:
        The EC2 resource configuration that was used to create the trained model.

      • stoppingCondition

        public final StoppingCondition stoppingCondition()

        The stopping condition that was used to terminate model training.

        Returns:
        The stopping condition that was used to terminate model training.

      • metricsStatusAsString

        public final String metricsStatusAsString()

        The status of the model metrics.

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

        Returns:
        The status of the model metrics.
        See Also:
        MetricsStatus

      • metricsStatusDetails

        public final String metricsStatusDetails()

        Details about the metrics status for the trained model.

        Returns:
        Details about the metrics status for the trained model.

      • logsStatus

        public final LogsStatus logsStatus()

        The logs status for the trained model.

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

        Returns:
        The logs status for the trained model.
        See Also:
        LogsStatus

      • logsStatusAsString

        public final String logsStatusAsString()

        The logs status for the trained model.

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

        Returns:
        The logs status for the trained model.
        See Also:
        LogsStatus

      • logsStatusDetails

        public final String logsStatusDetails()

        Details about the logs status for the trained model.

        Returns:
        Details about the logs status for the trained model.

      • trainingContainerImageDigest

        public final String trainingContainerImageDigest()

        Information about the training image container.

        Returns:
        Information about the training image container.

      • createTime

        public final Instant createTime()

        The time at which the trained model was created.

        Returns:
        The time at which the trained model was created.

      • updateTime

        public final Instant updateTime()

        The most recent time at which the trained model was updated.

        Returns:
        The most recent time at which the trained model was updated.

      • 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()

        The hyperparameters that were used to create the trained model.

        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:
        The hyperparameters that were used to create the trained model.

      • 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 EC2 environment that was used to create the trained model.

        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 EC2 environment that was used to create 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 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 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 applied 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 applied 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.

      • 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()

        The data channels that were used for the trained model.

        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:
        The data channels that were used for the trained model.

      • 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