« blib/lib/Paws/IoTEvents/AlarmModelSummary.pm
↑ Summary
blib/lib/Paws/IoTEvents/AlarmNotification.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoTEvents::AlarmModelVersionSummary; | ||
| 3 | use Moose; | ||
| 4 | has AlarmModelArn => (is => 'ro', isa => 'Str', request_name => 'alarmModelArn', traits => ['NameInRequest']); | ||
| 5 | has AlarmModelName => (is => 'ro', isa => 'Str', request_name => 'alarmModelName', traits => ['NameInRequest']); | ||
| 6 | has AlarmModelVersion => (is => 'ro', isa => 'Str', request_name => 'alarmModelVersion', traits => ['NameInRequest']); | ||
| 7 | has CreationTime => (is => 'ro', isa => 'Str', request_name => 'creationTime', traits => ['NameInRequest']); | ||
| 8 | has LastUpdateTime => (is => 'ro', isa => 'Str', request_name => 'lastUpdateTime', traits => ['NameInRequest']); | ||
| 9 | has RoleArn => (is => 'ro', isa => 'Str', request_name => 'roleArn', traits => ['NameInRequest']); | ||
| 10 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 11 | has StatusMessage => (is => 'ro', isa => 'Str', request_name => 'statusMessage', traits => ['NameInRequest']); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::IoTEvents::AlarmModelVersionSummary | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::IoTEvents::AlarmModelVersionSummary object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { AlarmModelArn => $value, ..., StatusMessage => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::IoTEvents::AlarmModelVersionSummary object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->AlarmModelArn | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Contains a summary of an alarm model version. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 AlarmModelArn => Str | ||
| 49 | |||
| 50 | The ARN of the alarm model. For more information, see Amazon Resource | ||
| 51 | Names (ARNs) | ||
| 52 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) | ||
| 53 | in the I<AWS General Reference>. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 AlarmModelName => Str | ||
| 57 | |||
| 58 | The name of the alarm model. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 AlarmModelVersion => Str | ||
| 62 | |||
| 63 | The version of the alarm model. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 CreationTime => Str | ||
| 67 | |||
| 68 | The time the alarm model was created, in the Unix epoch format. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 LastUpdateTime => Str | ||
| 72 | |||
| 73 | The time the alarm model was last updated, in the Unix epoch format. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 RoleArn => Str | ||
| 77 | |||
| 78 | The ARN of the IAM role that allows the alarm to perform actions and | ||
| 79 | access AWS resources. For more information, see Amazon Resource Names | ||
| 80 | (ARNs) | ||
| 81 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) | ||
| 82 | in the I<AWS General Reference>. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 Status => Str | ||
| 86 | |||
| 87 | The status of the alarm model. The status can be one of the following | ||
| 88 | values: | ||
| 89 | |||
| 90 | =over | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | C<ACTIVE> - The alarm model is active and it's ready to evaluate data. | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | C<ACTIVATING> - AWS IoT Events is activating your alarm model. | ||
| 99 | Activating an alarm model can take up to a few minutes. | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | C<INACTIVE> - The alarm model is inactive, so it isn't ready to | ||
| 104 | evaluate data. Check your alarm model information and update the alarm | ||
| 105 | model. | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | C<FAILED> - You couldn't create or update the alarm model. Check your | ||
| 110 | alarm model information and try again. | ||
| 111 | |||
| 112 | =back | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 StatusMessage => Str | ||
| 117 | |||
| 118 | Contains information about the status of the alarm model version. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head1 SEE ALSO | ||
| 123 | |||
| 124 | This class forms part of L<Paws>, describing an object used in L<Paws::IoTEvents> | ||
| 125 | |||
| 126 | =head1 BUGS and CONTRIBUTIONS | ||
| 127 | |||
| 128 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 129 | |||
| 130 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 131 | |||
| 132 | =cut | ||
| 133 |