Class DescribeModelResponse

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

  • Method Details

    • modelName

      public final String modelName()

      The name of the machine learning model being described.

      Returns:
      The name of the machine learning model being described.

    • modelArn

      public final String modelArn()

      The Amazon Resource Name (ARN) of the machine learning model being described.

      Returns:
      The Amazon Resource Name (ARN) of the machine learning model being described.

    • datasetName

      public final String datasetName()

      The name of the dataset being used by the machine learning being described.

      Returns:
      The name of the dataset being used by the machine learning being described.

    • datasetArn

      public final String datasetArn()

      The Amazon Resouce Name (ARN) of the dataset used to create the machine learning model being described.

      Returns:
      The Amazon Resouce Name (ARN) of the dataset used to create the machine learning model being described.

    • schema

      public final String schema()

      A JSON description of the data that is in each time series dataset, including names, column names, and data types.

      Returns:
      A JSON description of the data that is in each time series dataset, including names, column names, and data types.

    • labelsInputConfiguration

      public final LabelsInputConfiguration labelsInputConfiguration()

      Specifies configuration information about the labels input, including its S3 location.

      Returns:
      Specifies configuration information about the labels input, including its S3 location.

    • trainingDataStartTime

      public final Instant trainingDataStartTime()

      Indicates the time reference in the dataset that was used to begin the subset of training data for the machine learning model.

      Returns:
      Indicates the time reference in the dataset that was used to begin the subset of training data for the machine learning model.

    • trainingDataEndTime

      public final Instant trainingDataEndTime()

      Indicates the time reference in the dataset that was used to end the subset of training data for the machine learning model.

      Returns:
      Indicates the time reference in the dataset that was used to end the subset of training data for the machine learning model.

    • evaluationDataStartTime

      public final Instant evaluationDataStartTime()

      Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the machine learning model.

      Returns:
      Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the machine learning model.

    • evaluationDataEndTime

      public final Instant evaluationDataEndTime()

      Indicates the time reference in the dataset that was used to end the subset of evaluation data for the machine learning model.

      Returns:
      Indicates the time reference in the dataset that was used to end the subset of evaluation data for the machine learning model.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of a role with permission to access the data source for the machine learning model being described.

      Returns:
      The Amazon Resource Name (ARN) of a role with permission to access the data source for the machine learning model being described.

    • dataPreProcessingConfiguration

      public final DataPreProcessingConfiguration dataPreProcessingConfiguration()

      The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

      When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H

      Returns:
      The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

      When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H

    • status

      public final ModelStatus status()

      Specifies the current status of the model being described. Status describes the status of the most recent action of the model.

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

      Returns:
      Specifies the current status of the model being described. Status describes the status of the most recent action of the model.
      See Also:

    • statusAsString

      public final String statusAsString()

      Specifies the current status of the model being described. Status describes the status of the most recent action of the model.

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

      Returns:
      Specifies the current status of the model being described. Status describes the status of the most recent action of the model.
      See Also:

    • trainingExecutionStartTime

      public final Instant trainingExecutionStartTime()

      Indicates the time at which the training of the machine learning model began.

      Returns:
      Indicates the time at which the training of the machine learning model began.

    • trainingExecutionEndTime

      public final Instant trainingExecutionEndTime()

      Indicates the time at which the training of the machine learning model was completed.

      Returns:
      Indicates the time at which the training of the machine learning model was completed.

    • failedReason

      public final String failedReason()

      If the training of the machine learning model failed, this indicates the reason for that failure.

      Returns:
      If the training of the machine learning model failed, this indicates the reason for that failure.

    • modelMetrics

      public final String modelMetrics()

      The Model Metrics show an aggregated summary of the model's performance within the evaluation time range. This is the JSON content of the metrics created when evaluating the model.

      Returns:
      The Model Metrics show an aggregated summary of the model's performance within the evaluation time range. This is the JSON content of the metrics created when evaluating the model.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      Indicates the last time the machine learning model was updated. The type of update is not specified.

      Returns:
      Indicates the last time the machine learning model was updated. The type of update is not specified.

    • createdAt

      public final Instant createdAt()

      Indicates the time and date at which the machine learning model was created.

      Returns:
      Indicates the time and date at which the machine learning model was created.

    • serverSideKmsKeyId

      public final String serverSideKmsKeyId()

      Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.

      Returns:
      Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.

    • offCondition

      public final String offCondition()

      Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.

      Returns:
      Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.

    • sourceModelVersionArn

      public final String sourceModelVersionArn()

      The Amazon Resource Name (ARN) of the source model version. This field appears if the active model version was imported.

      Returns:
      The Amazon Resource Name (ARN) of the source model version. This field appears if the active model version was imported.

    • importJobStartTime

      public final Instant importJobStartTime()

      The date and time when the import job was started. This field appears if the active model version was imported.

      Returns:
      The date and time when the import job was started. This field appears if the active model version was imported.

    • importJobEndTime

      public final Instant importJobEndTime()

      The date and time when the import job was completed. This field appears if the active model version was imported.

      Returns:
      The date and time when the import job was completed. This field appears if the active model version was imported.

    • activeModelVersion

      public final Long activeModelVersion()

      The name of the model version used by the inference schedular when running a scheduled inference execution.

      Returns:
      The name of the model version used by the inference schedular when running a scheduled inference execution.

    • activeModelVersionArn

      public final String activeModelVersionArn()

      The Amazon Resource Name (ARN) of the model version used by the inference scheduler when running a scheduled inference execution.

      Returns:
      The Amazon Resource Name (ARN) of the model version used by the inference scheduler when running a scheduled inference execution.

    • modelVersionActivatedAt

      public final Instant modelVersionActivatedAt()

      The date the active model version was activated.

      Returns:
      The date the active model version was activated.

    • previousActiveModelVersion

      public final Long previousActiveModelVersion()

      The model version that was set as the active model version prior to the current active model version.

      Returns:
      The model version that was set as the active model version prior to the current active model version.

    • previousActiveModelVersionArn

      public final String previousActiveModelVersionArn()

      The ARN of the model version that was set as the active model version prior to the current active model version.

      Returns:
      The ARN of the model version that was set as the active model version prior to the current active model version.

    • previousModelVersionActivatedAt

      public final Instant previousModelVersionActivatedAt()

      The date and time when the previous active model version was activated.

      Returns:
      The date and time when the previous active model version was activated.

    • priorModelMetrics

      public final String priorModelMetrics()

      If the model version was retrained, this field shows a summary of the performance of the prior model on the new training range. You can use the information in this JSON-formatted object to compare the new model version and the prior model version.

      Returns:
      If the model version was retrained, this field shows a summary of the performance of the prior model on the new training range. You can use the information in this JSON-formatted object to compare the new model version and the prior model version.

    • latestScheduledRetrainingFailedReason

      public final String latestScheduledRetrainingFailedReason()

      If the model version was generated by retraining and the training failed, this indicates the reason for that failure.

      Returns:
      If the model version was generated by retraining and the training failed, this indicates the reason for that failure.

    • latestScheduledRetrainingStatus

      public final ModelVersionStatus latestScheduledRetrainingStatus()

      Indicates the status of the most recent scheduled retraining run.

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

      Returns:
      Indicates the status of the most recent scheduled retraining run.
      See Also:

    • latestScheduledRetrainingStatusAsString

      public final String latestScheduledRetrainingStatusAsString()

      Indicates the status of the most recent scheduled retraining run.

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

      Returns:
      Indicates the status of the most recent scheduled retraining run.
      See Also:

    • latestScheduledRetrainingModelVersion

      public final Long latestScheduledRetrainingModelVersion()

      Indicates the most recent model version that was generated by retraining.

      Returns:
      Indicates the most recent model version that was generated by retraining.

    • latestScheduledRetrainingStartTime

      public final Instant latestScheduledRetrainingStartTime()

      Indicates the start time of the most recent scheduled retraining run.

      Returns:
      Indicates the start time of the most recent scheduled retraining run.

    • latestScheduledRetrainingAvailableDataInDays

      public final Integer latestScheduledRetrainingAvailableDataInDays()

      Indicates the number of days of data used in the most recent scheduled retraining run.

      Returns:
      Indicates the number of days of data used in the most recent scheduled retraining run.

    • nextScheduledRetrainingStartDate

      public final Instant nextScheduledRetrainingStartDate()

      Indicates the date and time that the next scheduled retraining run will start on. Lookout for Equipment truncates the time you provide to the nearest UTC day.

      Returns:
      Indicates the date and time that the next scheduled retraining run will start on. Lookout for Equipment truncates the time you provide to the nearest UTC day.

    • accumulatedInferenceDataStartTime

      public final Instant accumulatedInferenceDataStartTime()

      Indicates the start time of the inference data that has been accumulated.

      Returns:
      Indicates the start time of the inference data that has been accumulated.

    • accumulatedInferenceDataEndTime

      public final Instant accumulatedInferenceDataEndTime()

      Indicates the end time of the inference data that has been accumulated.

      Returns:
      Indicates the end time of the inference data that has been accumulated.

    • retrainingSchedulerStatus

      public final RetrainingSchedulerStatus retrainingSchedulerStatus()

      Indicates the status of the retraining scheduler.

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

      Returns:
      Indicates the status of the retraining scheduler.
      See Also:

    • retrainingSchedulerStatusAsString

      public final String retrainingSchedulerStatusAsString()

      Indicates the status of the retraining scheduler.

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

      Returns:
      Indicates the status of the retraining scheduler.
      See Also:

    • modelDiagnosticsOutputConfiguration

      public final ModelDiagnosticsOutputConfiguration modelDiagnosticsOutputConfiguration()

      Configuration information for the model's pointwise model diagnostics.

      Returns:
      Configuration information for the model's pointwise model diagnostics.

    • modelQuality

      public final ModelQuality modelQuality()

      Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET.

      If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

      For information about using labels with your models, see Understanding labeling.

      For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment.

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

      Returns:
      Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET.

      If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

      For information about using labels with your models, see Understanding labeling.

      For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment.

      See Also:

    • modelQualityAsString

      public final String modelQualityAsString()

      Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET.

      If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

      For information about using labels with your models, see Understanding labeling.

      For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment.

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

      Returns:
      Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET.

      If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

      For information about using labels with your models, see Understanding labeling.

      For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment.

      See Also:

    • toBuilder

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

    • builder

      public static DescribeModelResponse.Builder builder()

    • serializableBuilderClass

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