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

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

Overview

Note:

When making an API call, you may pass CreateModelRequest data as a hash:

{
  model_name: "ModelName", # required
  dataset_name: "DatasetIdentifier", # required
  dataset_schema: {
    inline_data_schema: "InlineDataSchema",
  },
  labels_input_configuration: {
    s3_input_configuration: { # required
      bucket: "S3Bucket", # required
      prefix: "S3Prefix",
    },
  },
  client_token: "IdempotenceToken", # required
  training_data_start_time: Time.now,
  training_data_end_time: Time.now,
  evaluation_data_start_time: Time.now,
  evaluation_data_end_time: Time.now,
  role_arn: "IamRoleArn",
  data_pre_processing_configuration: {
    target_sampling_rate: "PT1S", # accepts PT1S, PT5S, PT10S, PT15S, PT30S, PT1M, PT5M, PT10M, PT15M, PT30M, PT1H
  },
  server_side_kms_key_id: "NameOrArn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  off_condition: "OffCondition",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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)


375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 375

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)
  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



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 375

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)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_nameString

The name of the dataset for the ML model being created.

Returns:

  • (String)


375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 375

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)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_schemaTypes::DatasetSchema

The data schema for the ML model being created.



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 375

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)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_data_end_timeTime

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

Returns:

  • (Time)


375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 375

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)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_data_start_timeTime

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

Returns:

  • (Time)


375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 375

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)
  SENSITIVE = []
  include Aws::Structure
end

#labels_input_configurationTypes::LabelsInputConfiguration

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



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 375

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)
  SENSITIVE = []
  include Aws::Structure
end

#model_nameString

The name for the ML model to be created.

Returns:

  • (String)


375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 375

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)
  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)


375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 375

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)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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

Returns:

  • (String)


375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 375

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)
  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)


375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 375

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)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

Any tags associated with the ML model being created.

Returns:



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 375

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)
  SENSITIVE = []
  include Aws::Structure
end

#training_data_end_timeTime

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

Returns:

  • (Time)


375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 375

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)
  SENSITIVE = []
  include Aws::Structure
end

#training_data_start_timeTime

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

Returns:

  • (Time)


375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 375

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)
  SENSITIVE = []
  include Aws::Structure
end