health.d.ts
51.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Health extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Health.Types.ClientConfiguration)
config: Config & Health.Types.ClientConfiguration;
/**
* Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event. For more information about the different types of AWS Health events, see Event. Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
*/
describeAffectedAccountsForOrganization(params: Health.Types.DescribeAffectedAccountsForOrganizationRequest, callback?: (err: AWSError, data: Health.Types.DescribeAffectedAccountsForOrganizationResponse) => void): Request<Health.Types.DescribeAffectedAccountsForOrganizationResponse, AWSError>;
/**
* Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event. For more information about the different types of AWS Health events, see Event. Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
*/
describeAffectedAccountsForOrganization(callback?: (err: AWSError, data: Health.Types.DescribeAffectedAccountsForOrganizationResponse) => void): Request<Health.Types.DescribeAffectedAccountsForOrganizationResponse, AWSError>;
/**
* Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this. At least one event ARN is required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
*/
describeAffectedEntities(params: Health.Types.DescribeAffectedEntitiesRequest, callback?: (err: AWSError, data: Health.Types.DescribeAffectedEntitiesResponse) => void): Request<Health.Types.DescribeAffectedEntitiesResponse, AWSError>;
/**
* Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this. At least one event ARN is required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
*/
describeAffectedEntities(callback?: (err: AWSError, data: Health.Types.DescribeAffectedEntitiesResponse) => void): Request<Health.Types.DescribeAffectedEntitiesResponse, AWSError>;
/**
* Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. At least one event Amazon Resource Name (ARN) and account ID are required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent. Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
*/
describeAffectedEntitiesForOrganization(params: Health.Types.DescribeAffectedEntitiesForOrganizationRequest, callback?: (err: AWSError, data: Health.Types.DescribeAffectedEntitiesForOrganizationResponse) => void): Request<Health.Types.DescribeAffectedEntitiesForOrganizationResponse, AWSError>;
/**
* Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. At least one event Amazon Resource Name (ARN) and account ID are required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent. Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
*/
describeAffectedEntitiesForOrganization(callback?: (err: AWSError, data: Health.Types.DescribeAffectedEntitiesForOrganizationResponse) => void): Request<Health.Types.DescribeAffectedEntitiesForOrganizationResponse, AWSError>;
/**
* Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned.
*/
describeEntityAggregates(params: Health.Types.DescribeEntityAggregatesRequest, callback?: (err: AWSError, data: Health.Types.DescribeEntityAggregatesResponse) => void): Request<Health.Types.DescribeEntityAggregatesResponse, AWSError>;
/**
* Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned.
*/
describeEntityAggregates(callback?: (err: AWSError, data: Health.Types.DescribeEntityAggregatesResponse) => void): Request<Health.Types.DescribeEntityAggregatesResponse, AWSError>;
/**
* Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
*/
describeEventAggregates(params: Health.Types.DescribeEventAggregatesRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventAggregatesResponse) => void): Request<Health.Types.DescribeEventAggregatesResponse, AWSError>;
/**
* Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
*/
describeEventAggregates(callback?: (err: AWSError, data: Health.Types.DescribeEventAggregatesResponse) => void): Request<Health.Types.DescribeEventAggregatesResponse, AWSError>;
/**
* Returns detailed information about one or more specified events. Information includes standard event data (Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve those, use the DescribeAffectedEntities operation. If a specified event cannot be retrieved, an error message is returned for that event.
*/
describeEventDetails(params: Health.Types.DescribeEventDetailsRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventDetailsResponse) => void): Request<Health.Types.DescribeEventDetailsResponse, AWSError>;
/**
* Returns detailed information about one or more specified events. Information includes standard event data (Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve those, use the DescribeAffectedEntities operation. If a specified event cannot be retrieved, an error message is returned for that event.
*/
describeEventDetails(callback?: (err: AWSError, data: Health.Types.DescribeEventDetailsResponse) => void): Request<Health.Types.DescribeEventDetailsResponse, AWSError>;
/**
* Returns detailed information about one or more specified events for one or more accounts in your organization. Information includes standard event data (Region, service, and so on, as returned by DescribeEventsForOrganization), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the DescribeAffectedEntitiesForOrganization operation. Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account. When you call the DescribeEventDetailsForOrganization operation, you specify the organizationEventDetailFilters object in the request. Depending on the AWS Health event type, note the following differences: If the event is public, the awsAccountId parameter must be empty. If you specify an account ID for a public event, then an error message is returned. That's because the event might apply to all AWS accounts and isn't specific to an account in your organization. If the event is specific to an account, then you must specify the awsAccountId parameter in the request. If you don't specify an account ID, an error message returns because the event is specific to an AWS account in your organization. For more information, see Event.
*/
describeEventDetailsForOrganization(params: Health.Types.DescribeEventDetailsForOrganizationRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventDetailsForOrganizationResponse) => void): Request<Health.Types.DescribeEventDetailsForOrganizationResponse, AWSError>;
/**
* Returns detailed information about one or more specified events for one or more accounts in your organization. Information includes standard event data (Region, service, and so on, as returned by DescribeEventsForOrganization), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the DescribeAffectedEntitiesForOrganization operation. Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account. When you call the DescribeEventDetailsForOrganization operation, you specify the organizationEventDetailFilters object in the request. Depending on the AWS Health event type, note the following differences: If the event is public, the awsAccountId parameter must be empty. If you specify an account ID for a public event, then an error message is returned. That's because the event might apply to all AWS accounts and isn't specific to an account in your organization. If the event is specific to an account, then you must specify the awsAccountId parameter in the request. If you don't specify an account ID, an error message returns because the event is specific to an AWS account in your organization. For more information, see Event.
*/
describeEventDetailsForOrganization(callback?: (err: AWSError, data: Health.Types.DescribeEventDetailsForOrganizationResponse) => void): Request<Health.Types.DescribeEventDetailsForOrganizationResponse, AWSError>;
/**
* Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
*/
describeEventTypes(params: Health.Types.DescribeEventTypesRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventTypesResponse) => void): Request<Health.Types.DescribeEventTypesResponse, AWSError>;
/**
* Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
*/
describeEventTypes(callback?: (err: AWSError, data: Health.Types.DescribeEventTypesResponse) => void): Request<Health.Types.DescribeEventTypesResponse, AWSError>;
/**
* Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations. If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent event. When you call the DescribeEvents operation and specify an entity for the entityValues parameter, AWS Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, AWS Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
*/
describeEvents(params: Health.Types.DescribeEventsRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventsResponse) => void): Request<Health.Types.DescribeEventsResponse, AWSError>;
/**
* Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations. If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent event. When you call the DescribeEvents operation and specify an entity for the entityValues parameter, AWS Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, AWS Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
*/
describeEvents(callback?: (err: AWSError, data: Health.Types.DescribeEventsResponse) => void): Request<Health.Types.DescribeEventsResponse, AWSError>;
/**
* Returns information about events across your organization in AWS Organizations. You can use thefilters parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations: DescribeAffectedAccountsForOrganization DescribeEventDetailsForOrganization DescribeAffectedEntitiesForOrganization If you don't specify a filter, the DescribeEventsForOrganizations returns all events across your organization. Results are sorted by lastModifiedTime, starting with the most recent event. For more information about the different types of AWS Health events, see Event. Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master AWS account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
*/
describeEventsForOrganization(params: Health.Types.DescribeEventsForOrganizationRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventsForOrganizationResponse) => void): Request<Health.Types.DescribeEventsForOrganizationResponse, AWSError>;
/**
* Returns information about events across your organization in AWS Organizations. You can use thefilters parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations: DescribeAffectedAccountsForOrganization DescribeEventDetailsForOrganization DescribeAffectedEntitiesForOrganization If you don't specify a filter, the DescribeEventsForOrganizations returns all events across your organization. Results are sorted by lastModifiedTime, starting with the most recent event. For more information about the different types of AWS Health events, see Event. Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master AWS account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
*/
describeEventsForOrganization(callback?: (err: AWSError, data: Health.Types.DescribeEventsForOrganizationResponse) => void): Request<Health.Types.DescribeEventsForOrganizationResponse, AWSError>;
/**
* This operation provides status information on enabling or disabling AWS Health to work with your organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account.
*/
describeHealthServiceStatusForOrganization(callback?: (err: AWSError, data: Health.Types.DescribeHealthServiceStatusForOrganizationResponse) => void): Request<Health.Types.DescribeHealthServiceStatusForOrganizationResponse, AWSError>;
/**
* Disables AWS Health from working with AWS Organizations. To call this operation, you must sign in as an AWS Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master AWS account. For more information, see Aggregating AWS Health events in the AWS Health User Guide. This operation doesn't remove the service-linked role (SLR) from the AWS master account in your organization. You must use the IAM console, API, or AWS Command Line Interface (AWS CLI) to remove the SLR. For more information, see Deleting a Service-Linked Role in the IAM User Guide. You can also disable the organizational feature by using the Organizations DisableAWSServiceAccess API operation. After you call this operation, AWS Health stops aggregating events for all other AWS accounts in your organization. If you call the AWS Health API operations for organizational view, AWS Health returns an error. AWS Health continues to aggregate health events for your AWS account.
*/
disableHealthServiceAccessForOrganization(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Calling this operation enables AWS Health to work with AWS Organizations. This applies a service-linked role (SLR) to the master account in the organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account. For more information, see Aggregating AWS Health events in the AWS Health User Guide.
*/
enableHealthServiceAccessForOrganization(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
}
declare namespace Health {
export interface AffectedEntity {
/**
* The unique identifier for the entity. Format: arn:aws:health:entity-region:aws-account:entity/entity-id . Example: arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K
*/
entityArn?: entityArn;
/**
* The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
*/
eventArn?: eventArn;
/**
* The ID of the affected entity.
*/
entityValue?: entityValue;
/**
* The URL of the affected entity.
*/
entityUrl?: entityUrl;
/**
* The 12-digit AWS account number that contains the affected entity.
*/
awsAccountId?: accountId;
/**
* The most recent time that the entity was updated.
*/
lastUpdatedTime?: timestamp;
/**
* The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, and UNKNOWN.
*/
statusCode?: entityStatusCode;
/**
* A map of entity tags attached to the affected entity. Currently, the tags property isn't supported.
*/
tags?: tagSet;
}
export interface DateTimeRange {
/**
* The starting date and time of a time range.
*/
from?: timestamp;
/**
* The ending date and time of a time range.
*/
to?: timestamp;
}
export interface DescribeAffectedAccountsForOrganizationRequest {
/**
* The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
*/
eventArn: eventArn;
/**
* If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
*/
nextToken?: nextToken;
/**
* The maximum number of items to return in one batch, between 10 and 100, inclusive.
*/
maxResults?: maxResults;
}
export interface DescribeAffectedAccountsForOrganizationResponse {
/**
* A JSON set of elements of the affected accounts.
*/
affectedAccounts?: affectedAccountsList;
/**
* This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event. If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty. If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected AWS accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have AWS accounts that use that service, those account IDs appear in the response. If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.
*/
eventScopeCode?: eventScopeCode;
/**
* If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
*/
nextToken?: nextToken;
}
export type DescribeAffectedEntitiesForOrganizationFailedSet = OrganizationAffectedEntitiesErrorItem[];
export interface DescribeAffectedEntitiesForOrganizationRequest {
/**
* A JSON set of elements including the awsAccountId and the eventArn.
*/
organizationEntityFilters: OrganizationEntityFiltersList;
/**
* The locale (language) to return information in. English (en) is the default and the only supported value at this time.
*/
locale?: locale;
/**
* If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
*/
nextToken?: nextToken;
/**
* The maximum number of items to return in one batch, between 10 and 100, inclusive.
*/
maxResults?: maxResults;
}
export interface DescribeAffectedEntitiesForOrganizationResponse {
/**
* A JSON set of elements including the awsAccountId and its entityArn, entityValue and its entityArn, lastUpdatedTime, and statusCode.
*/
entities?: EntityList;
/**
* A JSON set of elements of the failed response, including the awsAccountId, errorMessage, errorName, and eventArn.
*/
failedSet?: DescribeAffectedEntitiesForOrganizationFailedSet;
/**
* If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
*/
nextToken?: nextToken;
}
export interface DescribeAffectedEntitiesRequest {
/**
* Values to narrow the results returned. At least one event ARN is required.
*/
filter: EntityFilter;
/**
* The locale (language) to return information in. English (en) is the default and the only supported value at this time.
*/
locale?: locale;
/**
* If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
*/
nextToken?: nextToken;
/**
* The maximum number of items to return in one batch, between 10 and 100, inclusive.
*/
maxResults?: maxResults;
}
export interface DescribeAffectedEntitiesResponse {
/**
* The entities that match the filter criteria.
*/
entities?: EntityList;
/**
* If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
*/
nextToken?: nextToken;
}
export interface DescribeEntityAggregatesRequest {
/**
* A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
*/
eventArns?: EventArnsList;
}
export interface DescribeEntityAggregatesResponse {
/**
* The number of entities that are affected by each of the specified events.
*/
entityAggregates?: EntityAggregateList;
}
export interface DescribeEventAggregatesRequest {
/**
* Values to narrow the results returned.
*/
filter?: EventFilter;
/**
* The only currently supported value is eventTypeCategory.
*/
aggregateField: eventAggregateField;
/**
* The maximum number of items to return in one batch, between 10 and 100, inclusive.
*/
maxResults?: maxResults;
/**
* If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
*/
nextToken?: nextToken;
}
export interface DescribeEventAggregatesResponse {
/**
* The number of events in each category that meet the optional filter criteria.
*/
eventAggregates?: EventAggregateList;
/**
* If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
*/
nextToken?: nextToken;
}
export type DescribeEventDetailsFailedSet = EventDetailsErrorItem[];
export type DescribeEventDetailsForOrganizationFailedSet = OrganizationEventDetailsErrorItem[];
export interface DescribeEventDetailsForOrganizationRequest {
/**
* A set of JSON elements that includes the awsAccountId and the eventArn.
*/
organizationEventDetailFilters: OrganizationEventDetailFiltersList;
/**
* The locale (language) to return information in. English (en) is the default and the only supported value at this time.
*/
locale?: locale;
}
export interface DescribeEventDetailsForOrganizationResponse {
/**
* Information about the events that could be retrieved.
*/
successfulSet?: DescribeEventDetailsForOrganizationSuccessfulSet;
/**
* Error messages for any events that could not be retrieved.
*/
failedSet?: DescribeEventDetailsForOrganizationFailedSet;
}
export type DescribeEventDetailsForOrganizationSuccessfulSet = OrganizationEventDetails[];
export interface DescribeEventDetailsRequest {
/**
* A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
*/
eventArns: eventArnList;
/**
* The locale (language) to return information in. English (en) is the default and the only supported value at this time.
*/
locale?: locale;
}
export interface DescribeEventDetailsResponse {
/**
* Information about the events that could be retrieved.
*/
successfulSet?: DescribeEventDetailsSuccessfulSet;
/**
* Error messages for any events that could not be retrieved.
*/
failedSet?: DescribeEventDetailsFailedSet;
}
export type DescribeEventDetailsSuccessfulSet = EventDetails[];
export interface DescribeEventTypesRequest {
/**
* Values to narrow the results returned.
*/
filter?: EventTypeFilter;
/**
* The locale (language) to return information in. English (en) is the default and the only supported value at this time.
*/
locale?: locale;
/**
* If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
*/
nextToken?: nextToken;
/**
* The maximum number of items to return in one batch, between 10 and 100, inclusive.
*/
maxResults?: maxResults;
}
export interface DescribeEventTypesResponse {
/**
* A list of event types that match the filter criteria. Event types have a category (issue, accountNotification, or scheduledChange), a service (for example, EC2, RDS, DATAPIPELINE, BILLING), and a code (in the format AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT).
*/
eventTypes?: EventTypeList;
/**
* If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
*/
nextToken?: nextToken;
}
export interface DescribeEventsForOrganizationRequest {
/**
* Values to narrow the results returned.
*/
filter?: OrganizationEventFilter;
/**
* If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
*/
nextToken?: nextToken;
/**
* The maximum number of items to return in one batch, between 10 and 100, inclusive.
*/
maxResults?: maxResults;
/**
* The locale (language) to return information in. English (en) is the default and the only supported value at this time.
*/
locale?: locale;
}
export interface DescribeEventsForOrganizationResponse {
/**
* The events that match the specified filter criteria.
*/
events?: OrganizationEventList;
/**
* If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
*/
nextToken?: nextToken;
}
export interface DescribeEventsRequest {
/**
* Values to narrow the results returned.
*/
filter?: EventFilter;
/**
* If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
*/
nextToken?: nextToken;
/**
* The maximum number of items to return in one batch, between 10 and 100, inclusive.
*/
maxResults?: maxResults;
/**
* The locale (language) to return information in. English (en) is the default and the only supported value at this time.
*/
locale?: locale;
}
export interface DescribeEventsResponse {
/**
* The events that match the specified filter criteria.
*/
events?: EventList;
/**
* If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
*/
nextToken?: nextToken;
}
export interface DescribeHealthServiceStatusForOrganizationResponse {
/**
* Information about the status of enabling or disabling AWS Health Organizational View in your organization. Valid values are ENABLED | DISABLED | PENDING.
*/
healthServiceAccessStatusForOrganization?: healthServiceAccessStatusForOrganization;
}
export interface EntityAggregate {
/**
* The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
*/
eventArn?: eventArn;
/**
* The number of entities that match the criteria for the specified events.
*/
count?: count;
}
export type EntityAggregateList = EntityAggregate[];
export interface EntityFilter {
/**
* A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
*/
eventArns: eventArnList;
/**
* A list of entity ARNs (unique identifiers).
*/
entityArns?: entityArnList;
/**
* A list of IDs for affected entities.
*/
entityValues?: entityValueList;
/**
* A list of the most recent dates and times that the entity was updated.
*/
lastUpdatedTimes?: dateTimeRangeList;
/**
* A map of entity tags attached to the affected entity. Currently, the tags property isn't supported.
*/
tags?: tagFilter;
/**
* A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN).
*/
statusCodes?: entityStatusCodeList;
}
export type EntityList = AffectedEntity[];
export interface Event {
/**
* The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
*/
arn?: eventArn;
/**
* The AWS service that is affected by the event. For example, EC2, RDS.
*/
service?: service;
/**
* The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
*/
eventTypeCode?: eventTypeCode;
/**
* The category of the event. Possible values are issue, scheduledChange, and accountNotification.
*/
eventTypeCategory?: eventTypeCategory;
/**
* The AWS region name of the event.
*/
region?: region;
/**
* The AWS Availability Zone of the event. For example, us-east-1a.
*/
availabilityZone?: availabilityZone;
/**
* The date and time that the event began.
*/
startTime?: timestamp;
/**
* The date and time that the event ended.
*/
endTime?: timestamp;
/**
* The most recent date and time that the event was updated.
*/
lastUpdatedTime?: timestamp;
/**
* The most recent status of the event. Possible values are open, closed, and upcoming.
*/
statusCode?: eventStatusCode;
/**
* This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event. If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty. If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected AWS accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have AWS accounts that use that service, those account IDs appear in the response. If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.
*/
eventScopeCode?: eventScopeCode;
}
export interface EventAccountFilter {
/**
* The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
*/
eventArn: eventArn;
/**
* The 12-digit AWS account numbers that contains the affected entities.
*/
awsAccountId?: accountId;
}
export interface EventAggregate {
/**
* The issue type for the associated count.
*/
aggregateValue?: aggregateValue;
/**
* The number of events of the associated issue type.
*/
count?: count;
}
export type EventAggregateList = EventAggregate[];
export type EventArnsList = eventArn[];
export interface EventDescription {
/**
* The most recent description of the event.
*/
latestDescription?: eventDescription;
}
export interface EventDetails {
/**
* Summary information about the event.
*/
event?: Event;
/**
* The most recent description of the event.
*/
eventDescription?: EventDescription;
/**
* Additional metadata about the event.
*/
eventMetadata?: eventMetadata;
}
export interface EventDetailsErrorItem {
/**
* The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
*/
eventArn?: eventArn;
/**
* The name of the error.
*/
errorName?: string;
/**
* A message that describes the error.
*/
errorMessage?: string;
}
export interface EventFilter {
/**
* A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
*/
eventArns?: eventArnList;
/**
* A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
*/
eventTypeCodes?: eventTypeList;
/**
* The AWS services associated with the event. For example, EC2, RDS.
*/
services?: serviceList;
/**
* A list of AWS regions.
*/
regions?: regionList;
/**
* A list of AWS availability zones.
*/
availabilityZones?: availabilityZones;
/**
* A list of dates and times that the event began.
*/
startTimes?: dateTimeRangeList;
/**
* A list of dates and times that the event ended.
*/
endTimes?: dateTimeRangeList;
/**
* A list of dates and times that the event was last updated.
*/
lastUpdatedTimes?: dateTimeRangeList;
/**
* A list of entity ARNs (unique identifiers).
*/
entityArns?: entityArnList;
/**
* A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).
*/
entityValues?: entityValueList;
/**
* A list of event type category codes (issue, scheduledChange, or accountNotification).
*/
eventTypeCategories?: eventTypeCategoryList;
/**
* A map of entity tags attached to the affected entity. Currently, the tags property isn't supported.
*/
tags?: tagFilter;
/**
* A list of event status codes.
*/
eventStatusCodes?: eventStatusCodeList;
}
export type EventList = Event[];
export interface EventType {
/**
* The AWS service that is affected by the event. For example, EC2, RDS.
*/
service?: service;
/**
* The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
*/
code?: eventTypeCode;
/**
* A list of event type category codes (issue, scheduledChange, or accountNotification).
*/
category?: eventTypeCategory;
}
export type EventTypeCategoryList = eventTypeCategory[];
export type EventTypeCodeList = eventTypeCode[];
export interface EventTypeFilter {
/**
* A list of event type codes.
*/
eventTypeCodes?: EventTypeCodeList;
/**
* The AWS services associated with the event. For example, EC2, RDS.
*/
services?: serviceList;
/**
* A list of event type category codes (issue, scheduledChange, or accountNotification).
*/
eventTypeCategories?: EventTypeCategoryList;
}
export type EventTypeList = EventType[];
export interface OrganizationAffectedEntitiesErrorItem {
/**
* The 12-digit AWS account numbers that contains the affected entities.
*/
awsAccountId?: accountId;
/**
* The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
*/
eventArn?: eventArn;
/**
* The name of the error.
*/
errorName?: string;
/**
* The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
*/
errorMessage?: string;
}
export type OrganizationEntityFiltersList = EventAccountFilter[];
export interface OrganizationEvent {
/**
* The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
*/
arn?: eventArn;
/**
* The AWS service that is affected by the event. For example, EC2, RDS.
*/
service?: service;
/**
* The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
*/
eventTypeCode?: eventTypeCode;
/**
* The category of the event type.
*/
eventTypeCategory?: eventTypeCategory;
/**
* This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event. If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty. If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected AWS accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have AWS accounts that use that service, those account IDs appear in the response. If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.
*/
eventScopeCode?: eventScopeCode;
/**
* The AWS Region name of the event.
*/
region?: region;
/**
* The date and time that the event began.
*/
startTime?: timestamp;
/**
* The date and time that the event ended.
*/
endTime?: timestamp;
/**
* The most recent date and time that the event was updated.
*/
lastUpdatedTime?: timestamp;
/**
* The most recent status of the event. Possible values are open, closed, and upcoming.
*/
statusCode?: eventStatusCode;
}
export type OrganizationEventDetailFiltersList = EventAccountFilter[];
export interface OrganizationEventDetails {
/**
* The 12-digit AWS account numbers that contains the affected entities.
*/
awsAccountId?: accountId;
event?: Event;
eventDescription?: EventDescription;
/**
* Additional metadata about the event.
*/
eventMetadata?: eventMetadata;
}
export interface OrganizationEventDetailsErrorItem {
/**
* Error information returned when a DescribeEventDetailsForOrganization operation cannot find a specified event.
*/
awsAccountId?: accountId;
/**
* The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
*/
eventArn?: eventArn;
/**
* The name of the error.
*/
errorName?: string;
/**
* A message that describes the error.
*/
errorMessage?: string;
}
export interface OrganizationEventFilter {
/**
* A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
*/
eventTypeCodes?: eventTypeList;
/**
* A list of 12-digit AWS account numbers that contains the affected entities.
*/
awsAccountIds?: awsAccountIdsList;
/**
* The AWS services associated with the event. For example, EC2, RDS.
*/
services?: serviceList;
/**
* A list of AWS Regions.
*/
regions?: regionList;
startTime?: DateTimeRange;
endTime?: DateTimeRange;
lastUpdatedTime?: DateTimeRange;
/**
* A list of entity ARNs (unique identifiers).
*/
entityArns?: entityArnList;
/**
* A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).
*/
entityValues?: entityValueList;
/**
* A list of event type category codes (issue, scheduledChange, or accountNotification).
*/
eventTypeCategories?: eventTypeCategoryList;
/**
* A list of event status codes.
*/
eventStatusCodes?: eventStatusCodeList;
}
export type OrganizationEventList = OrganizationEvent[];
export type accountId = string;
export type affectedAccountsList = accountId[];
export type aggregateValue = string;
export type availabilityZone = string;
export type availabilityZones = availabilityZone[];
export type awsAccountIdsList = accountId[];
export type count = number;
export type dateTimeRangeList = DateTimeRange[];
export type entityArn = string;
export type entityArnList = entityArn[];
export type entityStatusCode = "IMPAIRED"|"UNIMPAIRED"|"UNKNOWN"|string;
export type entityStatusCodeList = entityStatusCode[];
export type entityUrl = string;
export type entityValue = string;
export type entityValueList = entityValue[];
export type eventAggregateField = "eventTypeCategory"|string;
export type eventArn = string;
export type eventArnList = eventArn[];
export type eventDescription = string;
export type eventMetadata = {[key: string]: metadataValue};
export type eventScopeCode = "PUBLIC"|"ACCOUNT_SPECIFIC"|"NONE"|string;
export type eventStatusCode = "open"|"closed"|"upcoming"|string;
export type eventStatusCodeList = eventStatusCode[];
export type eventType = string;
export type eventTypeCategory = "issue"|"accountNotification"|"scheduledChange"|"investigation"|string;
export type eventTypeCategoryList = eventTypeCategory[];
export type eventTypeCode = string;
export type eventTypeList = eventType[];
export type healthServiceAccessStatusForOrganization = string;
export type locale = string;
export type maxResults = number;
export type metadataKey = string;
export type metadataValue = string;
export type nextToken = string;
export type region = string;
export type regionList = region[];
export type service = string;
export type serviceList = service[];
export type tagFilter = tagSet[];
export type tagKey = string;
export type tagSet = {[key: string]: tagValue};
export type tagValue = string;
export type timestamp = Date;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2016-08-04"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the Health client.
*/
export import Types = Health;
}
export = Health;