@aws-sdk/client-health 3.379.1 → 3.385.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -19,12 +19,14 @@ export type EntityStatusCode = (typeof EntityStatusCode)[keyof typeof EntityStat
19
19
  */
20
20
  export interface AffectedEntity {
21
21
  /**
22
+ * @public
22
23
  * <p>The unique identifier for the entity. Format: <code>arn:aws:health:<i>entity-region</i>:<i>aws-account</i>:entity/<i>entity-id</i>
23
24
  * </code>. Example: <code>arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K</code>
24
25
  * </p>
25
26
  */
26
27
  entityArn?: string;
27
28
  /**
29
+ * @public
28
30
  * <p>The unique identifier for the event. The event ARN has the
29
31
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
30
32
  * </code>
@@ -36,27 +38,33 @@ export interface AffectedEntity {
36
38
  */
37
39
  eventArn?: string;
38
40
  /**
41
+ * @public
39
42
  * <p>The ID of the affected entity.</p>
40
43
  */
41
44
  entityValue?: string;
42
45
  /**
46
+ * @public
43
47
  * <p>The URL of the affected entity.</p>
44
48
  */
45
49
  entityUrl?: string;
46
50
  /**
51
+ * @public
47
52
  * <p>The 12-digit Amazon Web Services account number that contains the affected entity.</p>
48
53
  */
49
54
  awsAccountId?: string;
50
55
  /**
56
+ * @public
51
57
  * <p>The most recent time that the entity was updated.</p>
52
58
  */
53
59
  lastUpdatedTime?: Date;
54
60
  /**
61
+ * @public
55
62
  * <p>The most recent status of the entity affected by the event. The possible values are
56
63
  * <code>IMPAIRED</code>, <code>UNIMPAIRED</code>, and <code>UNKNOWN</code>.</p>
57
64
  */
58
65
  statusCode?: EntityStatusCode | string;
59
66
  /**
67
+ * @public
60
68
  * <p>A map of entity tags attached to the affected entity.</p>
61
69
  * <note>
62
70
  * <p>Currently, the <code>tags</code> property isn't supported.</p>
@@ -69,6 +77,7 @@ export interface AffectedEntity {
69
77
  */
70
78
  export interface DescribeAffectedAccountsForOrganizationRequest {
71
79
  /**
80
+ * @public
72
81
  * <p>The unique identifier for the event. The event ARN has the
73
82
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
74
83
  * </code>
@@ -80,6 +89,7 @@ export interface DescribeAffectedAccountsForOrganizationRequest {
80
89
  */
81
90
  eventArn: string | undefined;
82
91
  /**
92
+ * @public
83
93
  * <p>If the results of a search are large, only a portion of the
84
94
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
85
95
  * retrieve the next batch of results, reissue the search request and include the returned token.
@@ -87,6 +97,7 @@ export interface DescribeAffectedAccountsForOrganizationRequest {
87
97
  */
88
98
  nextToken?: string;
89
99
  /**
100
+ * @public
90
101
  * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
91
102
  */
92
103
  maxResults?: number;
@@ -109,10 +120,12 @@ export type EventScopeCode = (typeof EventScopeCode)[keyof typeof EventScopeCode
109
120
  */
110
121
  export interface DescribeAffectedAccountsForOrganizationResponse {
111
122
  /**
123
+ * @public
112
124
  * <p>A JSON set of elements of the affected accounts.</p>
113
125
  */
114
126
  affectedAccounts?: string[];
115
127
  /**
128
+ * @public
116
129
  * <p>This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.</p>
117
130
  * <ul>
118
131
  * <li>
@@ -135,6 +148,7 @@ export interface DescribeAffectedAccountsForOrganizationResponse {
135
148
  */
136
149
  eventScopeCode?: EventScopeCode | string;
137
150
  /**
151
+ * @public
138
152
  * <p>If the results of a search are large, only a portion of the
139
153
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
140
154
  * retrieve the next batch of results, reissue the search request and include the returned token.
@@ -166,10 +180,12 @@ export declare class InvalidPaginationToken extends __BaseException {
166
180
  */
167
181
  export interface DateTimeRange {
168
182
  /**
183
+ * @public
169
184
  * <p>The starting date and time of a time range.</p>
170
185
  */
171
186
  from?: Date;
172
187
  /**
188
+ * @public
173
189
  * <p>The ending date and time of a time range.</p>
174
190
  */
175
191
  to?: Date;
@@ -180,23 +196,28 @@ export interface DateTimeRange {
180
196
  */
181
197
  export interface EntityFilter {
182
198
  /**
199
+ * @public
183
200
  * <p>A list of event ARNs (unique identifiers). For example: <code>"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"</code>
184
201
  * </p>
185
202
  */
186
203
  eventArns: string[] | undefined;
187
204
  /**
205
+ * @public
188
206
  * <p>A list of entity ARNs (unique identifiers).</p>
189
207
  */
190
208
  entityArns?: string[];
191
209
  /**
210
+ * @public
192
211
  * <p>A list of IDs for affected entities.</p>
193
212
  */
194
213
  entityValues?: string[];
195
214
  /**
215
+ * @public
196
216
  * <p>A list of the most recent dates and times that the entity was updated.</p>
197
217
  */
198
218
  lastUpdatedTimes?: DateTimeRange[];
199
219
  /**
220
+ * @public
200
221
  * <p>A map of entity tags attached to the affected entity.</p>
201
222
  * <note>
202
223
  * <p>Currently, the <code>tags</code> property isn't supported.</p>
@@ -204,6 +225,7 @@ export interface EntityFilter {
204
225
  */
205
226
  tags?: Record<string, string>[];
206
227
  /**
228
+ * @public
207
229
  * <p>A list of entity status codes (<code>IMPAIRED</code>, <code>UNIMPAIRED</code>, or
208
230
  * <code>UNKNOWN</code>).</p>
209
231
  */
@@ -214,14 +236,17 @@ export interface EntityFilter {
214
236
  */
215
237
  export interface DescribeAffectedEntitiesRequest {
216
238
  /**
239
+ * @public
217
240
  * <p>Values to narrow the results returned. At least one event ARN is required.</p>
218
241
  */
219
242
  filter: EntityFilter | undefined;
220
243
  /**
244
+ * @public
221
245
  * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
222
246
  */
223
247
  locale?: string;
224
248
  /**
249
+ * @public
225
250
  * <p>If the results of a search are large, only a portion of the
226
251
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
227
252
  * retrieve the next batch of results, reissue the search request and include the returned token.
@@ -229,6 +254,7 @@ export interface DescribeAffectedEntitiesRequest {
229
254
  */
230
255
  nextToken?: string;
231
256
  /**
257
+ * @public
232
258
  * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
233
259
  */
234
260
  maxResults?: number;
@@ -238,10 +264,12 @@ export interface DescribeAffectedEntitiesRequest {
238
264
  */
239
265
  export interface DescribeAffectedEntitiesResponse {
240
266
  /**
267
+ * @public
241
268
  * <p>The entities that match the filter criteria.</p>
242
269
  */
243
270
  entities?: AffectedEntity[];
244
271
  /**
272
+ * @public
245
273
  * <p>If the results of a search are large, only a portion of the
246
274
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
247
275
  * retrieve the next batch of results, reissue the search request and include the returned token.
@@ -267,6 +295,7 @@ export declare class UnsupportedLocale extends __BaseException {
267
295
  */
268
296
  export interface EventAccountFilter {
269
297
  /**
298
+ * @public
270
299
  * <p>The unique identifier for the event. The event ARN has the
271
300
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
272
301
  * </code>
@@ -278,6 +307,7 @@ export interface EventAccountFilter {
278
307
  */
279
308
  eventArn: string | undefined;
280
309
  /**
310
+ * @public
281
311
  * <p>The 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
282
312
  */
283
313
  awsAccountId?: string;
@@ -287,15 +317,18 @@ export interface EventAccountFilter {
287
317
  */
288
318
  export interface DescribeAffectedEntitiesForOrganizationRequest {
289
319
  /**
320
+ * @public
290
321
  * <p>A JSON set of elements including the <code>awsAccountId</code> and the
291
322
  * <code>eventArn</code>.</p>
292
323
  */
293
324
  organizationEntityFilters: EventAccountFilter[] | undefined;
294
325
  /**
326
+ * @public
295
327
  * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
296
328
  */
297
329
  locale?: string;
298
330
  /**
331
+ * @public
299
332
  * <p>If the results of a search are large, only a portion of the
300
333
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
301
334
  * retrieve the next batch of results, reissue the search request and include the returned token.
@@ -303,6 +336,7 @@ export interface DescribeAffectedEntitiesForOrganizationRequest {
303
336
  */
304
337
  nextToken?: string;
305
338
  /**
339
+ * @public
306
340
  * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
307
341
  */
308
342
  maxResults?: number;
@@ -314,10 +348,12 @@ export interface DescribeAffectedEntitiesForOrganizationRequest {
314
348
  */
315
349
  export interface OrganizationAffectedEntitiesErrorItem {
316
350
  /**
351
+ * @public
317
352
  * <p>The 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
318
353
  */
319
354
  awsAccountId?: string;
320
355
  /**
356
+ * @public
321
357
  * <p>The unique identifier for the event. The event ARN has the
322
358
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
323
359
  * </code>
@@ -329,10 +365,12 @@ export interface OrganizationAffectedEntitiesErrorItem {
329
365
  */
330
366
  eventArn?: string;
331
367
  /**
368
+ * @public
332
369
  * <p>The name of the error.</p>
333
370
  */
334
371
  errorName?: string;
335
372
  /**
373
+ * @public
336
374
  * <p>A message that describes the error. Follow the error message and retry your request.</p>
337
375
  * <p>For example, the <code>InvalidAccountInputError</code> error message appears if
338
376
  * you call the <code>DescribeAffectedEntitiesForOrganization</code> operation and specify the
@@ -346,17 +384,20 @@ export interface OrganizationAffectedEntitiesErrorItem {
346
384
  */
347
385
  export interface DescribeAffectedEntitiesForOrganizationResponse {
348
386
  /**
387
+ * @public
349
388
  * <p>A JSON set of elements including the <code>awsAccountId</code> and its
350
389
  * <code>entityArn</code>, <code>entityValue</code> and its <code>entityArn</code>,
351
390
  * <code>lastUpdatedTime</code>, and <code>statusCode</code>.</p>
352
391
  */
353
392
  entities?: AffectedEntity[];
354
393
  /**
394
+ * @public
355
395
  * <p>A JSON set of elements of the failed response, including the <code>awsAccountId</code>,
356
396
  * <code>errorMessage</code>, <code>errorName</code>, and <code>eventArn</code>.</p>
357
397
  */
358
398
  failedSet?: OrganizationAffectedEntitiesErrorItem[];
359
399
  /**
400
+ * @public
360
401
  * <p>If the results of a search are large, only a portion of the
361
402
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
362
403
  * retrieve the next batch of results, reissue the search request and include the returned token.
@@ -369,6 +410,7 @@ export interface DescribeAffectedEntitiesForOrganizationResponse {
369
410
  */
370
411
  export interface DescribeEntityAggregatesRequest {
371
412
  /**
413
+ * @public
372
414
  * <p>A list of event ARNs (unique identifiers). For example: <code>"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"</code>
373
415
  * </p>
374
416
  */
@@ -380,6 +422,7 @@ export interface DescribeEntityAggregatesRequest {
380
422
  */
381
423
  export interface EntityAggregate {
382
424
  /**
425
+ * @public
383
426
  * <p>The unique identifier for the event. The event ARN has the
384
427
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
385
428
  * </code>
@@ -391,6 +434,7 @@ export interface EntityAggregate {
391
434
  */
392
435
  eventArn?: string;
393
436
  /**
437
+ * @public
394
438
  * <p>The number of entities that match the criteria for the specified events.</p>
395
439
  */
396
440
  count?: number;
@@ -400,6 +444,7 @@ export interface EntityAggregate {
400
444
  */
401
445
  export interface DescribeEntityAggregatesResponse {
402
446
  /**
447
+ * @public
403
448
  * <p>The number of entities that are affected by each of the specified events.</p>
404
449
  */
405
450
  entityAggregates?: EntityAggregate[];
@@ -449,55 +494,67 @@ export type EventTypeCategory = (typeof EventTypeCategory)[keyof typeof EventTyp
449
494
  */
450
495
  export interface EventFilter {
451
496
  /**
497
+ * @public
452
498
  * <p>A list of event ARNs (unique identifiers). For example: <code>"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"</code>
453
499
  * </p>
454
500
  */
455
501
  eventArns?: string[];
456
502
  /**
503
+ * @public
457
504
  * <p>A list of unique identifiers for event types. For example, <code>"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".</code>
458
505
  * </p>
459
506
  */
460
507
  eventTypeCodes?: string[];
461
508
  /**
509
+ * @public
462
510
  * <p>The Amazon Web Services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
463
511
  */
464
512
  services?: string[];
465
513
  /**
514
+ * @public
466
515
  * <p>A list of Amazon Web Services Regions.</p>
467
516
  */
468
517
  regions?: string[];
469
518
  /**
519
+ * @public
470
520
  * <p>A list of Amazon Web Services Availability Zones.</p>
471
521
  */
472
522
  availabilityZones?: string[];
473
523
  /**
524
+ * @public
474
525
  * <p>A list of dates and times that the event began.</p>
475
526
  */
476
527
  startTimes?: DateTimeRange[];
477
528
  /**
529
+ * @public
478
530
  * <p>A list of dates and times that the event ended.</p>
479
531
  */
480
532
  endTimes?: DateTimeRange[];
481
533
  /**
534
+ * @public
482
535
  * <p>A list of dates and times that the event was last updated.</p>
483
536
  */
484
537
  lastUpdatedTimes?: DateTimeRange[];
485
538
  /**
539
+ * @public
486
540
  * <p>A list of entity ARNs (unique identifiers).</p>
487
541
  */
488
542
  entityArns?: string[];
489
543
  /**
544
+ * @public
490
545
  * <p>A list of entity identifiers, such as EC2 instance IDs (<code>i-34ab692e</code>) or EBS
491
546
  * volumes (<code>vol-426ab23e</code>).</p>
492
547
  */
493
548
  entityValues?: string[];
494
549
  /**
550
+ * @public
495
551
  * <p>A list of event type category codes. Possible values are
496
552
  * <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
497
553
  * the <code>investigation</code> value isn't supported at this time.</p>
498
554
  */
499
555
  eventTypeCategories?: (EventTypeCategory | string)[];
500
556
  /**
557
+ * @public
501
558
  * <p>A map of entity tags attached to the affected entity.</p>
502
559
  * <note>
503
560
  * <p>Currently, the <code>tags</code> property isn't supported.</p>
@@ -505,6 +562,7 @@ export interface EventFilter {
505
562
  */
506
563
  tags?: Record<string, string>[];
507
564
  /**
565
+ * @public
508
566
  * <p>A list of event status codes.</p>
509
567
  */
510
568
  eventStatusCodes?: (EventStatusCode | string)[];
@@ -514,18 +572,22 @@ export interface EventFilter {
514
572
  */
515
573
  export interface DescribeEventAggregatesRequest {
516
574
  /**
575
+ * @public
517
576
  * <p>Values to narrow the results returned.</p>
518
577
  */
519
578
  filter?: EventFilter;
520
579
  /**
580
+ * @public
521
581
  * <p>The only currently supported value is <code>eventTypeCategory</code>.</p>
522
582
  */
523
583
  aggregateField: EventAggregateField | string | undefined;
524
584
  /**
585
+ * @public
525
586
  * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
526
587
  */
527
588
  maxResults?: number;
528
589
  /**
590
+ * @public
529
591
  * <p>If the results of a search are large, only a portion of the
530
592
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
531
593
  * retrieve the next batch of results, reissue the search request and include the returned token.
@@ -539,10 +601,12 @@ export interface DescribeEventAggregatesRequest {
539
601
  */
540
602
  export interface EventAggregate {
541
603
  /**
604
+ * @public
542
605
  * <p>The issue type for the associated count.</p>
543
606
  */
544
607
  aggregateValue?: string;
545
608
  /**
609
+ * @public
546
610
  * <p>The number of events of the associated issue type.</p>
547
611
  */
548
612
  count?: number;
@@ -552,10 +616,12 @@ export interface EventAggregate {
552
616
  */
553
617
  export interface DescribeEventAggregatesResponse {
554
618
  /**
619
+ * @public
555
620
  * <p>The number of events in each category that meet the optional filter criteria.</p>
556
621
  */
557
622
  eventAggregates?: EventAggregate[];
558
623
  /**
624
+ * @public
559
625
  * <p>If the results of a search are large, only a portion of the
560
626
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
561
627
  * retrieve the next batch of results, reissue the search request and include the returned token.
@@ -568,11 +634,13 @@ export interface DescribeEventAggregatesResponse {
568
634
  */
569
635
  export interface DescribeEventDetailsRequest {
570
636
  /**
637
+ * @public
571
638
  * <p>A list of event ARNs (unique identifiers). For example: <code>"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"</code>
572
639
  * </p>
573
640
  */
574
641
  eventArns: string[] | undefined;
575
642
  /**
643
+ * @public
576
644
  * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
577
645
  */
578
646
  locale?: string;
@@ -583,6 +651,7 @@ export interface DescribeEventDetailsRequest {
583
651
  */
584
652
  export interface EventDetailsErrorItem {
585
653
  /**
654
+ * @public
586
655
  * <p>The unique identifier for the event. The event ARN has the
587
656
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
588
657
  * </code>
@@ -594,10 +663,12 @@ export interface EventDetailsErrorItem {
594
663
  */
595
664
  eventArn?: string;
596
665
  /**
666
+ * @public
597
667
  * <p>The name of the error.</p>
598
668
  */
599
669
  errorName?: string;
600
670
  /**
671
+ * @public
601
672
  * <p>A message that describes the error.</p>
602
673
  */
603
674
  errorMessage?: string;
@@ -627,6 +698,7 @@ export interface EventDetailsErrorItem {
627
698
  */
628
699
  export interface Event {
629
700
  /**
701
+ * @public
630
702
  * <p>The unique identifier for the event. The event ARN has the
631
703
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
632
704
  * </code>
@@ -638,46 +710,56 @@ export interface Event {
638
710
  */
639
711
  arn?: string;
640
712
  /**
713
+ * @public
641
714
  * <p>The Amazon Web Service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
642
715
  */
643
716
  service?: string;
644
717
  /**
718
+ * @public
645
719
  * <p>The unique identifier for the event type. The format is <code>AWS_<i>SERVICE</i>_<i>DESCRIPTION</i>
646
720
  * </code>; for example, <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code>.</p>
647
721
  */
648
722
  eventTypeCode?: string;
649
723
  /**
724
+ * @public
650
725
  * <p>A list of event type category codes. Possible values are
651
726
  * <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
652
727
  * the <code>investigation</code> value isn't supported at this time.</p>
653
728
  */
654
729
  eventTypeCategory?: EventTypeCategory | string;
655
730
  /**
731
+ * @public
656
732
  * <p>The Amazon Web Services Region name of the event.</p>
657
733
  */
658
734
  region?: string;
659
735
  /**
736
+ * @public
660
737
  * <p>The Amazon Web Services Availability Zone of the event. For example, us-east-1a.</p>
661
738
  */
662
739
  availabilityZone?: string;
663
740
  /**
741
+ * @public
664
742
  * <p>The date and time that the event began.</p>
665
743
  */
666
744
  startTime?: Date;
667
745
  /**
746
+ * @public
668
747
  * <p>The date and time that the event ended.</p>
669
748
  */
670
749
  endTime?: Date;
671
750
  /**
751
+ * @public
672
752
  * <p>The most recent date and time that the event was updated.</p>
673
753
  */
674
754
  lastUpdatedTime?: Date;
675
755
  /**
756
+ * @public
676
757
  * <p>The most recent status of the event. Possible values are <code>open</code>,
677
758
  * <code>closed</code>, and <code>upcoming</code>.</p>
678
759
  */
679
760
  statusCode?: EventStatusCode | string;
680
761
  /**
762
+ * @public
681
763
  * <p>This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.</p>
682
764
  * <ul>
683
765
  * <li>
@@ -707,6 +789,7 @@ export interface Event {
707
789
  */
708
790
  export interface EventDescription {
709
791
  /**
792
+ * @public
710
793
  * <p>The most recent description of the event.</p>
711
794
  */
712
795
  latestDescription?: string;
@@ -718,14 +801,17 @@ export interface EventDescription {
718
801
  */
719
802
  export interface EventDetails {
720
803
  /**
804
+ * @public
721
805
  * <p>Summary information about the event.</p>
722
806
  */
723
807
  event?: Event;
724
808
  /**
809
+ * @public
725
810
  * <p>The most recent description of the event.</p>
726
811
  */
727
812
  eventDescription?: EventDescription;
728
813
  /**
814
+ * @public
729
815
  * <p>Additional metadata about the event.</p>
730
816
  */
731
817
  eventMetadata?: Record<string, string>;
@@ -735,10 +821,12 @@ export interface EventDetails {
735
821
  */
736
822
  export interface DescribeEventDetailsResponse {
737
823
  /**
824
+ * @public
738
825
  * <p>Information about the events that could be retrieved.</p>
739
826
  */
740
827
  successfulSet?: EventDetails[];
741
828
  /**
829
+ * @public
742
830
  * <p>Error messages for any events that could not be retrieved.</p>
743
831
  */
744
832
  failedSet?: EventDetailsErrorItem[];
@@ -748,11 +836,13 @@ export interface DescribeEventDetailsResponse {
748
836
  */
749
837
  export interface DescribeEventDetailsForOrganizationRequest {
750
838
  /**
839
+ * @public
751
840
  * <p>A set of JSON elements that includes the <code>awsAccountId</code> and the
752
841
  * <code>eventArn</code>.</p>
753
842
  */
754
843
  organizationEventDetailFilters: EventAccountFilter[] | undefined;
755
844
  /**
845
+ * @public
756
846
  * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
757
847
  */
758
848
  locale?: string;
@@ -764,11 +854,13 @@ export interface DescribeEventDetailsForOrganizationRequest {
764
854
  */
765
855
  export interface OrganizationEventDetailsErrorItem {
766
856
  /**
857
+ * @public
767
858
  * <p>Error information returned when a <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html">DescribeEventDetailsForOrganization</a> operation can't find a specified
768
859
  * event.</p>
769
860
  */
770
861
  awsAccountId?: string;
771
862
  /**
863
+ * @public
772
864
  * <p>The unique identifier for the event. The event ARN has the
773
865
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
774
866
  * </code>
@@ -780,10 +872,12 @@ export interface OrganizationEventDetailsErrorItem {
780
872
  */
781
873
  eventArn?: string;
782
874
  /**
875
+ * @public
783
876
  * <p>The name of the error.</p>
784
877
  */
785
878
  errorName?: string;
786
879
  /**
880
+ * @public
787
881
  * <p>A message that describes the error.</p>
788
882
  * <p>If you call the <code>DescribeEventDetailsForOrganization</code> operation and receive one of the following errors, follow the recommendations in the message:</p>
789
883
  * <ul>
@@ -808,10 +902,12 @@ export interface OrganizationEventDetailsErrorItem {
808
902
  */
809
903
  export interface OrganizationEventDetails {
810
904
  /**
905
+ * @public
811
906
  * <p>The 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
812
907
  */
813
908
  awsAccountId?: string;
814
909
  /**
910
+ * @public
815
911
  * <p>Summary information about an Health event.</p>
816
912
  * <p>Health events can be public or account-specific:</p>
817
913
  * <ul>
@@ -835,11 +931,13 @@ export interface OrganizationEventDetails {
835
931
  */
836
932
  event?: Event;
837
933
  /**
934
+ * @public
838
935
  * <p>The detailed description of the event. Included in the information returned by the
839
936
  * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html">DescribeEventDetails</a> operation.</p>
840
937
  */
841
938
  eventDescription?: EventDescription;
842
939
  /**
940
+ * @public
843
941
  * <p>Additional metadata about the event.</p>
844
942
  */
845
943
  eventMetadata?: Record<string, string>;
@@ -849,10 +947,12 @@ export interface OrganizationEventDetails {
849
947
  */
850
948
  export interface DescribeEventDetailsForOrganizationResponse {
851
949
  /**
950
+ * @public
852
951
  * <p>Information about the events that could be retrieved.</p>
853
952
  */
854
953
  successfulSet?: OrganizationEventDetails[];
855
954
  /**
955
+ * @public
856
956
  * <p>Error messages for any events that could not be retrieved.</p>
857
957
  */
858
958
  failedSet?: OrganizationEventDetailsErrorItem[];
@@ -862,10 +962,12 @@ export interface DescribeEventDetailsForOrganizationResponse {
862
962
  */
863
963
  export interface DescribeEventsRequest {
864
964
  /**
965
+ * @public
865
966
  * <p>Values to narrow the results returned.</p>
866
967
  */
867
968
  filter?: EventFilter;
868
969
  /**
970
+ * @public
869
971
  * <p>If the results of a search are large, only a portion of the
870
972
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
871
973
  * retrieve the next batch of results, reissue the search request and include the returned token.
@@ -873,10 +975,12 @@ export interface DescribeEventsRequest {
873
975
  */
874
976
  nextToken?: string;
875
977
  /**
978
+ * @public
876
979
  * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
877
980
  */
878
981
  maxResults?: number;
879
982
  /**
983
+ * @public
880
984
  * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
881
985
  */
882
986
  locale?: string;
@@ -886,10 +990,12 @@ export interface DescribeEventsRequest {
886
990
  */
887
991
  export interface DescribeEventsResponse {
888
992
  /**
993
+ * @public
889
994
  * <p>The events that match the specified filter criteria.</p>
890
995
  */
891
996
  events?: Event[];
892
997
  /**
998
+ * @public
893
999
  * <p>If the results of a search are large, only a portion of the
894
1000
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
895
1001
  * retrieve the next batch of results, reissue the search request and include the returned token.
@@ -903,23 +1009,28 @@ export interface DescribeEventsResponse {
903
1009
  */
904
1010
  export interface OrganizationEventFilter {
905
1011
  /**
1012
+ * @public
906
1013
  * <p>A list of unique identifiers for event types. For example, <code>"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".</code>
907
1014
  * </p>
908
1015
  */
909
1016
  eventTypeCodes?: string[];
910
1017
  /**
1018
+ * @public
911
1019
  * <p>A list of 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
912
1020
  */
913
1021
  awsAccountIds?: string[];
914
1022
  /**
1023
+ * @public
915
1024
  * <p>The Amazon Web Services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
916
1025
  */
917
1026
  services?: string[];
918
1027
  /**
1028
+ * @public
919
1029
  * <p>A list of Amazon Web Services Regions.</p>
920
1030
  */
921
1031
  regions?: string[];
922
1032
  /**
1033
+ * @public
923
1034
  * <p>A range of dates and times that is used by the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html">EventFilter</a> and <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html">EntityFilter</a> objects. If <code>from</code> is set and <code>to</code> is set:
924
1035
  * match items where the timestamp (<code>startTime</code>, <code>endTime</code>, or
925
1036
  * <code>lastUpdatedTime</code>) is between <code>from</code> and <code>to</code>
@@ -930,6 +1041,7 @@ export interface OrganizationEventFilter {
930
1041
  */
931
1042
  startTime?: DateTimeRange;
932
1043
  /**
1044
+ * @public
933
1045
  * <p>A range of dates and times that is used by the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html">EventFilter</a> and <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html">EntityFilter</a> objects. If <code>from</code> is set and <code>to</code> is set:
934
1046
  * match items where the timestamp (<code>startTime</code>, <code>endTime</code>, or
935
1047
  * <code>lastUpdatedTime</code>) is between <code>from</code> and <code>to</code>
@@ -940,6 +1052,7 @@ export interface OrganizationEventFilter {
940
1052
  */
941
1053
  endTime?: DateTimeRange;
942
1054
  /**
1055
+ * @public
943
1056
  * <p>A range of dates and times that is used by the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html">EventFilter</a> and <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html">EntityFilter</a> objects. If <code>from</code> is set and <code>to</code> is set:
944
1057
  * match items where the timestamp (<code>startTime</code>, <code>endTime</code>, or
945
1058
  * <code>lastUpdatedTime</code>) is between <code>from</code> and <code>to</code>
@@ -950,20 +1063,24 @@ export interface OrganizationEventFilter {
950
1063
  */
951
1064
  lastUpdatedTime?: DateTimeRange;
952
1065
  /**
1066
+ * @public
953
1067
  * <p>A list of entity ARNs (unique identifiers).</p>
954
1068
  */
955
1069
  entityArns?: string[];
956
1070
  /**
1071
+ * @public
957
1072
  * <p>A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).</p>
958
1073
  */
959
1074
  entityValues?: string[];
960
1075
  /**
1076
+ * @public
961
1077
  * <p>A list of event type category codes. Possible values are
962
1078
  * <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
963
1079
  * the <code>investigation</code> value isn't supported at this time.</p>
964
1080
  */
965
1081
  eventTypeCategories?: (EventTypeCategory | string)[];
966
1082
  /**
1083
+ * @public
967
1084
  * <p>A list of event status codes.</p>
968
1085
  */
969
1086
  eventStatusCodes?: (EventStatusCode | string)[];
@@ -973,10 +1090,12 @@ export interface OrganizationEventFilter {
973
1090
  */
974
1091
  export interface DescribeEventsForOrganizationRequest {
975
1092
  /**
1093
+ * @public
976
1094
  * <p>Values to narrow the results returned.</p>
977
1095
  */
978
1096
  filter?: OrganizationEventFilter;
979
1097
  /**
1098
+ * @public
980
1099
  * <p>If the results of a search are large, only a portion of the
981
1100
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
982
1101
  * retrieve the next batch of results, reissue the search request and include the returned token.
@@ -984,10 +1103,12 @@ export interface DescribeEventsForOrganizationRequest {
984
1103
  */
985
1104
  nextToken?: string;
986
1105
  /**
1106
+ * @public
987
1107
  * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
988
1108
  */
989
1109
  maxResults?: number;
990
1110
  /**
1111
+ * @public
991
1112
  * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
992
1113
  */
993
1114
  locale?: string;
@@ -998,6 +1119,7 @@ export interface DescribeEventsForOrganizationRequest {
998
1119
  */
999
1120
  export interface OrganizationEvent {
1000
1121
  /**
1122
+ * @public
1001
1123
  * <p>The unique identifier for the event. The event ARN has the
1002
1124
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
1003
1125
  * </code>
@@ -1009,22 +1131,26 @@ export interface OrganizationEvent {
1009
1131
  */
1010
1132
  arn?: string;
1011
1133
  /**
1134
+ * @public
1012
1135
  * <p>The Amazon Web Service that is affected by the event, such as EC2 and RDS.</p>
1013
1136
  */
1014
1137
  service?: string;
1015
1138
  /**
1139
+ * @public
1016
1140
  * <p>The unique identifier for the event type. The format is
1017
1141
  * <code>AWS_SERVICE_DESCRIPTION</code>. For example,
1018
1142
  * <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code>.</p>
1019
1143
  */
1020
1144
  eventTypeCode?: string;
1021
1145
  /**
1146
+ * @public
1022
1147
  * <p>A list of event type category codes. Possible values are
1023
1148
  * <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
1024
1149
  * the <code>investigation</code> value isn't supported at this time.</p>
1025
1150
  */
1026
1151
  eventTypeCategory?: EventTypeCategory | string;
1027
1152
  /**
1153
+ * @public
1028
1154
  * <p>This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.</p>
1029
1155
  * <ul>
1030
1156
  * <li>
@@ -1047,22 +1173,27 @@ export interface OrganizationEvent {
1047
1173
  */
1048
1174
  eventScopeCode?: EventScopeCode | string;
1049
1175
  /**
1176
+ * @public
1050
1177
  * <p>The Amazon Web Services Region name of the event.</p>
1051
1178
  */
1052
1179
  region?: string;
1053
1180
  /**
1181
+ * @public
1054
1182
  * <p>The date and time that the event began.</p>
1055
1183
  */
1056
1184
  startTime?: Date;
1057
1185
  /**
1186
+ * @public
1058
1187
  * <p>The date and time that the event ended.</p>
1059
1188
  */
1060
1189
  endTime?: Date;
1061
1190
  /**
1191
+ * @public
1062
1192
  * <p>The most recent date and time that the event was updated.</p>
1063
1193
  */
1064
1194
  lastUpdatedTime?: Date;
1065
1195
  /**
1196
+ * @public
1066
1197
  * <p>The most recent status of the event. Possible values are <code>open</code>,
1067
1198
  * <code>closed</code>, and <code>upcoming</code>.</p>
1068
1199
  */
@@ -1073,10 +1204,12 @@ export interface OrganizationEvent {
1073
1204
  */
1074
1205
  export interface DescribeEventsForOrganizationResponse {
1075
1206
  /**
1207
+ * @public
1076
1208
  * <p>The events that match the specified filter criteria.</p>
1077
1209
  */
1078
1210
  events?: OrganizationEvent[];
1079
1211
  /**
1212
+ * @public
1080
1213
  * <p>If the results of a search are large, only a portion of the
1081
1214
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
1082
1215
  * retrieve the next batch of results, reissue the search request and include the returned token.
@@ -1091,14 +1224,17 @@ export interface DescribeEventsForOrganizationResponse {
1091
1224
  */
1092
1225
  export interface EventTypeFilter {
1093
1226
  /**
1227
+ * @public
1094
1228
  * <p>A list of event type codes.</p>
1095
1229
  */
1096
1230
  eventTypeCodes?: string[];
1097
1231
  /**
1232
+ * @public
1098
1233
  * <p>The Amazon Web Services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1099
1234
  */
1100
1235
  services?: string[];
1101
1236
  /**
1237
+ * @public
1102
1238
  * <p>A list of event type category codes. Possible values are
1103
1239
  * <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
1104
1240
  * the <code>investigation</code> value isn't supported at this time.</p>
@@ -1110,14 +1246,17 @@ export interface EventTypeFilter {
1110
1246
  */
1111
1247
  export interface DescribeEventTypesRequest {
1112
1248
  /**
1249
+ * @public
1113
1250
  * <p>Values to narrow the results returned.</p>
1114
1251
  */
1115
1252
  filter?: EventTypeFilter;
1116
1253
  /**
1254
+ * @public
1117
1255
  * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
1118
1256
  */
1119
1257
  locale?: string;
1120
1258
  /**
1259
+ * @public
1121
1260
  * <p>If the results of a search are large, only a portion of the
1122
1261
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
1123
1262
  * retrieve the next batch of results, reissue the search request and include the returned token.
@@ -1125,6 +1264,7 @@ export interface DescribeEventTypesRequest {
1125
1264
  */
1126
1265
  nextToken?: string;
1127
1266
  /**
1267
+ * @public
1128
1268
  * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
1129
1269
  * <note>
1130
1270
  * <p>If you don't specify the <code>maxResults</code> parameter, this operation returns a
@@ -1148,15 +1288,18 @@ export interface DescribeEventTypesRequest {
1148
1288
  */
1149
1289
  export interface EventType {
1150
1290
  /**
1291
+ * @public
1151
1292
  * <p>The Amazon Web Service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1152
1293
  */
1153
1294
  service?: string;
1154
1295
  /**
1296
+ * @public
1155
1297
  * <p>The unique identifier for the event type. The format is <code>AWS_<i>SERVICE</i>_<i>DESCRIPTION</i>
1156
1298
  * </code>; for example, <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code>.</p>
1157
1299
  */
1158
1300
  code?: string;
1159
1301
  /**
1302
+ * @public
1160
1303
  * <p>A list of event type category codes. Possible values are
1161
1304
  * <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
1162
1305
  * the <code>investigation</code> value isn't supported at this time.</p>
@@ -1168,6 +1311,7 @@ export interface EventType {
1168
1311
  */
1169
1312
  export interface DescribeEventTypesResponse {
1170
1313
  /**
1314
+ * @public
1171
1315
  * <p>A list of event types that match the filter criteria. Event types have a category
1172
1316
  * (<code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>),
1173
1317
  * a service (for example, <code>EC2</code>, <code>RDS</code>, <code>DATAPIPELINE</code>,
@@ -1178,6 +1322,7 @@ export interface DescribeEventTypesResponse {
1178
1322
  */
1179
1323
  eventTypes?: EventType[];
1180
1324
  /**
1325
+ * @public
1181
1326
  * <p>If the results of a search are large, only a portion of the
1182
1327
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
1183
1328
  * retrieve the next batch of results, reissue the search request and include the returned token.
@@ -1190,6 +1335,7 @@ export interface DescribeEventTypesResponse {
1190
1335
  */
1191
1336
  export interface DescribeHealthServiceStatusForOrganizationResponse {
1192
1337
  /**
1338
+ * @public
1193
1339
  * <p>Information about the status of enabling or disabling the Health organizational
1194
1340
  * view feature in your organization.</p>
1195
1341
  * <p>Valid values are <code>ENABLED | DISABLED | PENDING</code>. </p>
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-health",
3
3
  "description": "AWS SDK for JavaScript Health Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.385.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.385.0",
25
+ "@aws-sdk/credential-provider-node": "3.385.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",