Class: Aws::LookoutEquipment::Types::DescribeModelResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#created_atTime

Indicates the time and date at which the ML model was created.

Returns:

  • (Time)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#data_pre_processing_configurationTypes::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



1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_arnString

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

Returns:

  • (String)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_nameString

The name of the dataset being used by the ML being described.

Returns:

  • (String)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_data_end_timeTime

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

Returns:

  • (Time)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_data_start_timeTime

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

Returns:

  • (Time)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#failed_reasonString

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

Returns:

  • (String)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#labels_input_configurationTypes::LabelsInputConfiguration

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



1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_timeTime

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

Returns:

  • (Time)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#model_arnString

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

Returns:

  • (String)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#model_metricsString

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:

  • (String)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#model_nameString

The name of the ML model being described.

Returns:

  • (String)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#off_conditionString

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)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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

Returns:

  • (String)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#schemaString

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

Returns:

  • (String)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#server_side_kms_key_idString

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

Returns:

  • (String)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#training_data_end_timeTime

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

Returns:

  • (Time)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#training_data_start_timeTime

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

Returns:

  • (Time)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#training_execution_end_timeTime

Indicates the time at which the training of the ML model was completed.

Returns:

  • (Time)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end

#training_execution_start_timeTime

Indicates the time at which the training of the ML model began.

Returns:

  • (Time)


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 1132

class DescribeModelResponse < Struct.new(
  :model_name,
  :model_arn,
  :dataset_name,
  :dataset_arn,
  :schema,
  :labels_input_configuration,
  :training_data_start_time,
  :training_data_end_time,
  :evaluation_data_start_time,
  :evaluation_data_end_time,
  :role_arn,
  :data_pre_processing_configuration,
  :status,
  :training_execution_start_time,
  :training_execution_end_time,
  :failed_reason,
  :model_metrics,
  :last_updated_time,
  :created_at,
  :server_side_kms_key_id,
  :off_condition)
  SENSITIVE = []
  include Aws::Structure
end