/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::IoTEventsData::AlarmSummary

NAME

Paws::IoTEventsData::AlarmSummary

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::IoTEventsData::AlarmSummary object:

$service_obj->Method(Att1 => { AlarmModelName => $value, ..., StateName => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::IoTEventsData::AlarmSummary object:

$result = $service_obj->Method(...);
$result->Att1->AlarmModelName

DESCRIPTION

Contains a summary of an alarm.

ATTRIBUTES

AlarmModelName => Str

The name of the alarm model.

AlarmModelVersion => Str

The version of the alarm model.

CreationTime => Str

The time the alarm was created, in the Unix epoch format.

KeyValue => Str

The value of the key used as a filter to select only the alarms associated with the key (https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key).

LastUpdateTime => Str

The time the alarm was last updated, in the Unix epoch format.

StateName => Str

The name of the alarm state. The state name can be one of the following values:

  • DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.

  • NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.

  • ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.

  • ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.

  • SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.

  • LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::IoTEventsData

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues