@aws-sdk/client-health 3.529.1 → 3.535.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.
Files changed (41) hide show
  1. package/dist-types/Health.d.ts +9 -1
  2. package/dist-types/HealthClient.d.ts +1 -1
  3. package/dist-types/commands/DescribeAffectedAccountsForOrganizationCommand.d.ts +2 -1
  4. package/dist-types/commands/DescribeAffectedEntitiesCommand.d.ts +2 -1
  5. package/dist-types/commands/DescribeAffectedEntitiesForOrganizationCommand.d.ts +2 -1
  6. package/dist-types/commands/DescribeEntityAggregatesCommand.d.ts +2 -1
  7. package/dist-types/commands/DescribeEntityAggregatesForOrganizationCommand.d.ts +2 -1
  8. package/dist-types/commands/DescribeEventAggregatesCommand.d.ts +2 -1
  9. package/dist-types/commands/DescribeEventDetailsCommand.d.ts +2 -1
  10. package/dist-types/commands/DescribeEventDetailsForOrganizationCommand.d.ts +2 -1
  11. package/dist-types/commands/DescribeEventTypesCommand.d.ts +2 -1
  12. package/dist-types/commands/DescribeEventsCommand.d.ts +2 -1
  13. package/dist-types/commands/DescribeEventsForOrganizationCommand.d.ts +2 -1
  14. package/dist-types/commands/DescribeHealthServiceStatusForOrganizationCommand.d.ts +2 -1
  15. package/dist-types/commands/DisableHealthServiceAccessForOrganizationCommand.d.ts +2 -1
  16. package/dist-types/commands/EnableHealthServiceAccessForOrganizationCommand.d.ts +2 -1
  17. package/dist-types/models/models_0.d.ts +185 -185
  18. package/dist-types/runtimeConfig.browser.d.ts +2 -2
  19. package/dist-types/runtimeConfig.d.ts +2 -2
  20. package/dist-types/runtimeConfig.native.d.ts +2 -2
  21. package/dist-types/runtimeConfig.shared.d.ts +2 -2
  22. package/dist-types/ts3.4/Health.d.ts +8 -0
  23. package/dist-types/ts3.4/commands/DescribeAffectedAccountsForOrganizationCommand.d.ts +9 -0
  24. package/dist-types/ts3.4/commands/DescribeAffectedEntitiesCommand.d.ts +9 -0
  25. package/dist-types/ts3.4/commands/DescribeAffectedEntitiesForOrganizationCommand.d.ts +9 -0
  26. package/dist-types/ts3.4/commands/DescribeEntityAggregatesCommand.d.ts +9 -0
  27. package/dist-types/ts3.4/commands/DescribeEntityAggregatesForOrganizationCommand.d.ts +9 -0
  28. package/dist-types/ts3.4/commands/DescribeEventAggregatesCommand.d.ts +9 -0
  29. package/dist-types/ts3.4/commands/DescribeEventDetailsCommand.d.ts +9 -0
  30. package/dist-types/ts3.4/commands/DescribeEventDetailsForOrganizationCommand.d.ts +9 -0
  31. package/dist-types/ts3.4/commands/DescribeEventTypesCommand.d.ts +9 -0
  32. package/dist-types/ts3.4/commands/DescribeEventsCommand.d.ts +9 -0
  33. package/dist-types/ts3.4/commands/DescribeEventsForOrganizationCommand.d.ts +9 -0
  34. package/dist-types/ts3.4/commands/DescribeHealthServiceStatusForOrganizationCommand.d.ts +9 -0
  35. package/dist-types/ts3.4/commands/DisableHealthServiceAccessForOrganizationCommand.d.ts +9 -0
  36. package/dist-types/ts3.4/commands/EnableHealthServiceAccessForOrganizationCommand.d.ts +9 -0
  37. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
  38. package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
  39. package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
  40. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
  41. package/package.json +40 -40
