Skip to content

Provides a list of labels

Description

Provides a list of labels.

Usage

lookoutequipment_list_labels(LabelGroupName, IntervalStartTime,
  IntervalEndTime, FaultCode, Equipment, NextToken, MaxResults)

Arguments

  • LabelGroupName

    [required] Returns the name of the label group.

  • IntervalStartTime

    Returns all the labels with a end time equal to or later than the start time given.

  • IntervalEndTime

    Returns all labels with a start time earlier than the end time given.

  • FaultCode

    Returns labels with a particular fault code.

  • Equipment

    Lists the labels that pertain to a particular piece of equipment.

  • NextToken

    An opaque pagination token indicating where to continue the listing of label groups.

  • MaxResults

    Specifies the maximum number of labels to list.

Value

A list with the following syntax:

list(
  NextToken = "string",
  LabelSummaries = list(
    list(
      LabelGroupName = "string",
      LabelId = "string",
      LabelGroupArn = "string",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      ),
      Rating = "ANOMALY"|"NO_ANOMALY"|"NEUTRAL",
      FaultCode = "string",
      Equipment = "string",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$list_labels(
  LabelGroupName = "string",
  IntervalStartTime = as.POSIXct(
    "2015-01-01"
  ),
  IntervalEndTime = as.POSIXct(
    "2015-01-01"
  ),
  FaultCode = "string",
  Equipment = "string",
  NextToken = "string",
  MaxResults = 123
)