blib/lib/Paws/IoTEvents/CreateAlarmModel.pm untested

filter: Statementstmt 0.0% 0 / 30 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 32 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::IoTEvents::CreateAlarmModel;
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 AlarmModelDescription => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'alarmModelDescription');
7 has AlarmModelName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'alarmModelName', required => 1);
8 has AlarmNotification => (is => 'ro', isa => 'Paws::IoTEvents::AlarmNotification', traits => ['NameInRequest'], request_name => 'alarmNotification');
9 has AlarmRule => (is => 'ro', isa => 'Paws::IoTEvents::AlarmRule', traits => ['NameInRequest'], request_name => 'alarmRule', required => 1);
10 has Key => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'key');
11 has RoleArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'roleArn', required => 1);
12 has Severity => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'severity');
13 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::IoTEvents::Tag]', traits => ['NameInRequest'], request_name => 'tags');
14  
15 use MooseX::ClassAttribute;
16  
17 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateAlarmModel');
18 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/alarm-models');
19 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
20 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTEvents::CreateAlarmModelResponse');
21 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::IoTEvents::CreateAlarmModel - Arguments for method CreateAlarmModel on L<Paws::IoTEvents>
28  
29 =head1 DESCRIPTION
30  
31 This class represents the parameters used for calling the method CreateAlarmModel on the
32 L<AWS IoT Events|Paws::IoTEvents> service. Use the attributes of this class
33 as arguments to method CreateAlarmModel.
34  
35 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateAlarmModel.
36  
37 =head1 SYNOPSIS
38  
39 my $iotevents = Paws->service('IoTEvents');
40 my $CreateAlarmModelResponse = $iotevents->CreateAlarmModel(
41 AlarmModelName => 'MyAlarmModelName',
42 AlarmRule => {
43 SimpleRule => {
44 ComparisonOperator => 'GREATER'
45 , # values: GREATER, GREATER_OR_EQUAL, LESS, LESS_OR_EQUAL, EQUAL, NOT_EQUAL
46 InputProperty => 'MyInputProperty', # min: 1, max: 512
47 Threshold => 'MyThreshold', # min: 1, max: 512
48  
49 }, # OPTIONAL
50 },
51 RoleArn => 'MyAmazonResourceName',
52 AlarmCapabilities => {
53 AcknowledgeFlow => {
54 Enabled => 1,
55  
56 }, # OPTIONAL
57 InitializationConfiguration => {
58 DisabledOnInitialization => 1,
59  
60 }, # OPTIONAL
61 }, # OPTIONAL
62 AlarmEventActions => {
63 AlarmActions => [
64 {
65 DynamoDB => {
66 HashKeyField => 'MyDynamoKeyField',
67 HashKeyValue => 'MyDynamoKeyValue',
68 TableName => 'MyDynamoTableName',
69 HashKeyType => 'MyDynamoKeyType', # OPTIONAL
70 Operation => 'MyDynamoOperation', # OPTIONAL
71 Payload => {
72 ContentExpression => 'MyContentExpression', # min: 1
73 Type => 'STRING', # values: STRING, JSON
74  
75 }, # OPTIONAL
76 PayloadField => 'MyDynamoKeyField',
77 RangeKeyField => 'MyDynamoKeyField',
78 RangeKeyType => 'MyDynamoKeyType', # OPTIONAL
79 RangeKeyValue => 'MyDynamoKeyValue',
80 }, # OPTIONAL
81 DynamoDBv2 => {
82 TableName => 'MyDynamoTableName',
83 Payload => {
84 ContentExpression => 'MyContentExpression', # min: 1
85 Type => 'STRING', # values: STRING, JSON
86  
87 }, # OPTIONAL
88 }, # OPTIONAL
89 Firehose => {
90 DeliveryStreamName => 'MyDeliveryStreamName',
91 Payload => {
92 ContentExpression => 'MyContentExpression', # min: 1
93 Type => 'STRING', # values: STRING, JSON
94  
95 }, # OPTIONAL
96 Separator => 'MyFirehoseSeparator', # OPTIONAL
97 }, # OPTIONAL
98 IotEvents => {
99 InputName => 'MyInputName', # min: 1, max: 128
100 Payload => {
101 ContentExpression => 'MyContentExpression', # min: 1
102 Type => 'STRING', # values: STRING, JSON
103  
104 }, # OPTIONAL
105 }, # OPTIONAL
106 IotSiteWise => {
107 AssetId => 'MyAssetId', # OPTIONAL
108 EntryId => 'MyAssetPropertyEntryId', # OPTIONAL
109 PropertyAlias => 'MyAssetPropertyAlias', # OPTIONAL
110 PropertyId => 'MyAssetPropertyId', # OPTIONAL
111 PropertyValue => {
112 Quality => 'MyAssetPropertyQuality', # OPTIONAL
113 Timestamp => {
114 TimeInSeconds => 'MyAssetPropertyTimeInSeconds',
115 OffsetInNanos => 'MyAssetPropertyOffsetInNanos', # OPTIONAL
116 }, # OPTIONAL
117 Value => {
118 BooleanValue => 'MyAssetPropertyBooleanValue', # OPTIONAL
119 DoubleValue => 'MyAssetPropertyDoubleValue', # OPTIONAL
120 IntegerValue => 'MyAssetPropertyIntegerValue', # OPTIONAL
121 StringValue => 'MyAssetPropertyStringValue', # OPTIONAL
122 }, # OPTIONAL
123 }, # OPTIONAL
124 }, # OPTIONAL
125 IotTopicPublish => {
126 MqttTopic => 'MyMQTTTopic', # min: 1, max: 128
127 Payload => {
128 ContentExpression => 'MyContentExpression', # min: 1
129 Type => 'STRING', # values: STRING, JSON
130  
131 }, # OPTIONAL
132 }, # OPTIONAL
133 Lambda => {
134 FunctionArn => 'MyAmazonResourceName', # min: 1, max: 2048
135 Payload => {
136 ContentExpression => 'MyContentExpression', # min: 1
137 Type => 'STRING', # values: STRING, JSON
138  
139 }, # OPTIONAL
140 }, # OPTIONAL
141 Sns => {
142 TargetArn => 'MyAmazonResourceName', # min: 1, max: 2048
143 Payload => {
144 ContentExpression => 'MyContentExpression', # min: 1
145 Type => 'STRING', # values: STRING, JSON
146  
147 }, # OPTIONAL
148 }, # OPTIONAL
149 Sqs => {
150 QueueUrl => 'MyQueueUrl',
151 Payload => {
152 ContentExpression => 'MyContentExpression', # min: 1
153 Type => 'STRING', # values: STRING, JSON
154  
155 }, # OPTIONAL
156 UseBase64 => 1, # OPTIONAL
157 }, # OPTIONAL
158 },
159 ...
160 ], # OPTIONAL
161 }, # OPTIONAL
162 AlarmModelDescription => 'MyAlarmModelDescription', # OPTIONAL
163 AlarmNotification => {
164 NotificationActions => [
165 {
166 Action => {
167 LambdaAction => {
168 FunctionArn => 'MyAmazonResourceName', # min: 1, max: 2048
169 Payload => {
170 ContentExpression => 'MyContentExpression', # min: 1
171 Type => 'STRING', # values: STRING, JSON
172  
173 }, # OPTIONAL
174 }, # OPTIONAL
175 },
176 EmailConfigurations => [
177 {
178 From => 'MyFromEmail',
179 Recipients => {
180 To => [
181 {
182 SsoIdentity => {
183 IdentityStoreId => 'MyIdentityStoreId',
184 UserId => 'MySSOReferenceId', # OPTIONAL
185 }, # OPTIONAL
186 },
187 ...
188 ], # min: 1; OPTIONAL
189 },
190 Content => {
191 AdditionalMessage =>
192 'MyNotificationAdditionalMessage', # OPTIONAL
193 Subject => 'MyEmailSubject', # OPTIONAL
194 }, # OPTIONAL
195 },
196 ...
197 ], # min: 1; OPTIONAL
198 SmsConfigurations => [
199 {
200 Recipients => [
201 {
202 SsoIdentity => {
203 IdentityStoreId => 'MyIdentityStoreId',
204 UserId => 'MySSOReferenceId', # OPTIONAL
205 }, # OPTIONAL
206 },
207 ...
208 ], # min: 1; OPTIONAL
209 AdditionalMessage =>
210 'MyNotificationAdditionalMessage', # OPTIONAL
211 SenderId => 'MySMSSenderId', # OPTIONAL
212 },
213 ...
214 ], # min: 1; OPTIONAL
215 },
216 ...
217 ], # min: 1; OPTIONAL
218 }, # OPTIONAL
219 Key => 'MyAttributeJsonPath', # OPTIONAL
220 Severity => 1, # OPTIONAL
221 Tags => [
222 {
223 Key => 'MyTagKey', # min: 1, max: 128
224 Value => 'MyTagValue', # max: 256
225  
226 },
227 ...
228 ], # OPTIONAL
229 );
230  
231 # Results:
232 my $AlarmModelArn = $CreateAlarmModelResponse->AlarmModelArn;
233 my $AlarmModelVersion = $CreateAlarmModelResponse->AlarmModelVersion;
234 my $CreationTime = $CreateAlarmModelResponse->CreationTime;
235 my $LastUpdateTime = $CreateAlarmModelResponse->LastUpdateTime;
236 my $Status = $CreateAlarmModelResponse->Status;
237  
238 # Returns a L<Paws::IoTEvents::CreateAlarmModelResponse> object.
239  
240 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
241 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotevents/CreateAlarmModel>
242  
243 =head1 ATTRIBUTES
244  
245  
246 =head2 AlarmCapabilities => L<Paws::IoTEvents::AlarmCapabilities>
247  
248 Contains the configuration information of alarm state changes.
249  
250  
251  
252 =head2 AlarmEventActions => L<Paws::IoTEvents::AlarmEventActions>
253  
254 Contains information about one or more alarm actions.
255  
256  
257  
258 =head2 AlarmModelDescription => Str
259  
260 A description that tells you what the alarm model detects.
261  
262  
263  
264 =head2 B<REQUIRED> AlarmModelName => Str
265  
266 A unique name that helps you identify the alarm model. You can't change
267 this name after you create the alarm model.
268  
269  
270  
271 =head2 AlarmNotification => L<Paws::IoTEvents::AlarmNotification>
272  
273 Contains information about one or more notification actions.
274  
275  
276  
277 =head2 B<REQUIRED> AlarmRule => L<Paws::IoTEvents::AlarmRule>
278  
279 Defines when your alarm is invoked.
280  
281  
282  
283 =head2 Key => Str
284  
285 An input attribute used as a key to create an alarm. AWS IoT Events
286 routes inputs
287 (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html)
288 associated with this key to the alarm.
289  
290  
291  
292 =head2 B<REQUIRED> RoleArn => Str
293  
294 The ARN of the IAM role that allows the alarm to perform actions and
295 access AWS resources. For more information, see Amazon Resource Names
296 (ARNs)
297 (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
298 in the I<AWS General Reference>.
299  
300  
301  
302 =head2 Severity => Int
303  
304 A non-negative integer that reflects the severity level of the alarm.
305  
306  
307  
308 =head2 Tags => ArrayRef[L<Paws::IoTEvents::Tag>]
309  
310 A list of key-value pairs that contain metadata for the alarm model.
311 The tags help you manage the alarm model. For more information, see
312 Tagging your AWS IoT Events resources
313 (https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html)
314 in the I<AWS IoT Events Developer Guide>.
315  
316 You can create up to 50 tags for one alarm model.
317  
318  
319  
320  
321 =head1 SEE ALSO
322  
323 This class forms part of L<Paws>, documenting arguments for method CreateAlarmModel in L<Paws::IoTEvents>
324  
325 =head1 BUGS and CONTRIBUTIONS
326  
327 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
328  
329 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
330  
331 =cut
332