blib/lib/Paws/Health.pm untested

filter: Statementstmt 0.0% 0 / 194 Branchbran 0.0% 0 / 28 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 27 Podpod 0.0% 0 / 26 totaltotal 0.0% 0 / 275 CC 15 SCAR 19.6
CC
15
Cov
0%
DescribeAllAffectedAccountsForOrganization
12.0
DescribeAllAffectedEntities
12.0
DescribeAllAffectedEntitiesForOrganization
12.0
CRAP 7.1
1 package Paws::Health;
2 use Moose;
3 sub service { 'health' }
4 sub signing_name { 'health' }
5 sub version { '2016-08-04' }
6 sub target_prefix { 'AWSHealth_20160804' }
7 sub json_version { "1.1" }
8 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
9 has retry => (is => 'ro', isa => 'HashRef', default => sub {
10 { base => 'rand', type => 'exponential', growth_factor => 2 }
11 });
12 has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
13 ] });
14  
15 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller';
16  
17
18 sub DescribeAffectedAccountsForOrganization {
19 my $self = shift;
20 my $call_object = $self->new_with_coercions('Paws::Health::DescribeAffectedAccountsForOrganization', @_);
21 return $self->caller->do_call($self, $call_object);
22 }
23 sub DescribeAffectedEntities {
24 my $self = shift;
25 my $call_object = $self->new_with_coercions('Paws::Health::DescribeAffectedEntities', @_);
26 return $self->caller->do_call($self, $call_object);
27 }
28 sub DescribeAffectedEntitiesForOrganization {
29 my $self = shift;
30 my $call_object = $self->new_with_coercions('Paws::Health::DescribeAffectedEntitiesForOrganization', @_);
31 return $self->caller->do_call($self, $call_object);
32 }
33 sub DescribeEntityAggregates {
34 my $self = shift;
35 my $call_object = $self->new_with_coercions('Paws::Health::DescribeEntityAggregates', @_);
36 return $self->caller->do_call($self, $call_object);
37 }
38 sub DescribeEventAggregates {
39 my $self = shift;
40 my $call_object = $self->new_with_coercions('Paws::Health::DescribeEventAggregates', @_);
41 return $self->caller->do_call($self, $call_object);
42 }
43 sub DescribeEventDetails {
44 my $self = shift;
45 my $call_object = $self->new_with_coercions('Paws::Health::DescribeEventDetails', @_);
46 return $self->caller->do_call($self, $call_object);
47 }
48 sub DescribeEventDetailsForOrganization {
49 my $self = shift;
50 my $call_object = $self->new_with_coercions('Paws::Health::DescribeEventDetailsForOrganization', @_);
51 return $self->caller->do_call($self, $call_object);
52 }
53 sub DescribeEvents {
54 my $self = shift;
55 my $call_object = $self->new_with_coercions('Paws::Health::DescribeEvents', @_);
56 return $self->caller->do_call($self, $call_object);
57 }
58 sub DescribeEventsForOrganization {
59 my $self = shift;
60 my $call_object = $self->new_with_coercions('Paws::Health::DescribeEventsForOrganization', @_);
61 return $self->caller->do_call($self, $call_object);
62 }
63 sub DescribeEventTypes {
64 my $self = shift;
65 my $call_object = $self->new_with_coercions('Paws::Health::DescribeEventTypes', @_);
66 return $self->caller->do_call($self, $call_object);
67 }
68 sub DescribeHealthServiceStatusForOrganization {
69 my $self = shift;
70 my $call_object = $self->new_with_coercions('Paws::Health::DescribeHealthServiceStatusForOrganization', @_);
71 return $self->caller->do_call($self, $call_object);
72 }
73 sub DisableHealthServiceAccessForOrganization {
74 my $self = shift;
75 my $call_object = $self->new_with_coercions('Paws::Health::DisableHealthServiceAccessForOrganization', @_);
76 return $self->caller->do_call($self, $call_object);
77 }
78 sub EnableHealthServiceAccessForOrganization {
79 my $self = shift;
80 my $call_object = $self->new_with_coercions('Paws::Health::EnableHealthServiceAccessForOrganization', @_);
81 return $self->caller->do_call($self, $call_object);
82 }
83
84 sub DescribeAllAffectedAccountsForOrganization {
85 my $self = shift;
86  
87 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
88 my $result = $self->DescribeAffectedAccountsForOrganization(@_);
89 my $next_result = $result;
90  
91 if (not defined $callback) {
92 while ($next_result->nextToken) {
93 $next_result = $self->DescribeAffectedAccountsForOrganization(@_, nextToken => $next_result->nextToken);
94 push @{ $result->affectedAccounts }, @{ $next_result->affectedAccounts };
95 }
96 return $result;
97 } else {
98 while ($result->nextToken) {
99 $callback->($_ => 'affectedAccounts') foreach (@{ $result->affectedAccounts });
100 $result = $self->DescribeAffectedAccountsForOrganization(@_, nextToken => $result->nextToken);
101 }
102 $callback->($_ => 'affectedAccounts') foreach (@{ $result->affectedAccounts });
103 }
104  
105 return undef
106 }
107 sub DescribeAllAffectedEntities {
108 my $self = shift;
109  
110 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
111 my $result = $self->DescribeAffectedEntities(@_);
112 my $next_result = $result;
113  
114 if (not defined $callback) {
115 while ($next_result->nextToken) {
116 $next_result = $self->DescribeAffectedEntities(@_, nextToken => $next_result->nextToken);
117 push @{ $result->entities }, @{ $next_result->entities };
118 }
119 return $result;
120 } else {
121 while ($result->nextToken) {
122 $callback->($_ => 'entities') foreach (@{ $result->entities });
123 $result = $self->DescribeAffectedEntities(@_, nextToken => $result->nextToken);
124 }
125 $callback->($_ => 'entities') foreach (@{ $result->entities });
126 }
127  
128 return undef
129 }
130 sub DescribeAllAffectedEntitiesForOrganization {
131 my $self = shift;
132  
133 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
134 my $result = $self->DescribeAffectedEntitiesForOrganization(@_);
135 my $next_result = $result;
136  
137 if (not defined $callback) {
138 while ($next_result->nextToken) {
139 $next_result = $self->DescribeAffectedEntitiesForOrganization(@_, nextToken => $next_result->nextToken);
140 push @{ $result->entities }, @{ $next_result->entities };
141 }
142 return $result;
143 } else {
144 while ($result->nextToken) {
145 $callback->($_ => 'entities') foreach (@{ $result->entities });
146 $result = $self->DescribeAffectedEntitiesForOrganization(@_, nextToken => $result->nextToken);
147 }
148 $callback->($_ => 'entities') foreach (@{ $result->entities });
149 }
150  
151 return undef
152 }
153 sub DescribeAllEventAggregates {
154 my $self = shift;
155  
156 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
157 my $result = $self->DescribeEventAggregates(@_);
158 my $next_result = $result;
159  
160 if (not defined $callback) {
161 while ($next_result->nextToken) {
162 $next_result = $self->DescribeEventAggregates(@_, nextToken => $next_result->nextToken);
163 push @{ $result->eventAggregates }, @{ $next_result->eventAggregates };
164 }
165 return $result;
166 } else {
167 while ($result->nextToken) {
168 $callback->($_ => 'eventAggregates') foreach (@{ $result->eventAggregates });
169 $result = $self->DescribeEventAggregates(@_, nextToken => $result->nextToken);
170 }
171 $callback->($_ => 'eventAggregates') foreach (@{ $result->eventAggregates });
172 }
173  
174 return undef
175 }
176 sub DescribeAllEvents {
177 my $self = shift;
178  
179 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
180 my $result = $self->DescribeEvents(@_);
181 my $next_result = $result;
182  
183 if (not defined $callback) {
184 while ($next_result->nextToken) {
185 $next_result = $self->DescribeEvents(@_, nextToken => $next_result->nextToken);
186 push @{ $result->events }, @{ $next_result->events };
187 }
188 return $result;
189 } else {
190 while ($result->nextToken) {
191 $callback->($_ => 'events') foreach (@{ $result->events });
192 $result = $self->DescribeEvents(@_, nextToken => $result->nextToken);
193 }
194 $callback->($_ => 'events') foreach (@{ $result->events });
195 }
196  
197 return undef
198 }
199 sub DescribeAllEventsForOrganization {
200 my $self = shift;
201  
202 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
203 my $result = $self->DescribeEventsForOrganization(@_);
204 my $next_result = $result;
205  
206 if (not defined $callback) {
207 while ($next_result->nextToken) {
208 $next_result = $self->DescribeEventsForOrganization(@_, nextToken => $next_result->nextToken);
209 push @{ $result->events }, @{ $next_result->events };
210 }
211 return $result;
212 } else {
213 while ($result->nextToken) {
214 $callback->($_ => 'events') foreach (@{ $result->events });
215 $result = $self->DescribeEventsForOrganization(@_, nextToken => $result->nextToken);
216 }
217 $callback->($_ => 'events') foreach (@{ $result->events });
218 }
219  
220 return undef
221 }
222 sub DescribeAllEventTypes {
223 my $self = shift;
224  
225 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
226 my $result = $self->DescribeEventTypes(@_);
227 my $next_result = $result;
228  
229 if (not defined $callback) {
230 while ($next_result->nextToken) {
231 $next_result = $self->DescribeEventTypes(@_, nextToken => $next_result->nextToken);
232 push @{ $result->eventTypes }, @{ $next_result->eventTypes };
233 }
234 return $result;
235 } else {
236 while ($result->nextToken) {
237 $callback->($_ => 'eventTypes') foreach (@{ $result->eventTypes });
238 $result = $self->DescribeEventTypes(@_, nextToken => $result->nextToken);
239 }
240 $callback->($_ => 'eventTypes') foreach (@{ $result->eventTypes });
241 }
242  
243 return undef
244 }
245  
246  
247 sub operations { qw/DescribeAffectedAccountsForOrganization DescribeAffectedEntities DescribeAffectedEntitiesForOrganization DescribeEntityAggregates DescribeEventAggregates DescribeEventDetails DescribeEventDetailsForOrganization DescribeEvents DescribeEventsForOrganization DescribeEventTypes DescribeHealthServiceStatusForOrganization DisableHealthServiceAccessForOrganization EnableHealthServiceAccessForOrganization / }
248  
249 1;
250  
251 ### main pod documentation begin ###
252  
253 =head1 NAME
254  
255 Paws::Health - Perl Interface to AWS AWS Health APIs and Notifications
256  
257 =head1 SYNOPSIS
258  
259 use Paws;
260  
261 my $obj = Paws->service('Health');
262 my $res = $obj->Method(
263 Arg1 => $val1,
264 Arg2 => [ 'V1', 'V2' ],
265 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
266 # of the arguments type
267 Arg3 => { Att1 => 'Val1' },
268 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
269 # the constructor of the arguments type
270 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
271 );
272  
273 =head1 DESCRIPTION
274  
275 AWS Health
276  
277 The AWS Health API provides programmatic access to the AWS Health
278 information that appears in the AWS Personal Health Dashboard
279 (https://phd.aws.amazon.com/phd/home#/). You can use the API operations
280 to get information about AWS Health events that affect your AWS
281 services and resources.
282  
283 =over
284  
285 =item *
286  
287 You must have a Business or Enterprise Support plan from AWS Support
288 (http://aws.amazon.com/premiumsupport/) to use the AWS Health API. If
289 you call the AWS Health API from an AWS account that doesn't have a
290 Business or Enterprise Support plan, you receive a
291 C<SubscriptionRequiredException> error.
292  
293 =item *
294  
295 You can use the AWS Health endpoint health.us-east-1.amazonaws.com
296 (HTTPS) to call the AWS Health API operations. AWS Health supports a
297 multi-Region application architecture and has two regional endpoints in
298 an active-passive configuration. You can use the high availability
299 endpoint example to determine which AWS Region is active, so that you
300 can get the latest information from the API. For more information, see
301 Accessing the AWS Health API
302 (https://docs.aws.amazon.com/health/latest/ug/health-api.html) in the
303 I<AWS Health User Guide>.
304  
305 =back
306  
307 For authentication of requests, AWS Health uses the Signature Version 4
308 Signing Process
309 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).
310  
311 If your AWS account is part of AWS Organizations, you can use the AWS
312 Health organizational view feature. This feature provides a centralized
313 view of AWS Health events across all accounts in your organization. You
314 can aggregate AWS Health events in real time to identify accounts in
315 your organization that are affected by an operational event or get
316 notified of security vulnerabilities. Use the organizational view API
317 operations to enable this feature and return event information. For
318 more information, see Aggregating AWS Health events
319 (https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html) in
320 the I<AWS Health User Guide>.
321  
322 When you use the AWS Health API operations to return AWS Health events,
323 see the following recommendations:
324  
325 =over
326  
327 =item *
328  
329 Use the eventScopeCode
330 (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode)
331 parameter to specify whether to return AWS Health events that are
332 public or account-specific.
333  
334 =item *
335  
336 Use pagination to view all events from the response. For example, if
337 you call the C<DescribeEventsForOrganization> operation to get all
338 events in your organization, you might receive several page results.
339 Specify the C<nextToken> in the next request to return more results.
340  
341 =back
342  
343  
344 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04>
345  
346  
347 =head1 METHODS
348  
349 =head2 DescribeAffectedAccountsForOrganization
350  
351 =over
352  
353 =item EventArn => Str
354  
355 =item [MaxResults => Int]
356  
357 =item [NextToken => Str]
358  
359  
360 =back
361  
362 Each argument is described in detail in: L<Paws::Health::DescribeAffectedAccountsForOrganization>
363  
364 Returns: a L<Paws::Health::DescribeAffectedAccountsForOrganizationResponse> instance
365  
366 Returns a list of accounts in the organization from AWS Organizations
367 that are affected by the provided event. For more information about the
368 different types of AWS Health events, see Event
369 (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html).
370  
371 Before you can call this operation, you must first enable AWS Health to
372 work with AWS Organizations. To do this, call the
373 EnableHealthServiceAccessForOrganization
374 (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html)
375 operation from your organization's management account.
376  
377 This API operation uses pagination. Specify the C<nextToken> parameter
378 in the next request to return more results.
379  
380  
381 =head2 DescribeAffectedEntities
382  
383 =over
384  
385 =item Filter => L<Paws::Health::EntityFilter>
386  
387 =item [Locale => Str]
388  
389 =item [MaxResults => Int]
390  
391 =item [NextToken => Str]
392  
393  
394 =back
395  
396 Each argument is described in detail in: L<Paws::Health::DescribeAffectedEntities>
397  
398 Returns: a L<Paws::Health::DescribeAffectedEntitiesResponse> instance
399  
400 Returns a list of entities that have been affected by the specified
401 events, based on the specified filter criteria. Entities can refer to
402 individual customer resources, groups of customer resources, or any
403 other construct, depending on the AWS service. Events that have impact
404 beyond that of the affected entities, or where the extent of impact is
405 unknown, include at least one entity indicating this.
406  
407 At least one event ARN is required. Results are sorted by the
408 C<lastUpdatedTime> of the entity, starting with the most recent.
409  
410 =over
411  
412 =item *
413  
414 This API operation uses pagination. Specify the C<nextToken> parameter
415 in the next request to return more results.
416  
417 =item *
418  
419 This operation supports resource-level permissions. You can use this
420 operation to allow or deny access to specific AWS Health events. For
421 more information, see Resource- and action-based conditions
422 (https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions)
423 in the I<AWS Health User Guide>.
424  
425 =back
426  
427  
428  
429 =head2 DescribeAffectedEntitiesForOrganization
430  
431 =over
432  
433 =item OrganizationEntityFilters => ArrayRef[L<Paws::Health::EventAccountFilter>]
434  
435 =item [Locale => Str]
436  
437 =item [MaxResults => Int]
438  
439 =item [NextToken => Str]
440  
441  
442 =back
443  
444 Each argument is described in detail in: L<Paws::Health::DescribeAffectedEntitiesForOrganization>
445  
446 Returns: a L<Paws::Health::DescribeAffectedEntitiesForOrganizationResponse> instance
447  
448 Returns a list of entities that have been affected by one or more
449 events for one or more accounts in your organization in AWS
450 Organizations, based on the filter criteria. Entities can refer to
451 individual customer resources, groups of customer resources, or any
452 other construct, depending on the AWS service.
453  
454 At least one event Amazon Resource Name (ARN) and account ID are
455 required. Results are sorted by the C<lastUpdatedTime> of the entity,
456 starting with the most recent.
457  
458 Before you can call this operation, you must first enable AWS Health to
459 work with AWS Organizations. To do this, call the
460 EnableHealthServiceAccessForOrganization
461 (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html)
462 operation from your organization's management account.
463  
464 =over
465  
466 =item *
467  
468 This API operation uses pagination. Specify the C<nextToken> parameter
469 in the next request to return more results.
470  
471 =item *
472  
473 This operation doesn't support resource-level permissions. You can't
474 use this operation to allow or deny access to specific AWS Health
475 events. For more information, see Resource- and action-based conditions
476 (https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions)
477 in the I<AWS Health User Guide>.
478  
479 =back
480  
481  
482  
483 =head2 DescribeEntityAggregates
484  
485 =over
486  
487 =item [EventArns => ArrayRef[Str|Undef]]
488  
489  
490 =back
491  
492 Each argument is described in detail in: L<Paws::Health::DescribeEntityAggregates>
493  
494 Returns: a L<Paws::Health::DescribeEntityAggregatesResponse> instance
495  
496 Returns the number of entities that are affected by each of the
497 specified events. If no events are specified, the counts of all
498 affected entities are returned.
499  
500  
501 =head2 DescribeEventAggregates
502  
503 =over
504  
505 =item AggregateField => Str
506  
507 =item [Filter => L<Paws::Health::EventFilter>]
508  
509 =item [MaxResults => Int]
510  
511 =item [NextToken => Str]
512  
513  
514 =back
515  
516 Each argument is described in detail in: L<Paws::Health::DescribeEventAggregates>
517  
518 Returns: a L<Paws::Health::DescribeEventAggregatesResponse> instance
519  
520 Returns the number of events of each event type (issue, scheduled
521 change, and account notification). If no filter is specified, the
522 counts of all events in each category are returned.
523  
524 This API operation uses pagination. Specify the C<nextToken> parameter
525 in the next request to return more results.
526  
527  
528 =head2 DescribeEventDetails
529  
530 =over
531  
532 =item EventArns => ArrayRef[Str|Undef]
533  
534 =item [Locale => Str]
535  
536  
537 =back
538  
539 Each argument is described in detail in: L<Paws::Health::DescribeEventDetails>
540  
541 Returns: a L<Paws::Health::DescribeEventDetailsResponse> instance
542  
543 Returns detailed information about one or more specified events.
544 Information includes standard event data (AWS Region, service, and so
545 on, as returned by DescribeEvents
546 (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html)),
547 a detailed event description, and possible additional metadata that
548 depends upon the nature of the event. Affected entities are not
549 included. To retrieve the entities, use the DescribeAffectedEntities
550 (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html)
551 operation.
552  
553 If a specified event can't be retrieved, an error message is returned
554 for that event.
555  
556 This operation supports resource-level permissions. You can use this
557 operation to allow or deny access to specific AWS Health events. For
558 more information, see Resource- and action-based conditions
559 (https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions)
560 in the I<AWS Health User Guide>.
561  
562  
563 =head2 DescribeEventDetailsForOrganization
564  
565 =over
566  
567 =item OrganizationEventDetailFilters => ArrayRef[L<Paws::Health::EventAccountFilter>]
568  
569 =item [Locale => Str]
570  
571  
572 =back
573  
574 Each argument is described in detail in: L<Paws::Health::DescribeEventDetailsForOrganization>
575  
576 Returns: a L<Paws::Health::DescribeEventDetailsForOrganizationResponse> instance
577  
578 Returns detailed information about one or more specified events for one
579 or more AWS accounts in your organization. This information includes
580 standard event data (such as the AWS Region and service), an event
581 description, and (depending on the event) possible metadata. This
582 operation doesn't return affected entities, such as the resources
583 related to the event. To return affected entities, use the
584 DescribeAffectedEntitiesForOrganization
585 (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html)
586 operation.
587  
588 Before you can call this operation, you must first enable AWS Health to
589 work with AWS Organizations. To do this, call the
590 EnableHealthServiceAccessForOrganization
591 (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html)
592 operation from your organization's management account.
593  
594 When you call the C<DescribeEventDetailsForOrganization> operation,
595 specify the C<organizationEventDetailFilters> object in the request.
596 Depending on the AWS Health event type, note the following differences:
597  
598 =over
599  
600 =item *
601  
602 To return event details for a public event, you must specify a null
603 value for the C<awsAccountId> parameter. If you specify an account ID
604 for a public event, AWS Health returns an error message because public
605 events aren't specific to an account.
606  
607 =item *
608  
609 To return event details for an event that is specific to an account in
610 your organization, you must specify the C<awsAccountId> parameter in
611 the request. If you don't specify an account ID, AWS Health returns an
612 error message because the event is specific to an account in your
613 organization.
614  
615 =back
616  
617 For more information, see Event
618 (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html).
619  
620 This operation doesn't support resource-level permissions. You can't
621 use this operation to allow or deny access to specific AWS Health
622 events. For more information, see Resource- and action-based conditions
623 (https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions)
624 in the I<AWS Health User Guide>.
625  
626  
627 =head2 DescribeEvents
628  
629 =over
630  
631 =item [Filter => L<Paws::Health::EventFilter>]
632  
633 =item [Locale => Str]
634  
635 =item [MaxResults => Int]
636  
637 =item [NextToken => Str]
638  
639  
640 =back
641  
642 Each argument is described in detail in: L<Paws::Health::DescribeEvents>
643  
644 Returns: a L<Paws::Health::DescribeEventsResponse> instance
645  
646 Returns information about events that meet the specified filter
647 criteria. Events are returned in a summary form and do not include the
648 detailed description, any additional metadata that depends on the event
649 type, or any affected resources. To retrieve that information, use the
650 DescribeEventDetails
651 (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html)
652 and DescribeAffectedEntities
653 (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html)
654 operations.
655  
656 If no filter criteria are specified, all events are returned. Results
657 are sorted by C<lastModifiedTime>, starting with the most recent event.
658  
659 =over
660  
661 =item *
662  
663 When you call the C<DescribeEvents> operation and specify an entity for
664 the C<entityValues> parameter, AWS Health might return public events
665 that aren't specific to that resource. For example, if you call
666 C<DescribeEvents> and specify an ID for an Amazon Elastic Compute Cloud
667 (Amazon EC2) instance, AWS Health might return events that aren't
668 specific to that resource or service. To get events that are specific
669 to a service, use the C<services> parameter in the C<filter> object.
670 For more information, see Event
671 (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html).
672  
673 =item *
674  
675 This API operation uses pagination. Specify the C<nextToken> parameter
676 in the next request to return more results.
677  
678 =back
679  
680  
681  
682 =head2 DescribeEventsForOrganization
683  
684 =over
685  
686 =item [Filter => L<Paws::Health::OrganizationEventFilter>]
687  
688 =item [Locale => Str]
689  
690 =item [MaxResults => Int]
691  
692 =item [NextToken => Str]
693  
694  
695 =back
696  
697 Each argument is described in detail in: L<Paws::Health::DescribeEventsForOrganization>
698  
699 Returns: a L<Paws::Health::DescribeEventsForOrganizationResponse> instance
700  
701 Returns information about events across your organization in AWS
702 Organizations. You can use theC<filters> parameter to specify the
703 events that you want to return. Events are returned in a summary form
704 and don't include the affected accounts, detailed description, any
705 additional metadata that depends on the event type, or any affected
706 resources. To retrieve that information, use the following operations:
707  
708 =over
709  
710 =item *
711  
712 DescribeAffectedAccountsForOrganization
713 (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedAccountsForOrganization.html)
714  
715 =item *
716  
717 DescribeEventDetailsForOrganization
718 (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html)
719  
720 =item *
721  
722 DescribeAffectedEntitiesForOrganization
723 (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html)
724  
725 =back
726  
727 If you don't specify a C<filter>, the C<DescribeEventsForOrganizations>
728 returns all events across your organization. Results are sorted by
729 C<lastModifiedTime>, starting with the most recent event.
730  
731 For more information about the different types of AWS Health events,
732 see Event
733 (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html).
734  
735 Before you can call this operation, you must first enable AWS Health to
736 work with AWS Organizations. To do this, call the
737 EnableHealthServiceAccessForOrganization
738 (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html)
739 operation from your organization's management account.
740  
741 This API operation uses pagination. Specify the C<nextToken> parameter
742 in the next request to return more results.
743  
744  
745 =head2 DescribeEventTypes
746  
747 =over
748  
749 =item [Filter => L<Paws::Health::EventTypeFilter>]
750  
751 =item [Locale => Str]
752  
753 =item [MaxResults => Int]
754  
755 =item [NextToken => Str]
756  
757  
758 =back
759  
760 Each argument is described in detail in: L<Paws::Health::DescribeEventTypes>
761  
762 Returns: a L<Paws::Health::DescribeEventTypesResponse> instance
763  
764 Returns the event types that meet the specified filter criteria. You
765 can use this API operation to find information about the AWS Health
766 event, such as the category, AWS service, and event code. The metadata
767 for each event appears in the EventType
768 (https://docs.aws.amazon.com/health/latest/APIReference/API_EventType.html)
769 object.
770  
771 If you don't specify a filter criteria, the API operation returns all
772 event types, in no particular order.
773  
774 This API operation uses pagination. Specify the C<nextToken> parameter
775 in the next request to return more results.
776  
777  
778 =head2 DescribeHealthServiceStatusForOrganization
779  
780 =over
781  
782 =item =>
783  
784  
785 =back
786  
787 Each argument is described in detail in: L<Paws::Health::DescribeHealthServiceStatusForOrganization>
788  
789 Returns: a L<Paws::Health::DescribeHealthServiceStatusForOrganizationResponse> instance
790  
791 This operation provides status information on enabling or disabling AWS
792 Health to work with your organization. To call this operation, you must
793 sign in as an IAM user, assume an IAM role, or sign in as the root user
794 (not recommended) in the organization's management account.
795  
796  
797 =head2 DisableHealthServiceAccessForOrganization
798  
799 =over
800  
801 =item =>
802  
803  
804 =back
805  
806 Each argument is described in detail in: L<Paws::Health::DisableHealthServiceAccessForOrganization>
807  
808 Returns: nothing
809  
810 Disables AWS Health from working with AWS Organizations. To call this
811 operation, you must sign in as an AWS Identity and Access Management
812 (IAM) user, assume an IAM role, or sign in as the root user (not
813 recommended) in the organization's management account. For more
814 information, see Aggregating AWS Health events
815 (https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html) in
816 the I<AWS Health User Guide>.
817  
818 This operation doesn't remove the service-linked role from the
819 management account in your organization. You must use the IAM console,
820 API, or AWS Command Line Interface (AWS CLI) to remove the
821 service-linked role. For more information, see Deleting a
822 Service-Linked Role
823 (https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#delete-service-linked-role)
824 in the I<IAM User Guide>.
825  
826 You can also disable the organizational feature by using the
827 Organizations DisableAWSServiceAccess
828 (https://docs.aws.amazon.com/organizations/latest/APIReference/API_DisableAWSServiceAccess.html)
829 API operation. After you call this operation, AWS Health stops
830 aggregating events for all other AWS accounts in your organization. If
831 you call the AWS Health API operations for organizational view, AWS
832 Health returns an error. AWS Health continues to aggregate health
833 events for your AWS account.
834  
835  
836 =head2 EnableHealthServiceAccessForOrganization
837  
838 =over
839  
840 =item =>
841  
842  
843 =back
844  
845 Each argument is described in detail in: L<Paws::Health::EnableHealthServiceAccessForOrganization>
846  
847 Returns: nothing
848  
849 Enables AWS Health to work with AWS Organizations. You can use the
850 organizational view feature to aggregate events from all AWS accounts
851 in your organization in a centralized location.
852  
853 This operation also creates a service-linked role for the management
854 account in the organization.
855  
856 To call this operation, you must meet the following requirements:
857  
858 =over
859  
860 =item *
861  
862 You must have a Business or Enterprise Support plan from AWS Support
863 (http://aws.amazon.com/premiumsupport/) to use the AWS Health API. If
864 you call the AWS Health API from an AWS account that doesn't have a
865 Business or Enterprise Support plan, you receive a
866 C<SubscriptionRequiredException> error.
867  
868 =item *
869  
870 You must have permission to call this operation from the organization's
871 management account. For example IAM policies, see AWS Health
872 identity-based policy examples
873 (https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html).
874  
875 =back
876  
877 If you don't have the required support plan, you can instead use the
878 AWS Health console to enable the organizational view feature. For more
879 information, see Aggregating AWS Health events
880 (https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html) in
881 the I<AWS Health User Guide>.
882  
883  
884  
885  
886 =head1 PAGINATORS
887  
888 Paginator methods are helpers that repetively call methods that return partial results
889  
890 =head2 DescribeAllAffectedAccountsForOrganization(sub { },EventArn => Str, [MaxResults => Int, NextToken => Str])
891  
892 =head2 DescribeAllAffectedAccountsForOrganization(EventArn => Str, [MaxResults => Int, NextToken => Str])
893  
894  
895 If passed a sub as first parameter, it will call the sub for each element found in :
896  
897 - affectedAccounts, passing the object as the first parameter, and the string 'affectedAccounts' as the second parameter
898  
899 If not, it will return a a L<Paws::Health::DescribeAffectedAccountsForOrganizationResponse> 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.
900  
901  
902 =head2 DescribeAllAffectedEntities(sub { },Filter => L<Paws::Health::EntityFilter>, [Locale => Str, MaxResults => Int, NextToken => Str])
903  
904 =head2 DescribeAllAffectedEntities(Filter => L<Paws::Health::EntityFilter>, [Locale => Str, MaxResults => Int, NextToken => Str])
905  
906  
907 If passed a sub as first parameter, it will call the sub for each element found in :
908  
909 - entities, passing the object as the first parameter, and the string 'entities' as the second parameter
910  
911 If not, it will return a a L<Paws::Health::DescribeAffectedEntitiesResponse> 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.
912  
913  
914 =head2 DescribeAllAffectedEntitiesForOrganization(sub { },OrganizationEntityFilters => ArrayRef[L<Paws::Health::EventAccountFilter>], [Locale => Str, MaxResults => Int, NextToken => Str])
915  
916 =head2 DescribeAllAffectedEntitiesForOrganization(OrganizationEntityFilters => ArrayRef[L<Paws::Health::EventAccountFilter>], [Locale => Str, MaxResults => Int, NextToken => Str])
917  
918  
919 If passed a sub as first parameter, it will call the sub for each element found in :
920  
921 - entities, passing the object as the first parameter, and the string 'entities' as the second parameter
922  
923 If not, it will return a a L<Paws::Health::DescribeAffectedEntitiesForOrganizationResponse> 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.
924  
925  
926 =head2 DescribeAllEventAggregates(sub { },AggregateField => Str, [Filter => L<Paws::Health::EventFilter>, MaxResults => Int, NextToken => Str])
927  
928 =head2 DescribeAllEventAggregates(AggregateField => Str, [Filter => L<Paws::Health::EventFilter>, MaxResults => Int, NextToken => Str])
929  
930  
931 If passed a sub as first parameter, it will call the sub for each element found in :
932  
933 - eventAggregates, passing the object as the first parameter, and the string 'eventAggregates' as the second parameter
934  
935 If not, it will return a a L<Paws::Health::DescribeEventAggregatesResponse> 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.
936  
937  
938 =head2 DescribeAllEvents(sub { },[Filter => L<Paws::Health::EventFilter>, Locale => Str, MaxResults => Int, NextToken => Str])
939  
940 =head2 DescribeAllEvents([Filter => L<Paws::Health::EventFilter>, Locale => Str, MaxResults => Int, NextToken => Str])
941  
942  
943 If passed a sub as first parameter, it will call the sub for each element found in :
944  
945 - events, passing the object as the first parameter, and the string 'events' as the second parameter
946  
947 If not, it will return a a L<Paws::Health::DescribeEventsResponse> 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.
948  
949  
950 =head2 DescribeAllEventsForOrganization(sub { },[Filter => L<Paws::Health::OrganizationEventFilter>, Locale => Str, MaxResults => Int, NextToken => Str])
951  
952 =head2 DescribeAllEventsForOrganization([Filter => L<Paws::Health::OrganizationEventFilter>, Locale => Str, MaxResults => Int, NextToken => Str])
953  
954  
955 If passed a sub as first parameter, it will call the sub for each element found in :
956  
957 - events, passing the object as the first parameter, and the string 'events' as the second parameter
958  
959 If not, it will return a a L<Paws::Health::DescribeEventsForOrganizationResponse> 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.
960  
961  
962 =head2 DescribeAllEventTypes(sub { },[Filter => L<Paws::Health::EventTypeFilter>, Locale => Str, MaxResults => Int, NextToken => Str])
963  
964 =head2 DescribeAllEventTypes([Filter => L<Paws::Health::EventTypeFilter>, Locale => Str, MaxResults => Int, NextToken => Str])
965  
966  
967 If passed a sub as first parameter, it will call the sub for each element found in :
968  
969 - eventTypes, passing the object as the first parameter, and the string 'eventTypes' as the second parameter
970  
971 If not, it will return a a L<Paws::Health::DescribeEventTypesResponse> 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.
972  
973  
974  
975  
976  
977 =head1 SEE ALSO
978  
979 This service class forms part of L<Paws>
980  
981 =head1 BUGS and CONTRIBUTIONS
982  
983 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
984  
985 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
986  
987 =cut
988