« blib/lib/Paws/IoTEvents/DescribeAlarmModel.pm
↑ Summary
blib/lib/Paws/IoTEvents/DescribeDetectorModel.pm »
| 1 | |||
| 2 | package Paws::IoTEvents::DescribeAlarmModelResponse; | ||
| 3 | use Moose; | ||
| 4 | has AlarmCapabilities => (is => 'ro', isa => 'Paws::IoTEvents::AlarmCapabilities', traits => ['NameInRequest'], request_name => 'alarmCapabilities'); | ||
| 5 | has AlarmEventActions => (is => 'ro', isa => 'Paws::IoTEvents::AlarmEventActions', traits => ['NameInRequest'], request_name => 'alarmEventActions'); | ||
| 6 | has AlarmModelArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'alarmModelArn'); | ||
| 7 | has AlarmModelDescription => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'alarmModelDescription'); | ||
| 8 | has AlarmModelName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'alarmModelName'); | ||
| 9 | has AlarmModelVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'alarmModelVersion'); | ||
| 10 | has AlarmNotification => (is => 'ro', isa => 'Paws::IoTEvents::AlarmNotification', traits => ['NameInRequest'], request_name => 'alarmNotification'); | ||
| 11 | has AlarmRule => (is => 'ro', isa => 'Paws::IoTEvents::AlarmRule', traits => ['NameInRequest'], request_name => 'alarmRule'); | ||
| 12 | has CreationTime => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'creationTime'); | ||
| 13 | has Key => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'key'); | ||
| 14 | has LastUpdateTime => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'lastUpdateTime'); | ||
| 15 | has RoleArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'roleArn'); | ||
| 16 | has Severity => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'severity'); | ||
| 17 | has Status => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'status'); | ||
| 18 | has StatusMessage => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'statusMessage'); | ||
| 19 | |||
| 20 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::IoTEvents::DescribeAlarmModelResponse | ||
| 28 | |||
| 29 | =head1 ATTRIBUTES | ||
| 30 | |||
| 31 | |||
| 32 | =head2 AlarmCapabilities => L<Paws::IoTEvents::AlarmCapabilities> | ||
| 33 | |||
| 34 | Contains the configuration information of alarm state changes. | ||
| 35 | |||
| 36 | |||
| 37 | =head2 AlarmEventActions => L<Paws::IoTEvents::AlarmEventActions> | ||
| 38 | |||
| 39 | Contains information about one or more alarm actions. | ||
| 40 | |||
| 41 | |||
| 42 | =head2 AlarmModelArn => Str | ||
| 43 | |||
| 44 | The ARN of the alarm model. For more information, see Amazon Resource | ||
| 45 | Names (ARNs) | ||
| 46 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) | ||
| 47 | in the I<AWS General Reference>. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 AlarmModelDescription => Str | ||
| 51 | |||
| 52 | The description of the alarm model. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 AlarmModelName => Str | ||
| 56 | |||
| 57 | The name of the alarm model. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 AlarmModelVersion => Str | ||
| 61 | |||
| 62 | The version of the alarm model. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 AlarmNotification => L<Paws::IoTEvents::AlarmNotification> | ||
| 66 | |||
| 67 | Contains information about one or more notification actions. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 AlarmRule => L<Paws::IoTEvents::AlarmRule> | ||
| 71 | |||
| 72 | Defines when your alarm is invoked. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 CreationTime => Str | ||
| 76 | |||
| 77 | The time the alarm model was created, in the Unix epoch format. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 Key => Str | ||
| 81 | |||
| 82 | An input attribute used as a key to create an alarm. AWS IoT Events | ||
| 83 | routes inputs | ||
| 84 | (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) | ||
| 85 | associated with this key to the alarm. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 LastUpdateTime => Str | ||
| 89 | |||
| 90 | The time the alarm model was last updated, in the Unix epoch format. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 RoleArn => Str | ||
| 94 | |||
| 95 | The ARN of the IAM role that allows the alarm to perform actions and | ||
| 96 | access AWS resources. For more information, see Amazon Resource Names | ||
| 97 | (ARNs) | ||
| 98 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) | ||
| 99 | in the I<AWS General Reference>. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 Severity => Int | ||
| 103 | |||
| 104 | A non-negative integer that reflects the severity level of the alarm. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 Status => Str | ||
| 108 | |||
| 109 | The status of the alarm model. The status can be one of the following | ||
| 110 | values: | ||
| 111 | |||
| 112 | =over | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | C<ACTIVE> - The alarm model is active and it's ready to evaluate data. | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | C<ACTIVATING> - AWS IoT Events is activating your alarm model. | ||
| 121 | Activating an alarm model can take up to a few minutes. | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | C<INACTIVE> - The alarm model is inactive, so it isn't ready to | ||
| 126 | evaluate data. Check your alarm model information and update the alarm | ||
| 127 | model. | ||
| 128 | |||
| 129 | =item * | ||
| 130 | |||
| 131 | C<FAILED> - You couldn't create or update the alarm model. Check your | ||
| 132 | alarm model information and try again. | ||
| 133 | |||
| 134 | =back | ||
| 135 | |||
| 136 | |||
| 137 | Valid values are: C<"ACTIVE">, C<"ACTIVATING">, C<"INACTIVE">, C<"FAILED"> | ||
| 138 | =head2 StatusMessage => Str | ||
| 139 | |||
| 140 | Contains information about the status of the alarm model. | ||
| 141 | |||
| 142 | |||
| 143 | =head2 _request_id => Str | ||
| 144 | |||
| 145 | |||
| 146 | =cut | ||
| 147 |