Skip to content

Create Label

lookoutequipment_create_label R Documentation

Creates a label for an event

Description

Creates a label for an event.

Usage

lookoutequipment_create_label(LabelGroupName, StartTime, EndTime,
  Rating, FaultCode, Notes, Equipment, ClientToken)

Arguments

LabelGroupName

[required] 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.

StartTime

[required] The start time of the labeled event.

EndTime

[required] The end time of the labeled event.

Rating

[required] Indicates whether a labeled event represents an anomaly.

FaultCode

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.

Notes

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.

Equipment

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.

ClientToken

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

Value

A list with the following syntax: 

list(
  LabelId = "string"
)

Request syntax

svc$create_label(
  LabelGroupName = "string",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  Rating = "ANOMALY"|"NO_ANOMALY"|"NEUTRAL",
  FaultCode = "string",
  Notes = "string",
  Equipment = "string",
  ClientToken = "string"
)