Class: Aws::LookoutEquipment::Types::CreateLabelRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.

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

Returns:

  • (String) 


368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 368

class CreateLabelRequest < Struct.new(
  :label_group_name,
  :start_time,
  :end_time,
  :rating,
  :fault_code,
  :notes,
  :equipment,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The end time of the labeled event.

Returns:

  • (Time) 


368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 368

class CreateLabelRequest < Struct.new(
  :label_group_name,
  :start_time,
  :end_time,
  :rating,
  :fault_code,
  :notes,
  :equipment,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#equipment ⇒ String

Indicates that a label pertains to a particular piece of equipment.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

Returns:

  • (String) 


368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 368

class CreateLabelRequest < Struct.new(
  :label_group_name,
  :start_time,
  :end_time,
  :rating,
  :fault_code,
  :notes,
  :equipment,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#fault_code ⇒ String

Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

Returns:

  • (String) 


368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 368

class CreateLabelRequest < Struct.new(
  :label_group_name,
  :start_time,
  :end_time,
  :rating,
  :fault_code,
  :notes,
  :equipment,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#label_group_name ⇒ String

The name of a group of labels.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

Returns:

  • (String) 


368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 368

class CreateLabelRequest < Struct.new(
  :label_group_name,
  :start_time,
  :end_time,
  :rating,
  :fault_code,
  :notes,
  :equipment,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#notes ⇒ String

Metadata providing additional information about the label.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

Returns:

  • (String) 


368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 368

class CreateLabelRequest < Struct.new(
  :label_group_name,
  :start_time,
  :end_time,
  :rating,
  :fault_code,
  :notes,
  :equipment,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#rating ⇒ String

Indicates whether a labeled event represents an anomaly.

Returns:

  • (String) 


368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 368

class CreateLabelRequest < Struct.new(
  :label_group_name,
  :start_time,
  :end_time,
  :rating,
  :fault_code,
  :notes,
  :equipment,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The start time of the labeled event.

Returns:

  • (Time) 


368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'gems/aws-sdk-lookoutequipment/lib/aws-sdk-lookoutequipment/types.rb', line 368

class CreateLabelRequest < Struct.new(
  :label_group_name,
  :start_time,
  :end_time,
  :rating,
  :fault_code,
  :notes,
  :equipment,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end