@@ -16,40 +16,39 @@ export declare const EntityStatusCode: {
16
16
  */
17
17
  export type EntityStatusCode = (typeof EntityStatusCode)[keyof typeof EntityStatusCode];
18
18
  /**
19
- * @public
20
19
  * <p>The number of entities in an account that are impacted by a specific event aggregated by the entity status codes.</p>
20
+ * @public
21
21
  */
22
22
  export interface AccountEntityAggregate {
23
23
  /**
24
- * @public
25
24
  * <p>The 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
25
+ * @public
26
26
  */
27
27
  accountId?: string;
28
28
  /**
29
- * @public
30
29
  * <p>The number of entities that match the filter criteria for the specified events.</p>
30
+ * @public
31
31
  */
32
32
  count?: number;
33
33
  /**
34
- * @public
35
34
  * <p>The number of affected entities aggregated by the entity status codes.</p>
35
+ * @public
36
36
  */
37
37
  statuses?: Partial<Record<EntityStatusCode, number>>;
38
38
  }
39
39
  /**
40
- * @public
41
40
  * <p>Information about an entity that is affected by a Health event.</p>
41
+ * @public
42
42
  */
43
43
  export interface AffectedEntity {
44
44
  /**
45
- * @public
46
45
  * <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>
47
46
  * </code>. Example: <code>arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K</code>
48
47
  * </p>
48
+ * @public
49
49
  */
50
50
  entityArn?: string;
51
51
  /**
52
- * @public
53
52
  * <p>The unique identifier for the event. The event ARN has the
54
53
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
55
54
  * </code>
@@ -58,40 +57,41 @@ export interface AffectedEntity {
58
57
  * <p>
59
58
  * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
60
59
  * </p>
60
+ * @public
61
61
  */
62
62
  eventArn?: string;
63
63
  /**
64
- * @public
65
64
  * <p>The ID of the affected entity.</p>
65
+ * @public
66
66
  */
67
67
  entityValue?: string;
68
68
  /**
69
- * @public
70
69
  * <p>The URL of the affected entity.</p>
70
+ * @public
71
71
  */
72
72
  entityUrl?: string;
73
73
  /**
74
- * @public
75
74
  * <p>The 12-digit Amazon Web Services account number that contains the affected entity.</p>
75
+ * @public
76
76
  */
77
77
  awsAccountId?: string;
78
78
  /**
79
- * @public
80
79
  * <p>The most recent time that the entity was updated.</p>
80
+ * @public
81
81
  */
82
82
  lastUpdatedTime?: Date;
83
83
  /**
84
- * @public
85
84
  * <p>The most recent status of the entity affected by the event. The possible values are
86
85
  * <code>IMPAIRED</code>, <code>UNIMPAIRED</code>, and <code>UNKNOWN</code>.</p>
86
+ * @public
87
87
  */
88
88
  statusCode?: EntityStatusCode;
89
89
  /**
90
- * @public
91
90
  * <p>A map of entity tags attached to the affected entity.</p>
92
91
  * <note>
93
92
  * <p>Currently, the <code>tags</code> property isn't supported.</p>
94
93
  * </note>
94
+ * @public
95
95
  */
96
96
  tags?: Record<string, string>;
97
97
  }
@@ -100,7 +100,6 @@ export interface AffectedEntity {
100
100
  */
101
101
  export interface DescribeAffectedAccountsForOrganizationRequest {
102
102
  /**
103
- * @public
104
103
  * <p>The unique identifier for the event. The event ARN has the
105
104
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
106
105
  * </code>
@@ -109,19 +108,20 @@ export interface DescribeAffectedAccountsForOrganizationRequest {
109
108
  * <p>
110
109
  * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
111
110
  * </p>
111
+ * @public
112
112
  */
113
113
  eventArn: string | undefined;
114
114
  /**
115
- * @public
116
115
  * <p>If the results of a search are large, only a portion of the
117
116
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
118
117
  * retrieve the next batch of results, reissue the search request and include the returned token.
119
118
  * When all results have been returned, the response does not contain a pagination token value.</p>
119
+ * @public
120
120
  */
121
121
  nextToken?: string;
122
122
  /**
123
- * @public
124
123
  * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
124
+ * @public
125
125
  */
126
126
  maxResults?: number;
127
127
  }
@@ -143,12 +143,11 @@ export type EventScopeCode = (typeof EventScopeCode)[keyof typeof EventScopeCode
143
143
  */
144
144
  export interface DescribeAffectedAccountsForOrganizationResponse {
145
145
  /**
146
- * @public
147
146
  * <p>A JSON set of elements of the affected accounts.</p>
147
+ * @public
148
148
  */
149
149
  affectedAccounts?: string[];
150
150
  /**
151
- * @public
152
151
  * <p>This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.</p>
153
152
  * <ul>
154
153
  * <li>
@@ -168,20 +167,21 @@ export interface DescribeAffectedAccountsForOrganizationResponse {
168
167
  * exist.</p>
169
168
  * </li>
170
169
  * </ul>
170
+ * @public
171
171
  */
172
172
  eventScopeCode?: EventScopeCode;
173
173
  /**
174
- * @public
175
174
  * <p>If the results of a search are large, only a portion of the
176
175
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
177
176
  * retrieve the next batch of results, reissue the search request and include the returned token.
178
177
  * When all results have been returned, the response does not contain a pagination token value.</p>
178
+ * @public
179
179
  */
180
180
  nextToken?: string;
181
181
  }
182
182
  /**
183
- * @public
184
183
  * <p>The specified pagination token (<code>nextToken</code>) is not valid.</p>
184
+ * @public
185
185
  */
186
186
  export declare class InvalidPaginationToken extends __BaseException {
187
187
  readonly name: "InvalidPaginationToken";
@@ -192,7 +192,6 @@ export declare class InvalidPaginationToken extends __BaseException {
192
192
  constructor(opts: __ExceptionOptionType<InvalidPaginationToken, __BaseException>);
193
193
  }
194
194
  /**
195
- * @public
196
195
  * <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:
197
196
  * match items where the timestamp (<code>startTime</code>, <code>endTime</code>, or
198
197
  * <code>lastUpdatedTime</code>) is between <code>from</code> and <code>to</code>
@@ -200,57 +199,58 @@ export declare class InvalidPaginationToken extends __BaseException {
200
199
  * the timestamp value is equal to or after <code>from</code>. If <code>from</code> is not set
201
200
  * and <code>to</code> is set: match items where the timestamp value is equal to or before
202
201
  * <code>to</code>.</p>
202
+ * @public
203
203
  */
204
204
  export interface DateTimeRange {
205
205
  /**
206
- * @public
207
206
  * <p>The starting date and time of a time range.</p>
207
+ * @public
208
208
  */
209
209
  from?: Date;
210
210
  /**
211
- * @public
212
211
  * <p>The ending date and time of a time range.</p>
212
+ * @public
213
213
  */
214
214
  to?: Date;
215
215
  }
216
216
  /**
217
- * @public
218
217
  * <p>The values to use to filter results from the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html">DescribeAffectedEntities</a> operation.</p>
218
+ * @public
219
219
  */
220
220
  export interface EntityFilter {
221
221
  /**
222
- * @public
223
222
  * <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>
224
223
  * </p>
224
+ * @public
225
225
  */
226
226
  eventArns: string[] | undefined;
227
227
  /**
228
- * @public
229
228
  * <p>A list of entity ARNs (unique identifiers).</p>
229
+ * @public
230
230
  */
231
231
  entityArns?: string[];
232
232
  /**
233
- * @public
234
233
  * <p>A list of IDs for affected entities.</p>
234
+ * @public
235
235
  */
236
236
  entityValues?: string[];
237
237
  /**
238
- * @public
239
238
  * <p>A list of the most recent dates and times that the entity was updated.</p>
239
+ * @public
240
240
  */
241
241
  lastUpdatedTimes?: DateTimeRange[];
242
242
  /**
243
- * @public
244
243
  * <p>A map of entity tags attached to the affected entity.</p>
245
244
  * <note>
246
245
  * <p>Currently, the <code>tags</code> property isn't supported.</p>
247
246
  * </note>
247
+ * @public
248
248
  */
249
249
  tags?: Record<string, string>[];
250
250
  /**
251
- * @public
252
251
  * <p>A list of entity status codes (<code>IMPAIRED</code>, <code>UNIMPAIRED</code>, or
253
252
  * <code>UNKNOWN</code>).</p>
253
+ * @public
254
254
  */
255
255
  statusCodes?: EntityStatusCode[];
256
256
  }
@@ -259,26 +259,26 @@ export interface EntityFilter {
259
259
  */
260
260
  export interface DescribeAffectedEntitiesRequest {
261
261
  /**
262
- * @public
263
262
  * <p>Values to narrow the results returned. At least one event ARN is required.</p>
263
+ * @public
264
264
  */
265
265
  filter: EntityFilter | undefined;
266
266
  /**
267
- * @public
268
267
  * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
268
+ * @public
269
269
  */
270
270
  locale?: string;
271
271
  /**
272
- * @public
273
272
  * <p>If the results of a search are large, only a portion of the
274
273
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
275
274
  * retrieve the next batch of results, reissue the search request and include the returned token.
276
275
  * When all results have been returned, the response does not contain a pagination token value.</p>
276
+ * @public
277
277
  */
278
278
  nextToken?: string;
279
279
  /**
280
- * @public
281
280
  * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
281
+ * @public
282
282
  */
283
283
  maxResults?: number;
284
284
  }
@@ -287,22 +287,22 @@ export interface DescribeAffectedEntitiesRequest {
287
287
  */
288
288
  export interface DescribeAffectedEntitiesResponse {
289
289
  /**
290
- * @public
291
290
  * <p>The entities that match the filter criteria.</p>
291
+ * @public
292
292
  */
293
293
  entities?: AffectedEntity[];
294
294
  /**
295
- * @public
296
295
  * <p>If the results of a search are large, only a portion of the
297
296
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
298
297
  * retrieve the next batch of results, reissue the search request and include the returned token.
299
298
  * When all results have been returned, the response does not contain a pagination token value.</p>
299
+ * @public
300
300
  */
301
301
  nextToken?: string;
302
302
  }
303
303
  /**
304
- * @public
305
304
  * <p>The specified locale is not supported.</p>
305
+ * @public
306
306
  */
307
307
  export declare class UnsupportedLocale extends __BaseException {
308
308
  readonly name: "UnsupportedLocale";
@@ -313,12 +313,11 @@ export declare class UnsupportedLocale extends __BaseException {
313
313
  constructor(opts: __ExceptionOptionType<UnsupportedLocale, __BaseException>);
314
314
  }
315
315
  /**
316
- * @public
317
316
  * <p>A JSON set of elements including the <code>awsAccountId</code>, <code>eventArn</code> and a set of <code>statusCodes</code>.</p>
317
+ * @public
318
318
  */
319
319
  export interface EntityAccountFilter {
320
320
  /**
321
- * @public
322
321
  * <p>The unique identifier for the event. The event ARN has the
323
322
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
324
323
  * </code>
@@ -327,26 +326,26 @@ export interface EntityAccountFilter {
327
326
  * <p>
328
327
  * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
329
328
  * </p>
329
+ * @public
330
330
  */
331
331
  eventArn: string | undefined;
332
332
  /**
333
- * @public
334
333
  * <p>The 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
334
+ * @public
335
335
  */
336
336
  awsAccountId?: string;
337
337
  /**
338
- * @public
339
338
  * <p>A list of entity status codes.</p>
339
+ * @public
340
340
  */
341
341
  statusCodes?: EntityStatusCode[];
342
342
  }
343
343
  /**
344
- * @public
345
344
  * <p>The values used to filter results from the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html">DescribeEventDetailsForOrganization</a> and <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html">DescribeAffectedEntitiesForOrganization</a> operations.</p>
345
+ * @public
346
346
  */
347
347
  export interface EventAccountFilter {
348
348
  /**
349
- * @public
350
349
  * <p>The unique identifier for the event. The event ARN has the
351
350
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
352
351
  * </code>
@@ -355,11 +354,12 @@ export interface EventAccountFilter {
355
354
  * <p>
356
355
  * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
357
356
  * </p>
357
+ * @public
358
358
  */
359
359
  eventArn: string | undefined;
360
360
  /**
361
- * @public
362
361
  * <p>The 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
362
+ * @public
363
363
  */
364
364
  awsAccountId?: string;
365
365
  }
@@ -368,50 +368,49 @@ export interface EventAccountFilter {
368
368
  */
369
369
  export interface DescribeAffectedEntitiesForOrganizationRequest {
370
370
  /**
371
- * @public
372
371
  * @deprecated
373
372
  *
374
373
  * <p>A JSON set of elements including the <code>awsAccountId</code> and the
375
374
  * <code>eventArn</code>.</p>
375
+ * @public
376
376
  */
377
377
  organizationEntityFilters?: EventAccountFilter[];
378
378
  /**
379
- * @public
380
379
  * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
380
+ * @public
381
381
  */
382
382
  locale?: string;
383
383
  /**
384
- * @public
385
384
  * <p>If the results of a search are large, only a portion of the
386
385
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
387
386
  * retrieve the next batch of results, reissue the search request and include the returned token.
388
387
  * When all results have been returned, the response does not contain a pagination token value.</p>
388
+ * @public
389
389
  */
390
390
  nextToken?: string;
391
391
  /**
392
- * @public
393
392
  * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
393
+ * @public
394
394
  */
395
395
  maxResults?: number;
396
396
  /**
397
- * @public
398
397
  * <p>A JSON set of elements including the <code>awsAccountId</code>, <code>eventArn</code> and a set of <code>statusCodes</code>.</p>
398
+ * @public
399
399
  */
400
400
  organizationEntityAccountFilters?: EntityAccountFilter[];
401
401
  }
402
402
  /**
403
- * @public
404
403
  * <p>Error information returned when a <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html">DescribeAffectedEntitiesForOrganization</a> operation can't find or process a
405
404
  * specific entity.</p>
405
+ * @public
406
406
  */
407
407
  export interface OrganizationAffectedEntitiesErrorItem {
408
408
  /**
409
- * @public
410
409
  * <p>The 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
410
+ * @public
411
411
  */
412
412
  awsAccountId?: string;
413
413
  /**
414
- * @public
415
414
  * <p>The unique identifier for the event. The event ARN has the
416
415
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
417
416
  * </code>
@@ -420,20 +419,21 @@ export interface OrganizationAffectedEntitiesErrorItem {
420
419
  * <p>
421
420
  * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
422
421
  * </p>
422
+ * @public
423
423
  */
424
424
  eventArn?: string;
425
425
  /**
426
- * @public
427
426
  * <p>The name of the error.</p>
427
+ * @public
428
428
  */
429
429
  errorName?: string;
430
430
  /**
431
- * @public
432
431
  * <p>A message that describes the error. Follow the error message and retry your request.</p>
433
432
  * <p>For example, the <code>InvalidAccountInputError</code> error message appears if
434
433
  * you call the <code>DescribeAffectedEntitiesForOrganization</code> operation and specify the
435
434
  * <code>AccountSpecific</code> value for the <code>EventScopeCode</code> parameter, but
436
435
  * don't specify an Amazon Web Services account.</p>
436
+ * @public
437
437
  */
438
438
  errorMessage?: string;
439
439
  }
@@ -442,24 +442,24 @@ export interface OrganizationAffectedEntitiesErrorItem {
442
442
  */
443
443
  export interface DescribeAffectedEntitiesForOrganizationResponse {
444
444
  /**
445
- * @public
446
445
  * <p>A JSON set of elements including the <code>awsAccountId</code> and its
447
446
  * <code>entityArn</code>, <code>entityValue</code> and its <code>entityArn</code>,
448
447
  * <code>lastUpdatedTime</code>, and <code>statusCode</code>.</p>
448
+ * @public
449
449
  */
450
450
  entities?: AffectedEntity[];
451
451
  /**
452
- * @public
453
452
  * <p>A JSON set of elements of the failed response, including the <code>awsAccountId</code>,
454
453
  * <code>errorMessage</code>, <code>errorName</code>, and <code>eventArn</code>.</p>
454
+ * @public
455
455
  */
456
456
  failedSet?: OrganizationAffectedEntitiesErrorItem[];
457
457
  /**
458
- * @public
459
458
  * <p>If the results of a search are large, only a portion of the
460
459
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
461
460
  * retrieve the next batch of results, reissue the search request and include the returned token.
462
461
  * When all results have been returned, the response does not contain a pagination token value.</p>
462
+ * @public
463
463
  */
464
464
  nextToken?: string;
465
465
  }
@@ -468,19 +468,18 @@ export interface DescribeAffectedEntitiesForOrganizationResponse {
468
468
  */
469
469
  export interface DescribeEntityAggregatesRequest {
470
470
  /**
471
- * @public
472
471
  * <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>
473
472
  * </p>
473
+ * @public
474
474
  */
475
475
  eventArns?: string[];
476
476
  }
477
477
  /**
478
- * @public
479
478
  * <p>The number of entities that are affected by one or more events. Returned by the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEntityAggregates.html">DescribeEntityAggregates</a> operation.</p>
479
+ * @public
480
480
  */
481
481
  export interface EntityAggregate {
482
482
  /**
483
- * @public
484
483
  * <p>The unique identifier for the event. The event ARN has the
485
484
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
486
485
  * </code>
@@ -489,16 +488,17 @@ export interface EntityAggregate {
489
488
  * <p>
490
489
  * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
491
490
  * </p>
491
+ * @public
492
492
  */
493
493
  eventArn?: string;
494
494
  /**
495
- * @public
496
495
  * <p>The number of entities that match the criteria for the specified events.</p>
496
+ * @public
497
497
  */
498
498
  count?: number;
499
499
  /**
500
- * @public
501
500
  * <p>The number of affected entities aggregated by the entity status codes.</p>
501
+ * @public
502
502
  */
503
503
  statuses?: Partial<Record<EntityStatusCode, number>>;
504
504
  }
@@ -507,8 +507,8 @@ export interface EntityAggregate {
507
507
  */
508
508
  export interface DescribeEntityAggregatesResponse {
509
509
  /**
510
- * @public
511
510
  * <p>The number of entities that are affected by each of the specified events.</p>
511
+ * @public
512
512
  */
513
513
  entityAggregates?: EntityAggregate[];
514
514
  }
@@ -517,43 +517,43 @@ export interface DescribeEntityAggregatesResponse {
517
517
  */
518
518
  export interface DescribeEntityAggregatesForOrganizationRequest {
519
519
  /**
520
- * @public
521
520
  * <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>
522
521
  * </p>
522
+ * @public
523
523
  */
524
524
  eventArns: string[] | undefined;
525
525
  /**
526
- * @public
527
526
  * <p>A list of 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
527
+ * @public
528
528
  */
529
529
  awsAccountIds?: string[];
530
530
  }
531
531
  /**
532
- * @public
533
532
  * <p>The aggregate results of entities affected by the specified event in your organization.
534
533
  * The results are aggregated by the entity status codes for the specified set of accountsIDs.</p>
534
+ * @public
535
535
  */
536
536
  export interface OrganizationEntityAggregate {
537
537
  /**
538
- * @public
539
538
  * <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>
540
539
  * </p>
540
+ * @public
541
541
  */
542
542
  eventArn?: string;
543
543
  /**
544
- * @public
545
544
  * <p>The number of entities for the organization that match the filter criteria for the specified events.</p>
545
+ * @public
546
546
  */
547
547
  count?: number;
548
548
  /**
549
- * @public
550
549
  * <p>The number of affected entities aggregated by the entitiy status codes.</p>
550
+ * @public
551
551
  */
552
552
  statuses?: Partial<Record<EntityStatusCode, number>>;
553
553
  /**
554
- * @public
555
554
  * <p>A list of entity aggregates for each of the specified accounts in your organization that are affected by
556
555
  * a specific event. If there are no <code>awsAccountIds</code> provided in the request, this field will be empty in the response.</p>
556
+ * @public
557
557
  */
558
558
  accounts?: AccountEntityAggregate[];
559
559
  }
@@ -562,8 +562,8 @@ export interface OrganizationEntityAggregate {
562
562
  */
563
563
  export interface DescribeEntityAggregatesForOrganizationResponse {
564
564
  /**
565
- * @public
566
565
  * <p>The list of entity aggregates for each of the specified accounts that are affected by each of the specified events.</p>
566
+ * @public
567
567
  */
568
568
  organizationEntityAggregates?: OrganizationEntityAggregate[];
569
569
  }
@@ -606,82 +606,82 @@ export declare const EventTypeCategory: {
606
606
  */
607
607
  export type EventTypeCategory = (typeof EventTypeCategory)[keyof typeof EventTypeCategory];
608
608
  /**
609
- * @public
610
609
  * <p>The values to use to filter results from the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html">DescribeEvents</a> and
611
610
  * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html">DescribeEventAggregates</a> operations.</p>
611
+ * @public
612
612
  */
613
613
  export interface EventFilter {
614
614
  /**
615
- * @public
616
615
  * <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>
617
616
  * </p>
617
+ * @public
618
618
  */
619
619
  eventArns?: string[];
620
620
  /**
621
- * @public
622
621
  * <p>A list of unique identifiers for event types. For example, <code>"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".</code>
623
622
  * </p>
623
+ * @public
624
624
  */
625
625
  eventTypeCodes?: string[];
626
626
  /**
627
- * @public
628
627
  * <p>The Amazon Web Services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
628
+ * @public
629
629
  */
630
630
  services?: string[];
631
631
  /**
632
- * @public
633
632
  * <p>A list of Amazon Web Services Regions.</p>
633
+ * @public
634
634
  */
635
635
  regions?: string[];
636
636
  /**
637
- * @public
638
637
  * <p>A list of Amazon Web Services Availability Zones.</p>
638
+ * @public
639
639
  */
640
640
  availabilityZones?: string[];
641
641
  /**
642
- * @public
643
642
  * <p>A list of dates and times that the event began.</p>
643
+ * @public
644
644
  */
645
645
  startTimes?: DateTimeRange[];
646
646
  /**
647
- * @public
648
647
  * <p>A list of dates and times that the event ended.</p>
648
+ * @public
649
649
  */
650
650
  endTimes?: DateTimeRange[];
651
651
  /**
652
- * @public
653
652
  * <p>A list of dates and times that the event was last updated.</p>
653
+ * @public
654
654
  */
655
655
  lastUpdatedTimes?: DateTimeRange[];
656
656
  /**
657
- * @public
658
657
  * <p>A list of entity ARNs (unique identifiers).</p>
658
+ * @public
659
659
  */
660
660
  entityArns?: string[];
661
661
  /**
662
- * @public
663
662
  * <p>A list of entity identifiers, such as EC2 instance IDs (<code>i-34ab692e</code>) or EBS
664
663
  * volumes (<code>vol-426ab23e</code>).</p>
664
+ * @public
665
665
  */
666
666
  entityValues?: string[];
667
667
  /**
668
- * @public
669
668
  * <p>A list of event type category codes. Possible values are
670
669
  * <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
671
670
  * the <code>investigation</code> value isn't supported at this time.</p>
671
+ * @public
672
672
  */
673
673
  eventTypeCategories?: EventTypeCategory[];
674
674
  /**
675
- * @public
676
675
  * <p>A map of entity tags attached to the affected entity.</p>
677
676
  * <note>
678
677
  * <p>Currently, the <code>tags</code> property isn't supported.</p>
679
678
  * </note>
679
+ * @public
680
680
  */
681
681
  tags?: Record<string, string>[];
682
682
  /**
683
- * @public
684
683
  * <p>A list of event status codes.</p>
684
+ * @public
685
685
  */
686
686
  eventStatusCodes?: EventStatusCode[];
687
687
  }
@@ -690,42 +690,42 @@ export interface EventFilter {
690
690
  */
691
691
  export interface DescribeEventAggregatesRequest {
692
692
  /**
693
- * @public
694
693
  * <p>Values to narrow the results returned.</p>
694
+ * @public
695
695
  */
696
696
  filter?: EventFilter;
697
697
  /**
698
- * @public
699
698
  * <p>The only currently supported value is <code>eventTypeCategory</code>.</p>
699
+ * @public
700
700
  */
701
701
  aggregateField: EventAggregateField | undefined;
702
702
  /**
703
- * @public
704
703
  * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
704
+ * @public
705
705
  */
706
706
  maxResults?: number;
707
707
  /**
708
- * @public
709
708
  * <p>If the results of a search are large, only a portion of the
710
709
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
711
710
  * retrieve the next batch of results, reissue the search request and include the returned token.
712
711
  * When all results have been returned, the response does not contain a pagination token value.</p>
712
+ * @public
713
713
  */
714
714
  nextToken?: string;
715
715
  }
716
716
  /**
717
- * @public
718
717
  * <p>The number of events of each issue type. Returned by the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html">DescribeEventAggregates</a> operation.</p>
718
+ * @public
719
719
  */
720
720
  export interface EventAggregate {
721
721
  /**
722
- * @public
723
722
  * <p>The issue type for the associated count.</p>
723
+ * @public
724
724
  */
725
725
  aggregateValue?: string;
726
726
  /**
727
- * @public
728
727
  * <p>The number of events of the associated issue type.</p>
728
+ * @public
729
729
  */
730
730
  count?: number;
731
731
  }
@@ -734,16 +734,16 @@ export interface EventAggregate {
734
734
  */
735
735
  export interface DescribeEventAggregatesResponse {
736
736
  /**
737
- * @public
738
737
  * <p>The number of events in each category that meet the optional filter criteria.</p>
738
+ * @public
739
739
  */
740
740
  eventAggregates?: EventAggregate[];
741
741
  /**
742
- * @public
743
742
  * <p>If the results of a search are large, only a portion of the
744
743
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
745
744
  * retrieve the next batch of results, reissue the search request and include the returned token.
746
745
  * When all results have been returned, the response does not contain a pagination token value.</p>
746
+ * @public
747
747
  */
748
748
  nextToken?: string;
749
749
  }
@@ -752,24 +752,23 @@ export interface DescribeEventAggregatesResponse {
752
752
  */
753
753
  export interface DescribeEventDetailsRequest {
754
754
  /**
755
- * @public
756
755
  * <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>
757
756
  * </p>
757
+ * @public
758
758
  */
759
759
  eventArns: string[] | undefined;
760
760
  /**
761
- * @public
762
761
  * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
762
+ * @public
763
763
  */
764
764
  locale?: string;
765
765
  }
766
766
  /**
767
- * @public
768
767
  * <p>Error information returned when a <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html">DescribeEventDetails</a> operation can't find a specified event.</p>
768
+ * @public
769
769
  */
770
770
  export interface EventDetailsErrorItem {
771
771
  /**
772
- * @public
773
772
  * <p>The unique identifier for the event. The event ARN has the
774
773
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
775
774
  * </code>
@@ -778,21 +777,21 @@ export interface EventDetailsErrorItem {
778
777
  * <p>
779
778
  * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
780
779
  * </p>
780
+ * @public
781
781
  */
782
782
  eventArn?: string;
783
783
  /**
784
- * @public
785
784
  * <p>The name of the error.</p>
785
+ * @public
786
786
  */
787
787
  errorName?: string;
788
788
  /**
789
- * @public
790
789
  * <p>A message that describes the error.</p>
790
+ * @public
791
791
  */
792
792
  errorMessage?: string;
793
793
  }
794
794
  /**
795
- * @public
796
795
  * <p>Summary information about an Health event.</p>
797
796
  * <p>Health events can be public or account-specific:</p>
798
797
  * <ul>
@@ -813,10 +812,10 @@ export interface EventDetailsErrorItem {
813
812
  * </ul>
814
813
  * <p>You can determine if an event is public or account-specific by using the
815
814
  * <code>eventScopeCode</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode">eventScopeCode</a>.</p>
815
+ * @public
816
816
  */
817
817
  export interface Event {
818
818
  /**
819
- * @public
820
819
  * <p>The unique identifier for the event. The event ARN has the
821
820
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
822
821
  * </code>
@@ -825,59 +824,59 @@ export interface Event {
825
824
  * <p>
826
825
  * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
827
826
  * </p>
827
+ * @public
828
828
  */
829
829
  arn?: string;
830
830
  /**
831
- * @public
832
831
  * <p>The Amazon Web Service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
832
+ * @public
833
833
  */
834
834
  service?: string;
835
835
  /**
836
- * @public
837
836
  * <p>The unique identifier for the event type. The format is <code>AWS_<i>SERVICE</i>_<i>DESCRIPTION</i>
838
837
  * </code>; for example, <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code>.</p>
838
+ * @public
839
839
  */
840
840
  eventTypeCode?: string;
841
841
  /**
842
- * @public
843
842
  * <p>A list of event type category codes. Possible values are
844
843
  * <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
845
844
  * the <code>investigation</code> value isn't supported at this time.</p>
845
+ * @public
846
846
  */
847
847
  eventTypeCategory?: EventTypeCategory;
848
848
  /**
849
- * @public
850
849
  * <p>The Amazon Web Services Region name of the event.</p>
850
+ * @public
851
851
  */
852
852
  region?: string;
853
853
  /**
854
- * @public
855
854
  * <p>The Amazon Web Services Availability Zone of the event. For example, us-east-1a.</p>
855
+ * @public
856
856
  */
857
857
  availabilityZone?: string;
858
858
  /**
859
- * @public
860
859
  * <p>The date and time that the event began.</p>
860
+ * @public
861
861
  */
862
862
  startTime?: Date;
863
863
  /**
864
- * @public
865
864
  * <p>The date and time that the event ended.</p>
865
+ * @public
866
866
  */
867
867
  endTime?: Date;
868
868
  /**
869
- * @public
870
869
  * <p>The most recent date and time that the event was updated.</p>
870
+ * @public
871
871
  */
872
872
  lastUpdatedTime?: Date;
873
873
  /**
874
- * @public
875
874
  * <p>The most recent status of the event. Possible values are <code>open</code>,
876
875
  * <code>closed</code>, and <code>upcoming</code>.</p>
876
+ * @public
877
877
  */
878
878
  statusCode?: EventStatusCode;
879
879
  /**
880
- * @public
881
880
  * <p>This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.</p>
882
881
  * <ul>
883
882
  * <li>
@@ -897,40 +896,41 @@ export interface Event {
897
896
  * exist.</p>
898
897
  * </li>
899
898
  * </ul>
899
+ * @public
900
900
  */
901
901
  eventScopeCode?: EventScopeCode;
902
902
  }
903
903
  /**
904
- * @public
905
904
  * <p>The detailed description of the event. Included in the information returned by the
906
905
  * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html">DescribeEventDetails</a> operation.</p>
906
+ * @public
907
907
  */
908
908
  export interface EventDescription {
909
909
  /**
910
- * @public
911
910
  * <p>The most recent description of the event.</p>
911
+ * @public
912
912
  */
913
913
  latestDescription?: string;
914
914
  }
915
915
  /**
916
- * @public
917
916
  * <p>Detailed information about an event. A combination of an <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a> object, an <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EventDescription.html">EventDescription</a> object, and additional metadata about the event. Returned by
918
917
  * the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html">DescribeEventDetails</a> operation.</p>
918
+ * @public
919
919
  */
920
920
  export interface EventDetails {
921
921
  /**
922
- * @public
923
922
  * <p>Summary information about the event.</p>
923
+ * @public
924
924
  */
925
925
  event?: Event;
926
926
  /**
927
- * @public
928
927
  * <p>The most recent description of the event.</p>
928
+ * @public
929
929
  */
930
930
  eventDescription?: EventDescription;
931
931
  /**
932
- * @public
933
932
  * <p>Additional metadata about the event.</p>
933
+ * @public
934
934
  */
935
935
  eventMetadata?: Record<string, string>;
936
936
  }
@@ -939,13 +939,13 @@ export interface EventDetails {
939
939
  */
940
940
  export interface DescribeEventDetailsResponse {
941
941
  /**
942
- * @public
943
942
  * <p>Information about the events that could be retrieved.</p>
943
+ * @public
944
944
  */
945
945
  successfulSet?: EventDetails[];
946
946
  /**
947
- * @public
948
947
  * <p>Error messages for any events that could not be retrieved.</p>
948
+ * @public
949
949
  */
950
950
  failedSet?: EventDetailsErrorItem[];
951
951
  }
@@ -954,31 +954,30 @@ export interface DescribeEventDetailsResponse {
954
954
  */
955
955
  export interface DescribeEventDetailsForOrganizationRequest {
956
956
  /**
957
- * @public
958
957
  * <p>A set of JSON elements that includes the <code>awsAccountId</code> and the
959
958
  * <code>eventArn</code>.</p>
959
+ * @public
960
960
  */
961
961
  organizationEventDetailFilters: EventAccountFilter[] | undefined;
962
962
  /**
963
- * @public
964
963
  * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
964
+ * @public
965
965
  */
966
966
  locale?: string;
967
967
  }
968
968
  /**
969
- * @public
970
969
  * <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
971
970
  * event.</p>
971
+ * @public
972
972
  */
973
973
  export interface OrganizationEventDetailsErrorItem {
974
974
  /**
975
- * @public
976
975
  * <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
977
976
  * event.</p>
977
+ * @public
978
978
  */
979
979
  awsAccountId?: string;
980
980
  /**
981
- * @public
982
981
  * <p>The unique identifier for the event. The event ARN has the
983
982
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
984
983
  * </code>
@@ -987,15 +986,15 @@ export interface OrganizationEventDetailsErrorItem {
987
986
  * <p>
988
987
  * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
989
988
  * </p>
989
+ * @public
990
990
  */
991
991
  eventArn?: string;
992
992
  /**
993
- * @public
994
993
  * <p>The name of the error.</p>
994
+ * @public
995
995
  */
996
996
  errorName?: string;
997
997
  /**
998
- * @public
999
998
  * <p>A message that describes the error.</p>
1000
999
  * <p>If you call the <code>DescribeEventDetailsForOrganization</code> operation and receive one of the following errors, follow the recommendations in the message:</p>
1001
1000
  * <ul>
@@ -1010,22 +1009,22 @@ export interface OrganizationEventDetailsErrorItem {
1010
1009
  * Health API. You must have either a Business, Enterprise On-Ramp, or Enterprise Support plan.</p>
1011
1010
  * </li>
1012
1011
  * </ul>
1012
+ * @public
1013
1013
  */
1014
1014
  errorMessage?: string;
1015
1015
  }
1016
1016
  /**
1017
- * @public
1018
1017
  * <p>Detailed information about an event. A combination of an <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a> object, an <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EventDescription.html">EventDescription</a> object, and additional metadata about the event. Returned by
1019
1018
  * the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html">DescribeEventDetailsForOrganization</a> operation.</p>
1019
+ * @public
1020
1020
  */
1021
1021
  export interface OrganizationEventDetails {
1022
1022
  /**
1023
- * @public
1024
1023
  * <p>The 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
1024
+ * @public
1025
1025
  */
1026
1026
  awsAccountId?: string;
1027
1027
  /**
1028
- * @public
1029
1028
  * <p>Summary information about an Health event.</p>
1030
1029
  * <p>Health events can be public or account-specific:</p>
1031
1030
  * <ul>
@@ -1046,17 +1045,18 @@ export interface OrganizationEventDetails {
1046
1045
  * </ul>
1047
1046
  * <p>You can determine if an event is public or account-specific by using the
1048
1047
  * <code>eventScopeCode</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode">eventScopeCode</a>.</p>
1048
+ * @public
1049
1049
  */
1050
1050
  event?: Event;
1051
1051
  /**
1052
- * @public
1053
1052
  * <p>The detailed description of the event. Included in the information returned by the
1054
1053
  * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html">DescribeEventDetails</a> operation.</p>
1054
+ * @public
1055
1055
  */
1056
1056
  eventDescription?: EventDescription;
1057
1057
  /**
1058
- * @public
1059
1058
  * <p>Additional metadata about the event.</p>
1059
+ * @public
1060
1060
  */
1061
1061
  eventMetadata?: Record<string, string>;
1062
1062
  }
@@ -1065,13 +1065,13 @@ export interface OrganizationEventDetails {
1065
1065
  */
1066
1066
  export interface DescribeEventDetailsForOrganizationResponse {
1067
1067
  /**
1068
- * @public
1069
1068
  * <p>Information about the events that could be retrieved.</p>
1069
+ * @public
1070
1070
  */
1071
1071
  successfulSet?: OrganizationEventDetails[];
1072
1072
  /**
1073
- * @public
1074
1073
  * <p>Error messages for any events that could not be retrieved.</p>
1074
+ * @public
1075
1075
  */
1076
1076
  failedSet?: OrganizationEventDetailsErrorItem[];
1077
1077
  }
@@ -1080,26 +1080,26 @@ export interface DescribeEventDetailsForOrganizationResponse {
1080
1080
  */
1081
1081
  export interface DescribeEventsRequest {
1082
1082
  /**
1083
- * @public
1084
1083
  * <p>Values to narrow the results returned.</p>
1084
+ * @public
1085
1085
  */
1086
1086
  filter?: EventFilter;
1087
1087
  /**
1088
- * @public
1089
1088
  * <p>If the results of a search are large, only a portion of the
1090
1089
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
1091
1090
  * retrieve the next batch of results, reissue the search request and include the returned token.
1092
1091
  * When all results have been returned, the response does not contain a pagination token value.</p>
1092
+ * @public
1093
1093
  */
1094
1094
  nextToken?: string;
1095
1095
  /**
1096
- * @public
1097
1096
  * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
1097
+ * @public
1098
1098
  */
1099
1099
  maxResults?: number;
1100
1100
  /**
1101
- * @public
1102
1101
  * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
1102
+ * @public
1103
1103
  */
1104
1104
  locale?: string;
1105
1105
  }
@@ -1108,47 +1108,46 @@ export interface DescribeEventsRequest {
1108
1108
  */
1109
1109
  export interface DescribeEventsResponse {
1110
1110
  /**
1111
- * @public
1112
1111
  * <p>The events that match the specified filter criteria.</p>
1112
+ * @public
1113
1113
  */
1114
1114
  events?: Event[];
1115
1115
  /**
1116
- * @public
1117
1116
  * <p>If the results of a search are large, only a portion of the
1118
1117
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
1119
1118
  * retrieve the next batch of results, reissue the search request and include the returned token.
1120
1119
  * When all results have been returned, the response does not contain a pagination token value.</p>
1120
+ * @public
1121
1121
  */
1122
1122
  nextToken?: string;
1123
1123
  }
1124
1124
  /**
1125
- * @public
1126
1125
  * <p>The values to filter results from the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html">DescribeEventsForOrganization</a> operation.</p>
1126
+ * @public
1127
1127
  */
1128
1128
  export interface OrganizationEventFilter {
1129
1129
  /**
1130
- * @public
1131
1130
  * <p>A list of unique identifiers for event types. For example, <code>"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".</code>
1132
1131
  * </p>
1132
+ * @public
1133
1133
  */
1134
1134
  eventTypeCodes?: string[];
1135
1135
  /**
1136
- * @public
1137
1136
  * <p>A list of 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
1137
+ * @public
1138
1138
  */
1139
1139
  awsAccountIds?: string[];
1140
1140
  /**
1141
- * @public
1142
1141
  * <p>The Amazon Web Services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1142
+ * @public
1143
1143
  */
1144
1144
  services?: string[];
1145
1145
  /**
1146
- * @public
1147
1146
  * <p>A list of Amazon Web Services Regions.</p>
1147
+ * @public
1148
1148
  */
1149
1149
  regions?: string[];
1150
1150
  /**
1151
- * @public
1152
1151
  * <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:
1153
1152
  * match items where the timestamp (<code>startTime</code>, <code>endTime</code>, or
1154
1153
  * <code>lastUpdatedTime</code>) is between <code>from</code> and <code>to</code>
@@ -1156,10 +1155,10 @@ export interface OrganizationEventFilter {
1156
1155
  * the timestamp value is equal to or after <code>from</code>. If <code>from</code> is not set
1157
1156
  * and <code>to</code> is set: match items where the timestamp value is equal to or before
1158
1157
  * <code>to</code>.</p>
1158
+ * @public
1159
1159
  */
1160
1160
  startTime?: DateTimeRange;
1161
1161
  /**
1162
- * @public
1163
1162
  * <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:
1164
1163
  * match items where the timestamp (<code>startTime</code>, <code>endTime</code>, or
1165
1164
  * <code>lastUpdatedTime</code>) is between <code>from</code> and <code>to</code>
@@ -1167,10 +1166,10 @@ export interface OrganizationEventFilter {
1167
1166
  * the timestamp value is equal to or after <code>from</code>. If <code>from</code> is not set
1168
1167
  * and <code>to</code> is set: match items where the timestamp value is equal to or before
1169
1168
  * <code>to</code>.</p>
1169
+ * @public
1170
1170
  */
1171
1171
  endTime?: DateTimeRange;
1172
1172
  /**
1173
- * @public
1174
1173
  * <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:
1175
1174
  * match items where the timestamp (<code>startTime</code>, <code>endTime</code>, or
1176
1175
  * <code>lastUpdatedTime</code>) is between <code>from</code> and <code>to</code>
@@ -1178,28 +1177,29 @@ export interface OrganizationEventFilter {
1178
1177
  * the timestamp value is equal to or after <code>from</code>. If <code>from</code> is not set
1179
1178
  * and <code>to</code> is set: match items where the timestamp value is equal to or before
1180
1179
  * <code>to</code>.</p>
1180
+ * @public
1181
1181
  */
1182
1182
  lastUpdatedTime?: DateTimeRange;
1183
1183
  /**
1184
- * @public
1185
1184
  * <p>A list of entity ARNs (unique identifiers).</p>
1185
+ * @public
1186
1186
  */
1187
1187
  entityArns?: string[];
1188
1188
  /**
1189
- * @public
1190
1189
  * <p>A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).</p>
1190
+ * @public
1191
1191
  */
1192
1192
  entityValues?: string[];
1193
1193
  /**
1194
- * @public
1195
1194
  * <p>A list of event type category codes. Possible values are
1196
1195
  * <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
1197
1196
  * the <code>investigation</code> value isn't supported at this time.</p>
1197
+ * @public
1198
1198
  */
1199
1199
  eventTypeCategories?: EventTypeCategory[];
1200
1200
  /**
1201
- * @public
1202
1201
  * <p>A list of event status codes.</p>
1202
+ * @public
1203
1203
  */
1204
1204
  eventStatusCodes?: EventStatusCode[];
1205
1205
  }
@@ -1208,36 +1208,35 @@ export interface OrganizationEventFilter {
1208
1208
  */
1209
1209
  export interface DescribeEventsForOrganizationRequest {
1210
1210
  /**
1211
- * @public
1212
1211
  * <p>Values to narrow the results returned.</p>
1212
+ * @public
1213
1213
  */
1214
1214
  filter?: OrganizationEventFilter;
1215
1215
  /**
1216
- * @public
1217
1216
  * <p>If the results of a search are large, only a portion of the
1218
1217
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
1219
1218
  * retrieve the next batch of results, reissue the search request and include the returned token.
1220
1219
  * When all results have been returned, the response does not contain a pagination token value.</p>
1220
+ * @public
1221
1221
  */
1222
1222
  nextToken?: string;
1223
1223
  /**
1224
- * @public
1225
1224
  * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
1225
+ * @public
1226
1226
  */
1227
1227
  maxResults?: number;
1228
1228
  /**
1229
- * @public
1230
1229
  * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
1230
+ * @public
1231
1231
  */
1232
1232
  locale?: string;
1233
1233
  }
1234
1234
  /**
1235
- * @public
1236
1235
  * <p>Summary information about an event, returned by the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html">DescribeEventsForOrganization</a> operation.</p>
1236
+ * @public
1237
1237
  */
1238
1238
  export interface OrganizationEvent {
1239
1239
  /**
1240
- * @public
1241
1240
  * <p>The unique identifier for the event. The event ARN has the
1242
1241
  * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
1243
1242
  * </code>
@@ -1246,29 +1245,29 @@ export interface OrganizationEvent {
1246
1245
  * <p>
1247
1246
  * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
1248
1247
  * </p>
1248
+ * @public
1249
1249
  */
1250
1250
  arn?: string;
1251
1251
  /**
1252
- * @public
1253
1252
  * <p>The Amazon Web Service that is affected by the event, such as EC2 and RDS.</p>
1253
+ * @public
1254
1254
  */
1255
1255
  service?: string;
1256
1256
  /**
1257
- * @public
1258
1257
  * <p>The unique identifier for the event type. The format is
1259
1258
  * <code>AWS_SERVICE_DESCRIPTION</code>. For example,
1260
1259
  * <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code>.</p>
1260
+ * @public
1261
1261
  */
1262
1262
  eventTypeCode?: string;
1263
1263
  /**
1264
- * @public
1265
1264
  * <p>A list of event type category codes. Possible values are
1266
1265
  * <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
1267
1266
  * the <code>investigation</code> value isn't supported at this time.</p>
1267
+ * @public
1268
1268
  */
1269
1269
  eventTypeCategory?: EventTypeCategory;
1270
1270
  /**
1271
- * @public
1272
1271
  * <p>This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.</p>
1273
1272
  * <ul>
1274
1273
  * <li>
@@ -1288,32 +1287,33 @@ export interface OrganizationEvent {
1288
1287
  * exist.</p>
1289
1288
  * </li>
1290
1289
  * </ul>
1290
+ * @public
1291
1291
  */
1292
1292
  eventScopeCode?: EventScopeCode;
1293
1293
  /**
1294
- * @public
1295
1294
  * <p>The Amazon Web Services Region name of the event.</p>
1295
+ * @public
1296
1296
  */
1297
1297
  region?: string;
1298
1298
  /**
1299
- * @public
1300
1299
  * <p>The date and time that the event began.</p>
1300
+ * @public
1301
1301
  */
1302
1302
  startTime?: Date;
1303
1303
  /**
1304
- * @public
1305
1304
  * <p>The date and time that the event ended.</p>
1305
+ * @public
1306
1306
  */
1307
1307
  endTime?: Date;
1308
1308
  /**
1309
- * @public
1310
1309
  * <p>The most recent date and time that the event was updated.</p>
1310
+ * @public
1311
1311
  */
1312
1312
  lastUpdatedTime?: Date;
1313
1313
  /**
1314
- * @public
1315
1314
  * <p>The most recent status of the event. Possible values are <code>open</code>,
1316
1315
  * <code>closed</code>, and <code>upcoming</code>.</p>
1316
+ * @public
1317
1317
  */
1318
1318
  statusCode?: EventStatusCode;
1319
1319
  }
@@ -1322,40 +1322,40 @@ export interface OrganizationEvent {
1322
1322
  */
1323
1323
  export interface DescribeEventsForOrganizationResponse {
1324
1324
  /**
1325
- * @public
1326
1325
  * <p>The events that match the specified filter criteria.</p>
1326
+ * @public
1327
1327
  */
1328
1328
  events?: OrganizationEvent[];
1329
1329
  /**
1330
- * @public
1331
1330
  * <p>If the results of a search are large, only a portion of the
1332
1331
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
1333
1332
  * retrieve the next batch of results, reissue the search request and include the returned token.
1334
1333
  * When all results have been returned, the response does not contain a pagination token value.</p>
1334
+ * @public
1335
1335
  */
1336
1336
  nextToken?: string;
1337
1337
  }
1338
1338
  /**
1339
- * @public
1340
1339
  * <p>The values to use to filter results from the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html">DescribeEventTypes</a>
1341
1340
  * operation.</p>
1341
+ * @public
1342
1342
  */
1343
1343
  export interface EventTypeFilter {
1344
1344
  /**
1345
- * @public
1346
1345
  * <p>A list of event type codes.</p>
1346
+ * @public
1347
1347
  */
1348
1348
  eventTypeCodes?: string[];
1349
1349
  /**
1350
- * @public
1351
1350
  * <p>The Amazon Web Services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1351
+ * @public
1352
1352
  */
1353
1353
  services?: string[];
1354
1354
  /**
1355
- * @public
1356
1355
  * <p>A list of event type category codes. Possible values are
1357
1356
  * <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
1358
1357
  * the <code>investigation</code> value isn't supported at this time.</p>
1358
+ * @public
1359
1359
  */
1360
1360
  eventTypeCategories?: EventTypeCategory[];
1361
1361
  }
@@ -1364,35 +1364,34 @@ export interface EventTypeFilter {
1364
1364
  */
1365
1365
  export interface DescribeEventTypesRequest {
1366
1366
  /**
1367
- * @public
1368
1367
  * <p>Values to narrow the results returned.</p>
1368
+ * @public
1369
1369
  */
1370
1370
  filter?: EventTypeFilter;
1371
1371
  /**
1372
- * @public
1373
1372
  * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
1373
+ * @public
1374
1374
  */
1375
1375
  locale?: string;
1376
1376
  /**
1377
- * @public
1378
1377
  * <p>If the results of a search are large, only a portion of the
1379
1378
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
1380
1379
  * retrieve the next batch of results, reissue the search request and include the returned token.
1381
1380
  * When all results have been returned, the response does not contain a pagination token value.</p>
1381
+ * @public
1382
1382
  */
1383
1383
  nextToken?: string;
1384
1384
  /**
1385
- * @public
1386
1385
  * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
1387
1386
  * <note>
1388
1387
  * <p>If you don't specify the <code>maxResults</code> parameter, this operation returns a
1389
1388
  * maximum of 30 items by default.</p>
1390
1389
  * </note>
1390
+ * @public
1391
1391
  */
1392
1392
  maxResults?: number;
1393
1393
  }
1394
1394
  /**
1395
- * @public
1396
1395
  * <p>Contains the metadata about a type of event that is reported by Health. The
1397
1396
  * <code>EventType</code> shows the category, service, and the event type code of the
1398
1397
  * event. For example, an <code>issue</code> might be the category, <code>EC2</code> the
@@ -1403,24 +1402,25 @@ export interface DescribeEventTypesRequest {
1403
1402
  * take action when Health delivers a specific event to your Amazon Web Services account. For more
1404
1403
  * information, see <a href="https://docs.aws.amazon.com/health/latest/ug/cloudwatch-events-health.html">Monitor for Health events with Amazon CloudWatch Events</a> in the
1405
1404
  * <i>Health User Guide</i>.</p>
1405
+ * @public
1406
1406
  */
1407
1407
  export interface EventType {
1408
1408
  /**
1409
- * @public
1410
1409
  * <p>The Amazon Web Service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1410
+ * @public
1411
1411
  */
1412
1412
  service?: string;
1413
1413
  /**
1414
- * @public
1415
1414
  * <p>The unique identifier for the event type. The format is <code>AWS_<i>SERVICE</i>_<i>DESCRIPTION</i>
1416
1415
  * </code>; for example, <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code>.</p>
1416
+ * @public
1417
1417
  */
1418
1418
  code?: string;
1419
1419
  /**
1420
- * @public
1421
1420
  * <p>A list of event type category codes. Possible values are
1422
1421
  * <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
1423
1422
  * the <code>investigation</code> value isn't supported at this time.</p>
1423
+ * @public
1424
1424
  */
1425
1425
  category?: EventTypeCategory;
1426
1426
  }
@@ -1429,7 +1429,6 @@ export interface EventType {
1429
1429
  */
1430
1430
  export interface DescribeEventTypesResponse {
1431
1431
  /**
1432
- * @public
1433
1432
  * <p>A list of event types that match the filter criteria. Event types have a category
1434
1433
  * (<code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>),
1435
1434
  * a service (for example, <code>EC2</code>, <code>RDS</code>, <code>DATAPIPELINE</code>,
@@ -1437,14 +1436,15 @@ export interface DescribeEventTypesResponse {
1437
1436
  * <code>AWS_<i>SERVICE</i>_<i>DESCRIPTION</i>
1438
1437
  * </code>; for
1439
1438
  * example, <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code>).</p>
1439
+ * @public
1440
1440
  */
1441
1441
  eventTypes?: EventType[];
1442
1442
  /**
1443
- * @public
1444
1443
  * <p>If the results of a search are large, only a portion of the
1445
1444
  * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
1446
1445
  * retrieve the next batch of results, reissue the search request and include the returned token.
1447
1446
  * When all results have been returned, the response does not contain a pagination token value.</p>
1447
+ * @public
1448
1448
  */
1449
1449
  nextToken?: string;
1450
1450
  }
@@ -1453,18 +1453,18 @@ export interface DescribeEventTypesResponse {
1453
1453
  */
1454
1454
  export interface DescribeHealthServiceStatusForOrganizationResponse {
1455
1455
  /**
1456
- * @public
1457
1456
  * <p>Information about the status of enabling or disabling the Health organizational
1458
1457
  * view feature in your organization.</p>
1459
1458
  * <p>Valid values are <code>ENABLED | DISABLED | PENDING</code>. </p>
1459
+ * @public
1460
1460
  */
1461
1461
  healthServiceAccessStatusForOrganization?: string;
1462
1462
  }
1463
1463
  /**
1464
- * @public
1465
1464
  * <p>
1466
1465
  * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a> is already in progress. Wait for the
1467
1466
  * action to complete before trying again. To get the current status, use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeHealthServiceStatusForOrganization.html">DescribeHealthServiceStatusForOrganization</a> operation.</p>
1467
+ * @public
1468
1468
  */
1469
1469
  export declare class ConcurrentModificationException extends __BaseException {
1470
1470
  readonly name: "ConcurrentModificationException";