blib/lib/Paws/CodeStarNotifications.pm untested

filter: Statementstmt 0.0% 0 / 112 Branchbran 0.0% 0 / 12 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 22 Podpod 0.0% 0 / 21 totaltotal 0.0% 0 / 167 CC 7 SCAR 16.5
CC
7
Cov
0%
ListAllEventTypes
12.0
ListAllNotificationRules
12.0
ListAllTargets
12.0
CRAP 5.2
1 package Paws::CodeStarNotifications;
2 use Moose;
3 sub service { 'codestar-notifications' }
4 sub signing_name { 'codestar-notifications' }
5 sub version { '2019-10-15' }
6 sub flattened_arrays { 0 }
7 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
8 has retry => (is => 'ro', isa => 'HashRef', default => sub {
9 { base => 'rand', type => 'exponential', growth_factor => 2 }
10 });
11 has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
12 ] });
13  
14 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::RestJsonCaller';
15  
16
17 sub CreateNotificationRule {
18 my $self = shift;
19 my $call_object = $self->new_with_coercions('Paws::CodeStarNotifications::CreateNotificationRule', @_);
20 return $self->caller->do_call($self, $call_object);
21 }
22 sub DeleteNotificationRule {
23 my $self = shift;
24 my $call_object = $self->new_with_coercions('Paws::CodeStarNotifications::DeleteNotificationRule', @_);
25 return $self->caller->do_call($self, $call_object);
26 }
27 sub DeleteTarget {
28 my $self = shift;
29 my $call_object = $self->new_with_coercions('Paws::CodeStarNotifications::DeleteTarget', @_);
30 return $self->caller->do_call($self, $call_object);
31 }
32 sub DescribeNotificationRule {
33 my $self = shift;
34 my $call_object = $self->new_with_coercions('Paws::CodeStarNotifications::DescribeNotificationRule', @_);
35 return $self->caller->do_call($self, $call_object);
36 }
37 sub ListEventTypes {
38 my $self = shift;
39 my $call_object = $self->new_with_coercions('Paws::CodeStarNotifications::ListEventTypes', @_);
40 return $self->caller->do_call($self, $call_object);
41 }
42 sub ListNotificationRules {
43 my $self = shift;
44 my $call_object = $self->new_with_coercions('Paws::CodeStarNotifications::ListNotificationRules', @_);
45 return $self->caller->do_call($self, $call_object);
46 }
47 sub ListTagsForResource {
48 my $self = shift;
49 my $call_object = $self->new_with_coercions('Paws::CodeStarNotifications::ListTagsForResource', @_);
50 return $self->caller->do_call($self, $call_object);
51 }
52 sub ListTargets {
53 my $self = shift;
54 my $call_object = $self->new_with_coercions('Paws::CodeStarNotifications::ListTargets', @_);
55 return $self->caller->do_call($self, $call_object);
56 }
57 sub Subscribe {
58 my $self = shift;
59 my $call_object = $self->new_with_coercions('Paws::CodeStarNotifications::Subscribe', @_);
60 return $self->caller->do_call($self, $call_object);
61 }
62 sub TagResource {
63 my $self = shift;
64 my $call_object = $self->new_with_coercions('Paws::CodeStarNotifications::TagResource', @_);
65 return $self->caller->do_call($self, $call_object);
66 }
67 sub Unsubscribe {
68 my $self = shift;
69 my $call_object = $self->new_with_coercions('Paws::CodeStarNotifications::Unsubscribe', @_);
70 return $self->caller->do_call($self, $call_object);
71 }
72 sub UntagResource {
73 my $self = shift;
74 my $call_object = $self->new_with_coercions('Paws::CodeStarNotifications::UntagResource', @_);
75 return $self->caller->do_call($self, $call_object);
76 }
77 sub UpdateNotificationRule {
78 my $self = shift;
79 my $call_object = $self->new_with_coercions('Paws::CodeStarNotifications::UpdateNotificationRule', @_);
80 return $self->caller->do_call($self, $call_object);
81 }
82
83 sub ListAllEventTypes {
84 my $self = shift;
85  
86 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
87 my $result = $self->ListEventTypes(@_);
88 my $next_result = $result;
89  
90 if (not defined $callback) {
91 while ($next_result->NextToken) {
92 $next_result = $self->ListEventTypes(@_, NextToken => $next_result->NextToken);
93 push @{ $result->EventTypes }, @{ $next_result->EventTypes };
94 }
95 return $result;
96 } else {
97 while ($result->NextToken) {
98 $callback->($_ => 'EventTypes') foreach (@{ $result->EventTypes });
99 $result = $self->ListEventTypes(@_, NextToken => $result->NextToken);
100 }
101 $callback->($_ => 'EventTypes') foreach (@{ $result->EventTypes });
102 }
103  
104 return undef
105 }
106 sub ListAllNotificationRules {
107 my $self = shift;
108  
109 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
110 my $result = $self->ListNotificationRules(@_);
111 my $next_result = $result;
112  
113 if (not defined $callback) {
114 while ($next_result->NextToken) {
115 $next_result = $self->ListNotificationRules(@_, NextToken => $next_result->NextToken);
116 push @{ $result->NotificationRules }, @{ $next_result->NotificationRules };
117 }
118 return $result;
119 } else {
120 while ($result->NextToken) {
121 $callback->($_ => 'NotificationRules') foreach (@{ $result->NotificationRules });
122 $result = $self->ListNotificationRules(@_, NextToken => $result->NextToken);
123 }
124 $callback->($_ => 'NotificationRules') foreach (@{ $result->NotificationRules });
125 }
126  
127 return undef
128 }
129 sub ListAllTargets {
130 my $self = shift;
131  
132 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
133 my $result = $self->ListTargets(@_);
134 my $next_result = $result;
135  
136 if (not defined $callback) {
137 while ($next_result->NextToken) {
138 $next_result = $self->ListTargets(@_, NextToken => $next_result->NextToken);
139 push @{ $result->Targets }, @{ $next_result->Targets };
140 }
141 return $result;
142 } else {
143 while ($result->NextToken) {
144 $callback->($_ => 'Targets') foreach (@{ $result->Targets });
145 $result = $self->ListTargets(@_, NextToken => $result->NextToken);
146 }
147 $callback->($_ => 'Targets') foreach (@{ $result->Targets });
148 }
149  
150 return undef
151 }
152  
153  
154 sub operations { qw/CreateNotificationRule DeleteNotificationRule DeleteTarget DescribeNotificationRule ListEventTypes ListNotificationRules ListTagsForResource ListTargets Subscribe TagResource Unsubscribe UntagResource UpdateNotificationRule / }
155  
156 1;
157  
158 ### main pod documentation begin ###
159  
160 =head1 NAME
161  
162 Paws::CodeStarNotifications - Perl Interface to AWS AWS CodeStar Notifications
163  
164 =head1 SYNOPSIS
165  
166 use Paws;
167  
168 my $obj = Paws->service('CodeStarNotifications');
169 my $res = $obj->Method(
170 Arg1 => $val1,
171 Arg2 => [ 'V1', 'V2' ],
172 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
173 # of the arguments type
174 Arg3 => { Att1 => 'Val1' },
175 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
176 # the constructor of the arguments type
177 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
178 );
179  
180 =head1 DESCRIPTION
181  
182 This AWS CodeStar Notifications API Reference provides descriptions and
183 usage examples of the operations and data types for the AWS CodeStar
184 Notifications API. You can use the AWS CodeStar Notifications API to
185 work with the following objects:
186  
187 Notification rules, by calling the following:
188  
189 =over
190  
191 =item *
192  
193 CreateNotificationRule, which creates a notification rule for a
194 resource in your account.
195  
196 =item *
197  
198 DeleteNotificationRule, which deletes a notification rule.
199  
200 =item *
201  
202 DescribeNotificationRule, which provides information about a
203 notification rule.
204  
205 =item *
206  
207 ListNotificationRules, which lists the notification rules associated
208 with your account.
209  
210 =item *
211  
212 UpdateNotificationRule, which changes the name, events, or targets
213 associated with a notification rule.
214  
215 =item *
216  
217 Subscribe, which subscribes a target to a notification rule.
218  
219 =item *
220  
221 Unsubscribe, which removes a target from a notification rule.
222  
223 =back
224  
225 Targets, by calling the following:
226  
227 =over
228  
229 =item *
230  
231 DeleteTarget, which removes a notification rule target (SNS topic) from
232 a notification rule.
233  
234 =item *
235  
236 ListTargets, which lists the targets associated with a notification
237 rule.
238  
239 =back
240  
241 Events, by calling the following:
242  
243 =over
244  
245 =item *
246  
247 ListEventTypes, which lists the event types you can include in a
248 notification rule.
249  
250 =back
251  
252 Tags, by calling the following:
253  
254 =over
255  
256 =item *
257  
258 ListTagsForResource, which lists the tags already associated with a
259 notification rule in your account.
260  
261 =item *
262  
263 TagResource, which associates a tag you provide with a notification
264 rule in your account.
265  
266 =item *
267  
268 UntagResource, which removes a tag from a notification rule in your
269 account.
270  
271 =back
272  
273 For information about how to use AWS CodeStar Notifications, see link
274 in the CodeStarNotifications User Guide.
275  
276 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15>
277  
278  
279 =head1 METHODS
280  
281 =head2 CreateNotificationRule
282  
283 =over
284  
285 =item DetailType => Str
286  
287 =item EventTypeIds => ArrayRef[Str|Undef]
288  
289 =item Name => Str
290  
291 =item Resource => Str
292  
293 =item Targets => ArrayRef[L<Paws::CodeStarNotifications::Target>]
294  
295 =item [ClientRequestToken => Str]
296  
297 =item [Status => Str]
298  
299 =item [Tags => L<Paws::CodeStarNotifications::Tags>]
300  
301  
302 =back
303  
304 Each argument is described in detail in: L<Paws::CodeStarNotifications::CreateNotificationRule>
305  
306 Returns: a L<Paws::CodeStarNotifications::CreateNotificationRuleResult> instance
307  
308 Creates a notification rule for a resource. The rule specifies the
309 events you want notifications about and the targets (such as SNS
310 topics) where you want to receive them.
311  
312  
313 =head2 DeleteNotificationRule
314  
315 =over
316  
317 =item Arn => Str
318  
319  
320 =back
321  
322 Each argument is described in detail in: L<Paws::CodeStarNotifications::DeleteNotificationRule>
323  
324 Returns: a L<Paws::CodeStarNotifications::DeleteNotificationRuleResult> instance
325  
326 Deletes a notification rule for a resource.
327  
328  
329 =head2 DeleteTarget
330  
331 =over
332  
333 =item TargetAddress => Str
334  
335 =item [ForceUnsubscribeAll => Bool]
336  
337  
338 =back
339  
340 Each argument is described in detail in: L<Paws::CodeStarNotifications::DeleteTarget>
341  
342 Returns: a L<Paws::CodeStarNotifications::DeleteTargetResult> instance
343  
344 Deletes a specified target for notifications.
345  
346  
347 =head2 DescribeNotificationRule
348  
349 =over
350  
351 =item Arn => Str
352  
353  
354 =back
355  
356 Each argument is described in detail in: L<Paws::CodeStarNotifications::DescribeNotificationRule>
357  
358 Returns: a L<Paws::CodeStarNotifications::DescribeNotificationRuleResult> instance
359  
360 Returns information about a specified notification rule.
361  
362  
363 =head2 ListEventTypes
364  
365 =over
366  
367 =item [Filters => ArrayRef[L<Paws::CodeStarNotifications::ListEventTypesFilter>]]
368  
369 =item [MaxResults => Int]
370  
371 =item [NextToken => Str]
372  
373  
374 =back
375  
376 Each argument is described in detail in: L<Paws::CodeStarNotifications::ListEventTypes>
377  
378 Returns: a L<Paws::CodeStarNotifications::ListEventTypesResult> instance
379  
380 Returns information about the event types available for configuring
381 notifications.
382  
383  
384 =head2 ListNotificationRules
385  
386 =over
387  
388 =item [Filters => ArrayRef[L<Paws::CodeStarNotifications::ListNotificationRulesFilter>]]
389  
390 =item [MaxResults => Int]
391  
392 =item [NextToken => Str]
393  
394  
395 =back
396  
397 Each argument is described in detail in: L<Paws::CodeStarNotifications::ListNotificationRules>
398  
399 Returns: a L<Paws::CodeStarNotifications::ListNotificationRulesResult> instance
400  
401 Returns a list of the notification rules for an AWS account.
402  
403  
404 =head2 ListTagsForResource
405  
406 =over
407  
408 =item Arn => Str
409  
410  
411 =back
412  
413 Each argument is described in detail in: L<Paws::CodeStarNotifications::ListTagsForResource>
414  
415 Returns: a L<Paws::CodeStarNotifications::ListTagsForResourceResult> instance
416  
417 Returns a list of the tags associated with a notification rule.
418  
419  
420 =head2 ListTargets
421  
422 =over
423  
424 =item [Filters => ArrayRef[L<Paws::CodeStarNotifications::ListTargetsFilter>]]
425  
426 =item [MaxResults => Int]
427  
428 =item [NextToken => Str]
429  
430  
431 =back
432  
433 Each argument is described in detail in: L<Paws::CodeStarNotifications::ListTargets>
434  
435 Returns: a L<Paws::CodeStarNotifications::ListTargetsResult> instance
436  
437 Returns a list of the notification rule targets for an AWS account.
438  
439  
440 =head2 Subscribe
441  
442 =over
443  
444 =item Arn => Str
445  
446 =item Target => L<Paws::CodeStarNotifications::Target>
447  
448 =item [ClientRequestToken => Str]
449  
450  
451 =back
452  
453 Each argument is described in detail in: L<Paws::CodeStarNotifications::Subscribe>
454  
455 Returns: a L<Paws::CodeStarNotifications::SubscribeResult> instance
456  
457 Creates an association between a notification rule and an SNS topic so
458 that the associated target can receive notifications when the events
459 described in the rule are triggered.
460  
461  
462 =head2 TagResource
463  
464 =over
465  
466 =item Arn => Str
467  
468 =item Tags => L<Paws::CodeStarNotifications::Tags>
469  
470  
471 =back
472  
473 Each argument is described in detail in: L<Paws::CodeStarNotifications::TagResource>
474  
475 Returns: a L<Paws::CodeStarNotifications::TagResourceResult> instance
476  
477 Associates a set of provided tags with a notification rule.
478  
479  
480 =head2 Unsubscribe
481  
482 =over
483  
484 =item Arn => Str
485  
486 =item TargetAddress => Str
487  
488  
489 =back
490  
491 Each argument is described in detail in: L<Paws::CodeStarNotifications::Unsubscribe>
492  
493 Returns: a L<Paws::CodeStarNotifications::UnsubscribeResult> instance
494  
495 Removes an association between a notification rule and an Amazon SNS
496 topic so that subscribers to that topic stop receiving notifications
497 when the events described in the rule are triggered.
498  
499  
500 =head2 UntagResource
501  
502 =over
503  
504 =item Arn => Str
505  
506 =item TagKeys => ArrayRef[Str|Undef]
507  
508  
509 =back
510  
511 Each argument is described in detail in: L<Paws::CodeStarNotifications::UntagResource>
512  
513 Returns: a L<Paws::CodeStarNotifications::UntagResourceResult> instance
514  
515 Removes the association between one or more provided tags and a
516 notification rule.
517  
518  
519 =head2 UpdateNotificationRule
520  
521 =over
522  
523 =item Arn => Str
524  
525 =item [DetailType => Str]
526  
527 =item [EventTypeIds => ArrayRef[Str|Undef]]
528  
529 =item [Name => Str]
530  
531 =item [Status => Str]
532  
533 =item [Targets => ArrayRef[L<Paws::CodeStarNotifications::Target>]]
534  
535  
536 =back
537  
538 Each argument is described in detail in: L<Paws::CodeStarNotifications::UpdateNotificationRule>
539  
540 Returns: a L<Paws::CodeStarNotifications::UpdateNotificationRuleResult> instance
541  
542 Updates a notification rule for a resource. You can change the events
543 that trigger the notification rule, the status of the rule, and the
544 targets that receive the notifications.
545  
546 To add or remove tags for a notification rule, you must use TagResource
547 and UntagResource.
548  
549  
550  
551  
552 =head1 PAGINATORS
553  
554 Paginator methods are helpers that repetively call methods that return partial results
555  
556 =head2 ListAllEventTypes(sub { },[Filters => ArrayRef[L<Paws::CodeStarNotifications::ListEventTypesFilter>], MaxResults => Int, NextToken => Str])
557  
558 =head2 ListAllEventTypes([Filters => ArrayRef[L<Paws::CodeStarNotifications::ListEventTypesFilter>], MaxResults => Int, NextToken => Str])
559  
560  
561 If passed a sub as first parameter, it will call the sub for each element found in :
562  
563 - EventTypes, passing the object as the first parameter, and the string 'EventTypes' as the second parameter
564  
565 If not, it will return a a L<Paws::CodeStarNotifications::ListEventTypesResult> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
566  
567  
568 =head2 ListAllNotificationRules(sub { },[Filters => ArrayRef[L<Paws::CodeStarNotifications::ListNotificationRulesFilter>], MaxResults => Int, NextToken => Str])
569  
570 =head2 ListAllNotificationRules([Filters => ArrayRef[L<Paws::CodeStarNotifications::ListNotificationRulesFilter>], MaxResults => Int, NextToken => Str])
571  
572  
573 If passed a sub as first parameter, it will call the sub for each element found in :
574  
575 - NotificationRules, passing the object as the first parameter, and the string 'NotificationRules' as the second parameter
576  
577 If not, it will return a a L<Paws::CodeStarNotifications::ListNotificationRulesResult> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
578  
579  
580 =head2 ListAllTargets(sub { },[Filters => ArrayRef[L<Paws::CodeStarNotifications::ListTargetsFilter>], MaxResults => Int, NextToken => Str])
581  
582 =head2 ListAllTargets([Filters => ArrayRef[L<Paws::CodeStarNotifications::ListTargetsFilter>], MaxResults => Int, NextToken => Str])
583  
584  
585 If passed a sub as first parameter, it will call the sub for each element found in :
586  
587 - Targets, passing the object as the first parameter, and the string 'Targets' as the second parameter
588  
589 If not, it will return a a L<Paws::CodeStarNotifications::ListTargetsResult> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
590  
591  
592  
593  
594  
595 =head1 SEE ALSO
596  
597 This service class forms part of L<Paws>
598  
599 =head1 BUGS and CONTRIBUTIONS
600  
601 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
602  
603 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
604  
605 =cut
606