Class: Aws::LookoutEquipment::Types::CreateModelRequest

Inherits:

Struct

• Object
• Struct
• Aws::LookoutEquipment::Types::CreateModelRequest

Defined in:

gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  A unique identifier for the request.

• #data_pre_processing_configuration ⇒ Types::DataPreProcessingConfiguration

  The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment.

• #dataset_name ⇒ String

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

• #dataset_schema ⇒ Types::DatasetSchema

  The data schema for the machine learning model being created.

• #evaluation_data_end_time ⇒ Time

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

• #evaluation_data_start_time ⇒ Time

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

• #labels_input_configuration ⇒ Types::LabelsInputConfiguration

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

• #model_diagnostics_output_configuration ⇒ Types::ModelDiagnosticsOutputConfiguration

  The Amazon S3 location where you want Amazon Lookout for Equipment to save the pointwise model diagnostics.

• #model_name ⇒ String

  The name for the machine learning model to be created.

• #off_condition ⇒ String

  Indicates that the asset associated with this sensor has been shut off.

• #role_arn ⇒ String

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

• #server_side_kms_key_id ⇒ String

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

• #tags ⇒ Array<Types::Tag>

  Any tags associated with the machine learning model being created.

• #training_data_end_time ⇒ Time

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

• #training_data_start_time ⇒ Time

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

Instance Attribute Details

#client_token ⇒ String

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

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 505

class CreateModelRequest < Struct.new(
  :model_name,
  :dataset_name,
  :dataset_schema,
  :labels_input_configuration,
  :client_token,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :server_side_kms_key_id,
  :tags,
  :off_condition,
  :model_diagnostics_output_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#data_pre_processing_configuration ⇒ Types::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:

• (Types::DataPreProcessingConfiguration)

# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 505

class CreateModelRequest < Struct.new(
  :model_name,
  :dataset_name,
  :dataset_schema,
  :labels_input_configuration,
  :client_token,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :server_side_kms_key_id,
  :tags,
  :off_condition,
  :model_diagnostics_output_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 505

class CreateModelRequest < Struct.new(
  :model_name,
  :dataset_name,
  :dataset_schema,
  :labels_input_configuration,
  :client_token,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :server_side_kms_key_id,
  :tags,
  :off_condition,
  :model_diagnostics_output_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_schema ⇒ Types::DatasetSchema

The data schema for the machine learning model being created.

Returns:

• (Types::DatasetSchema)

# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 505

class CreateModelRequest < Struct.new(
  :model_name,
  :dataset_name,
  :dataset_schema,
  :labels_input_configuration,
  :client_token,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :server_side_kms_key_id,
  :tags,
  :off_condition,
  :model_diagnostics_output_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_data_end_time ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 505

class CreateModelRequest < Struct.new(
  :model_name,
  :dataset_name,
  :dataset_schema,
  :labels_input_configuration,
  :client_token,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :server_side_kms_key_id,
  :tags,
  :off_condition,
  :model_diagnostics_output_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_data_start_time ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 505

class CreateModelRequest < Struct.new(
  :model_name,
  :dataset_name,
  :dataset_schema,
  :labels_input_configuration,
  :client_token,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :server_side_kms_key_id,
  :tags,
  :off_condition,
  :model_diagnostics_output_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#labels_input_configuration ⇒ Types::LabelsInputConfiguration

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

Returns:

• (Types::LabelsInputConfiguration)

# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 505

class CreateModelRequest < Struct.new(
  :model_name,
  :dataset_name,
  :dataset_schema,
  :labels_input_configuration,
  :client_token,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :server_side_kms_key_id,
  :tags,
  :off_condition,
  :model_diagnostics_output_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#model_diagnostics_output_configuration ⇒ Types::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:

• (Types::ModelDiagnosticsOutputConfiguration)

# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 505

class CreateModelRequest < Struct.new(
  :model_name,
  :dataset_name,
  :dataset_schema,
  :labels_input_configuration,
  :client_token,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :server_side_kms_key_id,
  :tags,
  :off_condition,
  :model_diagnostics_output_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#model_name ⇒ String

The name for the machine learning model to be created.

Returns:

• (String)

# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 505

class CreateModelRequest < Struct.new(
  :model_name,
  :dataset_name,
  :dataset_schema,
  :labels_input_configuration,
  :client_token,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :server_side_kms_key_id,
  :tags,
  :off_condition,
  :model_diagnostics_output_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#off_condition ⇒ String

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:

• (String)

# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 505

class CreateModelRequest < Struct.new(
  :model_name,
  :dataset_name,
  :dataset_schema,
  :labels_input_configuration,
  :client_token,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :server_side_kms_key_id,
  :tags,
  :off_condition,
  :model_diagnostics_output_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 505

class CreateModelRequest < Struct.new(
  :model_name,
  :dataset_name,
  :dataset_schema,
  :labels_input_configuration,
  :client_token,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :server_side_kms_key_id,
  :tags,
  :off_condition,
  :model_diagnostics_output_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#server_side_kms_key_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 505

class CreateModelRequest < Struct.new(
  :model_name,
  :dataset_name,
  :dataset_schema,
  :labels_input_configuration,
  :client_token,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :server_side_kms_key_id,
  :tags,
  :off_condition,
  :model_diagnostics_output_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Any tags associated with the machine learning model being created.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 505

class CreateModelRequest < Struct.new(
  :model_name,
  :dataset_name,
  :dataset_schema,
  :labels_input_configuration,
  :client_token,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :server_side_kms_key_id,
  :tags,
  :off_condition,
  :model_diagnostics_output_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#training_data_end_time ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 505

class CreateModelRequest < Struct.new(
  :model_name,
  :dataset_name,
  :dataset_schema,
  :labels_input_configuration,
  :client_token,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :server_side_kms_key_id,
  :tags,
  :off_condition,
  :model_diagnostics_output_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#training_data_start_time ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 505

class CreateModelRequest < Struct.new(
  :model_name,
  :dataset_name,
  :dataset_schema,
  :labels_input_configuration,
  :client_token,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :server_side_kms_key_id,
  :tags,
  :off_condition,
  :model_diagnostics_output_configuration)
  SENSITIVE = []
  include Aws::Structure
end