Class CreateModelRequest

    • Method Detail

      • modelName

        public final String modelName()

        The name for the machine learning model to be created.

        Returns:
        The name for the machine learning model to be created.
      • datasetName

        public final String datasetName()

        The name of the dataset for the machine learning model being created.

        Returns:
        The name of the dataset for the machine learning model being created.
      • datasetSchema

        public final DatasetSchema datasetSchema()

        The data schema for the machine learning model being created.

        Returns:
        The data schema for the machine learning model being created.
      • labelsInputConfiguration

        public final LabelsInputConfiguration labelsInputConfiguration()

        The input configuration for the labels being used for the machine learning model that's being created.

        Returns:
        The input configuration for the labels being used for the machine learning model that's being created.
      • clientToken

        public final String clientToken()

        A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

        Returns:
        A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.
      • trainingDataStartTime

        public final Instant trainingDataStartTime()

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

        Returns:
        Indicates the time reference in the dataset that should be 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 should be used to end the subset of training data for the machine learning model.

        Returns:
        Indicates the time reference in the dataset that should be 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 should be used to begin the subset of evaluation data for the machine learning model.

        Returns:
        Indicates the time reference in the dataset that should be 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 should be used to end the subset of evaluation data for the machine learning model.

        Returns:
        Indicates the time reference in the dataset that should be 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 being used to create the machine learning model.

        Returns:
        The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the machine learning model.
      • 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

      • 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.
      • 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 List<Tag> tags()

        Any tags associated with the machine learning model being created.

        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:
        Any tags associated with the machine learning model being created.
      • 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.
      • modelDiagnosticsOutputConfiguration

        public final ModelDiagnosticsOutputConfiguration modelDiagnosticsOutputConfiguration()

        The Amazon S3 location where you want Amazon Lookout for Equipment to save the pointwise model diagnostics. You must also specify the RoleArn request parameter.

        Returns:
        The Amazon S3 location where you want Amazon Lookout for Equipment to save the pointwise model diagnostics. You must also specify the RoleArn request parameter.
      • 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