Class: Aws::LookoutEquipment::Types::CreateInferenceSchedulerRequest

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 CreateInferenceSchedulerRequest data as a hash:

{
  model_name: "ModelName", # required
  inference_scheduler_name: "InferenceSchedulerName", # required
  data_delay_offset_in_minutes: 1,
  data_upload_frequency: "PT5M", # required, accepts PT5M, PT10M, PT15M, PT30M, PT1H
  data_input_configuration: { # required
    s3_input_configuration: {
      bucket: "S3Bucket", # required
      prefix: "S3Prefix",
    },
    input_time_zone_offset: "TimeZoneOffset",
    inference_input_name_configuration: {
      timestamp_format: "FileNameTimestampFormat",
      component_timestamp_delimiter: "ComponentTimestampDelimiter",
    },
  },
  data_output_configuration: { # required
    s3_output_configuration: { # required
      bucket: "S3Bucket", # required
      prefix: "S3Prefix",
    },
    kms_key_id: "NameOrArn",
  },
  role_arn: "IamRoleArn", # required
  server_side_kms_key_id: "NameOrArn",
  client_token: "IdempotenceToken", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

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)


222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 222

class CreateInferenceSchedulerRequest < Struct.new(
  :model_name,
  :inference_scheduler_name,
  :data_delay_offset_in_minutes,
  :data_upload_frequency,
  :data_input_configuration,
  :data_output_configuration,
  :role_arn,
  :server_side_kms_key_id,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#data_delay_offset_in_minutesInteger

A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if you select an offset delay time of five minutes, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data.

Returns:

  • (Integer)


222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 222

class CreateInferenceSchedulerRequest < Struct.new(
  :model_name,
  :inference_scheduler_name,
  :data_delay_offset_in_minutes,
  :data_upload_frequency,
  :data_input_configuration,
  :data_output_configuration,
  :role_arn,
  :server_side_kms_key_id,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#data_input_configurationTypes::InferenceInputConfiguration

Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.



222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 222

class CreateInferenceSchedulerRequest < Struct.new(
  :model_name,
  :inference_scheduler_name,
  :data_delay_offset_in_minutes,
  :data_upload_frequency,
  :data_input_configuration,
  :data_output_configuration,
  :role_arn,
  :server_side_kms_key_id,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#data_output_configurationTypes::InferenceOutputConfiguration

Specifies configuration information for the output results for the inference scheduler, including the S3 location for the output.



222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 222

class CreateInferenceSchedulerRequest < Struct.new(
  :model_name,
  :inference_scheduler_name,
  :data_delay_offset_in_minutes,
  :data_upload_frequency,
  :data_input_configuration,
  :data_output_configuration,
  :role_arn,
  :server_side_kms_key_id,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#data_upload_frequencyString

How often data is uploaded to the source S3 bucket for the input data. The value chosen is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

Returns:

  • (String)


222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 222

class CreateInferenceSchedulerRequest < Struct.new(
  :model_name,
  :inference_scheduler_name,
  :data_delay_offset_in_minutes,
  :data_upload_frequency,
  :data_input_configuration,
  :data_output_configuration,
  :role_arn,
  :server_side_kms_key_id,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#inference_scheduler_nameString

The name of the inference scheduler being created.

Returns:

  • (String)


222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 222

class CreateInferenceSchedulerRequest < Struct.new(
  :model_name,
  :inference_scheduler_name,
  :data_delay_offset_in_minutes,
  :data_upload_frequency,
  :data_input_configuration,
  :data_output_configuration,
  :role_arn,
  :server_side_kms_key_id,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#model_nameString

The name of the previously trained ML model being used to create the inference scheduler.

Returns:

  • (String)


222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 222

class CreateInferenceSchedulerRequest < Struct.new(
  :model_name,
  :inference_scheduler_name,
  :data_delay_offset_in_minutes,
  :data_upload_frequency,
  :data_input_configuration,
  :data_output_configuration,
  :role_arn,
  :server_side_kms_key_id,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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

Returns:

  • (String)


222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 222

class CreateInferenceSchedulerRequest < Struct.new(
  :model_name,
  :inference_scheduler_name,
  :data_delay_offset_in_minutes,
  :data_upload_frequency,
  :data_input_configuration,
  :data_output_configuration,
  :role_arn,
  :server_side_kms_key_id,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#server_side_kms_key_idString

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

Returns:

  • (String)


222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 222

class CreateInferenceSchedulerRequest < Struct.new(
  :model_name,
  :inference_scheduler_name,
  :data_delay_offset_in_minutes,
  :data_upload_frequency,
  :data_input_configuration,
  :data_output_configuration,
  :role_arn,
  :server_side_kms_key_id,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

Any tags associated with the inference scheduler.

Returns:



222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 222

class CreateInferenceSchedulerRequest < Struct.new(
  :model_name,
  :inference_scheduler_name,
  :data_delay_offset_in_minutes,
  :data_upload_frequency,
  :data_input_configuration,
  :data_output_configuration,
  :role_arn,
  :server_side_kms_key_id,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end