Class GetTrainedModelResponse

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

  • Method Details

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

    • versionIdentifier

      public final String versionIdentifier()

      The version identifier of the trained model. This unique identifier distinguishes this version from other versions of the same trained model.

      Returns:
      The version identifier of the trained model. This unique identifier distinguishes this version from other versions of the same trained model.

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

      Information about the incremental training data channels used to create this version of the trained model. This includes details about the base model that was used for incremental training and the channel configuration.

      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:
      Information about the incremental training data channels used to create this version of the trained model. This includes details about the base model that was used for incremental training and the channel configuration.

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

    • status

      public final TrainedModelStatus status()

      The status of the trained model.

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

      Returns:
      The status of the trained model.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the trained model.

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

      Returns:
      The status of the trained model.
      See Also:

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

    • trainingInputMode

      public final TrainingInputMode trainingInputMode()

      The input mode that was used for accessing the training data when this trained model was created. This indicates how the training data was made available to the training algorithm.

      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 that was used for accessing the training data when this trained model was created. This indicates how the training data was made available to the training algorithm.
      See Also:

    • trainingInputModeAsString

      public final String trainingInputModeAsString()

      The input mode that was used for accessing the training data when this trained model was created. This indicates how the training data was made available to the training algorithm.

      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 that was used for accessing the training data when this trained model was created. This indicates how the training data was made available to the training algorithm.
      See Also:

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

    • metricsStatus

      public final MetricsStatus metricsStatus()

      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:

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

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

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

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

    • toBuilder

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

    • builder

      public static GetTrainedModelResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.