@aws-sdk/client-health 3.36.0 → 3.39.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 (64) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/dist-cjs/Health.js +0 -52
  3. package/dist-cjs/HealthClient.js +0 -57
  4. package/dist-cjs/commands/DescribeAffectedAccountsForOrganizationCommand.js +0 -32
  5. package/dist-cjs/commands/DescribeAffectedEntitiesCommand.js +0 -42
  6. package/dist-cjs/commands/DescribeAffectedEntitiesForOrganizationCommand.js +0 -45
  7. package/dist-cjs/commands/DescribeEntityAggregatesCommand.js +0 -25
  8. package/dist-cjs/commands/DescribeEventAggregatesCommand.js +0 -29
  9. package/dist-cjs/commands/DescribeEventDetailsCommand.js +0 -33
  10. package/dist-cjs/commands/DescribeEventDetailsForOrganizationCommand.js +0 -56
  11. package/dist-cjs/commands/DescribeEventTypesCommand.js +0 -31
  12. package/dist-cjs/commands/DescribeEventsCommand.js +0 -46
  13. package/dist-cjs/commands/DescribeEventsForOrganizationCommand.js +0 -55
  14. package/dist-cjs/commands/DescribeHealthServiceStatusForOrganizationCommand.js +0 -27
  15. package/dist-cjs/commands/DisableHealthServiceAccessForOrganizationCommand.js +0 -38
  16. package/dist-cjs/commands/EnableHealthServiceAccessForOrganizationCommand.js +0 -46
  17. package/dist-cjs/commands/index.js +16 -0
  18. package/dist-cjs/endpoints.js +6 -1
  19. package/dist-cjs/index.js +4 -23
  20. package/dist-cjs/models/models_0.js +0 -126
  21. package/dist-cjs/pagination/DescribeAffectedAccountsForOrganizationPaginator.js +0 -10
  22. package/dist-cjs/pagination/DescribeAffectedEntitiesForOrganizationPaginator.js +0 -10
  23. package/dist-cjs/pagination/DescribeAffectedEntitiesPaginator.js +0 -10
  24. package/dist-cjs/pagination/DescribeEventAggregatesPaginator.js +0 -10
  25. package/dist-cjs/pagination/DescribeEventTypesPaginator.js +0 -10
  26. package/dist-cjs/pagination/DescribeEventsForOrganizationPaginator.js +0 -10
  27. package/dist-cjs/pagination/DescribeEventsPaginator.js +0 -10
  28. package/dist-cjs/pagination/index.js +11 -0
  29. package/dist-cjs/protocols/Aws_json1_1.js +0 -5
  30. package/dist-cjs/runtimeConfig.browser.js +1 -5
  31. package/dist-cjs/runtimeConfig.js +1 -5
  32. package/dist-cjs/runtimeConfig.native.js +0 -3
  33. package/dist-cjs/runtimeConfig.shared.js +0 -3
  34. package/dist-es/commands/index.js +13 -0
  35. package/dist-es/endpoints.js +6 -1
  36. package/dist-es/index.js +4 -23
  37. package/dist-es/pagination/index.js +8 -0
  38. package/dist-types/commands/index.d.ts +13 -0
  39. package/dist-types/index.d.ts +4 -23
  40. package/dist-types/pagination/index.d.ts +8 -0
  41. package/dist-types/ts3.4/Health.d.ts +14 -284
  42. package/dist-types/ts3.4/HealthClient.d.ts +24 -138
  43. package/dist-types/ts3.4/commands/DescribeAffectedAccountsForOrganizationCommand.d.ts +2 -28
  44. package/dist-types/ts3.4/commands/DescribeAffectedEntitiesCommand.d.ts +2 -38
  45. package/dist-types/ts3.4/commands/DescribeAffectedEntitiesForOrganizationCommand.d.ts +2 -41
  46. package/dist-types/ts3.4/commands/DescribeEntityAggregatesCommand.d.ts +2 -21
  47. package/dist-types/ts3.4/commands/DescribeEventAggregatesCommand.d.ts +2 -25
  48. package/dist-types/ts3.4/commands/DescribeEventDetailsCommand.d.ts +2 -29
  49. package/dist-types/ts3.4/commands/DescribeEventDetailsForOrganizationCommand.d.ts +2 -52
  50. package/dist-types/ts3.4/commands/DescribeEventTypesCommand.d.ts +2 -27
  51. package/dist-types/ts3.4/commands/DescribeEventsCommand.d.ts +2 -42
  52. package/dist-types/ts3.4/commands/DescribeEventsForOrganizationCommand.d.ts +2 -51
  53. package/dist-types/ts3.4/commands/DescribeHealthServiceStatusForOrganizationCommand.d.ts +2 -23
  54. package/dist-types/ts3.4/commands/DisableHealthServiceAccessForOrganizationCommand.d.ts +2 -34
  55. package/dist-types/ts3.4/commands/EnableHealthServiceAccessForOrganizationCommand.d.ts +2 -42
  56. package/dist-types/ts3.4/commands/index.d.ts +13 -0
  57. package/dist-types/ts3.4/index.d.ts +4 -23
  58. package/dist-types/ts3.4/models/models_0.d.ts +209 -927
  59. package/dist-types/ts3.4/pagination/index.d.ts +8 -0
  60. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  61. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  62. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  63. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  64. package/package.json +32 -32
@@ -4,92 +4,41 @@ export declare enum EntityStatusCode {
4
4
  UNIMPAIRED = "UNIMPAIRED",
5
5
  UNKNOWN = "UNKNOWN"
6
6
  }
7
- /**
8
- * <p>Information about an entity that is affected by a Health event.</p>
9
- */
7
+
10
8
  export interface AffectedEntity {
11
- /**
12
- * <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>
13
- * </code>. Example: <code>arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K</code>
14
- * </p>
15
- */
9
+
16
10
  entityArn?: string;
17
- /**
18
- * <p>The unique identifier for the event. The event ARN has the
19
- * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
20
- * </code>
21
- * format.</p>
22
- * <p>For example, an event ARN might look like the following:</p>
23
- * <p>
24
- * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
25
- * </p>
26
- */
11
+
27
12
  eventArn?: string;
28
- /**
29
- * <p>The ID of the affected entity.</p>
30
- */
13
+
31
14
  entityValue?: string;
32
- /**
33
- * <p>The URL of the affected entity.</p>
34
- */
15
+
35
16
  entityUrl?: string;
36
- /**
37
- * <p>The 12-digit AWS account number that contains the affected entity.</p>
38
- */
17
+
39
18
  awsAccountId?: string;
40
- /**
41
- * <p>The most recent time that the entity was updated.</p>
42
- */
19
+
43
20
  lastUpdatedTime?: Date;
44
- /**
45
- * <p>The most recent status of the entity affected by the event. The possible values are
46
- * <code>IMPAIRED</code>, <code>UNIMPAIRED</code>, and <code>UNKNOWN</code>.</p>
47
- */
21
+
48
22
  statusCode?: EntityStatusCode | string;
49
- /**
50
- * <p>A map of entity tags attached to the affected entity.</p>
51
- * <note>
52
- * <p>Currently, the <code>tags</code> property isn't supported.</p>
53
- * </note>
54
- */
23
+
55
24
  tags?: {
56
25
  [key: string]: string;
57
26
  };
58
27
  }
59
28
  export declare namespace AffectedEntity {
60
- /**
61
- * @internal
62
- */
29
+
63
30
  const filterSensitiveLog: (obj: AffectedEntity) => any;
64
31
  }
65
32
  export interface DescribeAffectedAccountsForOrganizationRequest {
66
- /**
67
- * <p>The unique identifier for the event. The event ARN has the
68
- * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
69
- * </code>
70
- * format.</p>
71
- * <p>For example, an event ARN might look like the following:</p>
72
- * <p>
73
- * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
74
- * </p>
75
- */
33
+
76
34
  eventArn: string | undefined;
77
- /**
78
- * <p>If the results of a search are large, only a portion of the
79
- * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
80
- * retrieve the next batch of results, reissue the search request and include the returned token.
81
- * When all results have been returned, the response does not contain a pagination token value.</p>
82
- */
35
+
83
36
  nextToken?: string;
84
- /**
85
- * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
86
- */
37
+
87
38
  maxResults?: number;
88
39
  }
89
40
  export declare namespace DescribeAffectedAccountsForOrganizationRequest {
90
- /**
91
- * @internal
92
- */
41
+
93
42
  const filterSensitiveLog: (obj: DescribeAffectedAccountsForOrganizationRequest) => any;
94
43
  }
95
44
  export declare enum EventScopeCode {
@@ -98,354 +47,170 @@ export declare enum EventScopeCode {
98
47
  PUBLIC = "PUBLIC"
99
48
  }
100
49
  export interface DescribeAffectedAccountsForOrganizationResponse {
101
- /**
102
- * <p>A JSON set of elements of the affected accounts.</p>
103
- */
50
+
104
51
  affectedAccounts?: string[];
105
- /**
106
- * <p>This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event.</p>
107
- * <ul>
108
- * <li>
109
- * <p>If the <code>eventScopeCode</code> value is <code>PUBLIC</code>, then the
110
- * <code>affectedAccounts</code> value is always empty.</p>
111
- * </li>
112
- * <li>
113
- * <p>If the <code>eventScopeCode</code> value is <code>ACCOUNT_SPECIFIC</code>, then
114
- * the <code>affectedAccounts</code> value lists the affected AWS accounts in your
115
- * organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you
116
- * have AWS accounts that use that service, those account IDs appear in the
117
- * response.</p>
118
- * </li>
119
- * <li>
120
- * <p>If the <code>eventScopeCode</code> value is <code>NONE</code>, then the
121
- * <code>eventArn</code> that you specified in the request is invalid or doesn't
122
- * exist.</p>
123
- * </li>
124
- * </ul>
125
- */
52
+
126
53
  eventScopeCode?: EventScopeCode | string;
127
- /**
128
- * <p>If the results of a search are large, only a portion of the
129
- * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
130
- * retrieve the next batch of results, reissue the search request and include the returned token.
131
- * When all results have been returned, the response does not contain a pagination token value.</p>
132
- */
54
+
133
55
  nextToken?: string;
134
56
  }
135
57
  export declare namespace DescribeAffectedAccountsForOrganizationResponse {
136
- /**
137
- * @internal
138
- */
58
+
139
59
  const filterSensitiveLog: (obj: DescribeAffectedAccountsForOrganizationResponse) => any;
140
60
  }
141
- /**
142
- * <p>The specified pagination token (<code>nextToken</code>) is not valid.</p>
143
- */
61
+
144
62
  export interface InvalidPaginationToken extends __SmithyException, $MetadataBearer {
145
63
  name: "InvalidPaginationToken";
146
64
  $fault: "client";
147
65
  message?: string;
148
66
  }
149
67
  export declare namespace InvalidPaginationToken {
150
- /**
151
- * @internal
152
- */
68
+
153
69
  const filterSensitiveLog: (obj: InvalidPaginationToken) => any;
154
70
  }
155
- /**
156
- * <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:
157
- * match items where the timestamp (<code>startTime</code>, <code>endTime</code>, or
158
- * <code>lastUpdatedTime</code>) is between <code>from</code> and <code>to</code>
159
- * inclusive. If <code>from</code> is set and <code>to</code> is not set: match items where
160
- * the timestamp value is equal to or after <code>from</code>. If <code>from</code> is not set
161
- * and <code>to</code> is set: match items where the timestamp value is equal to or before
162
- * <code>to</code>.</p>
163
- */
71
+
164
72
  export interface DateTimeRange {
165
- /**
166
- * <p>The starting date and time of a time range.</p>
167
- */
73
+
168
74
  from?: Date;
169
- /**
170
- * <p>The ending date and time of a time range.</p>
171
- */
75
+
172
76
  to?: Date;
173
77
  }
174
78
  export declare namespace DateTimeRange {
175
- /**
176
- * @internal
177
- */
79
+
178
80
  const filterSensitiveLog: (obj: DateTimeRange) => any;
179
81
  }
180
- /**
181
- * <p>The values to use to filter results from the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html">EntityFilter</a>
182
- * operation.</p>
183
- */
82
+
184
83
  export interface EntityFilter {
185
- /**
186
- * <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>
187
- * </p>
188
- */
84
+
189
85
  eventArns: string[] | undefined;
190
- /**
191
- * <p>A list of entity ARNs (unique identifiers).</p>
192
- */
86
+
193
87
  entityArns?: string[];
194
- /**
195
- * <p>A list of IDs for affected entities.</p>
196
- */
88
+
197
89
  entityValues?: string[];
198
- /**
199
- * <p>A list of the most recent dates and times that the entity was updated.</p>
200
- */
90
+
201
91
  lastUpdatedTimes?: DateTimeRange[];
202
- /**
203
- * <p>A map of entity tags attached to the affected entity.</p>
204
- * <note>
205
- * <p>Currently, the <code>tags</code> property isn't supported.</p>
206
- * </note>
207
- */
92
+
208
93
  tags?: {
209
94
  [key: string]: string;
210
95
  }[];
211
- /**
212
- * <p>A list of entity status codes (<code>IMPAIRED</code>, <code>UNIMPAIRED</code>, or
213
- * <code>UNKNOWN</code>).</p>
214
- */
96
+
215
97
  statusCodes?: (EntityStatusCode | string)[];
216
98
  }
217
99
  export declare namespace EntityFilter {
218
- /**
219
- * @internal
220
- */
100
+
221
101
  const filterSensitiveLog: (obj: EntityFilter) => any;
222
102
  }
223
103
  export interface DescribeAffectedEntitiesRequest {
224
- /**
225
- * <p>Values to narrow the results returned. At least one event ARN is required.</p>
226
- */
104
+
227
105
  filter: EntityFilter | undefined;
228
- /**
229
- * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
230
- */
106
+
231
107
  locale?: string;
232
- /**
233
- * <p>If the results of a search are large, only a portion of the
234
- * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
235
- * retrieve the next batch of results, reissue the search request and include the returned token.
236
- * When all results have been returned, the response does not contain a pagination token value.</p>
237
- */
108
+
238
109
  nextToken?: string;
239
- /**
240
- * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
241
- */
110
+
242
111
  maxResults?: number;
243
112
  }
244
113
  export declare namespace DescribeAffectedEntitiesRequest {
245
- /**
246
- * @internal
247
- */
114
+
248
115
  const filterSensitiveLog: (obj: DescribeAffectedEntitiesRequest) => any;
249
116
  }
250
117
  export interface DescribeAffectedEntitiesResponse {
251
- /**
252
- * <p>The entities that match the filter criteria.</p>
253
- */
118
+
254
119
  entities?: AffectedEntity[];
255
- /**
256
- * <p>If the results of a search are large, only a portion of the
257
- * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
258
- * retrieve the next batch of results, reissue the search request and include the returned token.
259
- * When all results have been returned, the response does not contain a pagination token value.</p>
260
- */
120
+
261
121
  nextToken?: string;
262
122
  }
263
123
  export declare namespace DescribeAffectedEntitiesResponse {
264
- /**
265
- * @internal
266
- */
124
+
267
125
  const filterSensitiveLog: (obj: DescribeAffectedEntitiesResponse) => any;
268
126
  }
269
- /**
270
- * <p>The specified locale is not supported.</p>
271
- */
127
+
272
128
  export interface UnsupportedLocale extends __SmithyException, $MetadataBearer {
273
129
  name: "UnsupportedLocale";
274
130
  $fault: "client";
275
131
  message?: string;
276
132
  }
277
133
  export declare namespace UnsupportedLocale {
278
- /**
279
- * @internal
280
- */
134
+
281
135
  const filterSensitiveLog: (obj: UnsupportedLocale) => any;
282
136
  }
283
- /**
284
- * <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>
285
- */
137
+
286
138
  export interface EventAccountFilter {
287
- /**
288
- * <p>The unique identifier for the event. The event ARN has the
289
- * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
290
- * </code>
291
- * format.</p>
292
- * <p>For example, an event ARN might look like the following:</p>
293
- * <p>
294
- * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
295
- * </p>
296
- */
139
+
297
140
  eventArn: string | undefined;
298
- /**
299
- * <p>The 12-digit AWS account numbers that contains the affected entities.</p>
300
- */
141
+
301
142
  awsAccountId?: string;
302
143
  }
303
144
  export declare namespace EventAccountFilter {
304
- /**
305
- * @internal
306
- */
145
+
307
146
  const filterSensitiveLog: (obj: EventAccountFilter) => any;
308
147
  }
309
148
  export interface DescribeAffectedEntitiesForOrganizationRequest {
310
- /**
311
- * <p>A JSON set of elements including the <code>awsAccountId</code> and the
312
- * <code>eventArn</code>.</p>
313
- */
149
+
314
150
  organizationEntityFilters: EventAccountFilter[] | undefined;
315
- /**
316
- * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
317
- */
151
+
318
152
  locale?: string;
319
- /**
320
- * <p>If the results of a search are large, only a portion of the
321
- * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
322
- * retrieve the next batch of results, reissue the search request and include the returned token.
323
- * When all results have been returned, the response does not contain a pagination token value.</p>
324
- */
153
+
325
154
  nextToken?: string;
326
- /**
327
- * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
328
- */
155
+
329
156
  maxResults?: number;
330
157
  }
331
158
  export declare namespace DescribeAffectedEntitiesForOrganizationRequest {
332
- /**
333
- * @internal
334
- */
159
+
335
160
  const filterSensitiveLog: (obj: DescribeAffectedEntitiesForOrganizationRequest) => any;
336
161
  }
337
- /**
338
- * <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
339
- * specific entity.</p>
340
- */
162
+
341
163
  export interface OrganizationAffectedEntitiesErrorItem {
342
- /**
343
- * <p>The 12-digit AWS account numbers that contains the affected entities.</p>
344
- */
164
+
345
165
  awsAccountId?: string;
346
- /**
347
- * <p>The unique identifier for the event. The event ARN has the
348
- * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
349
- * </code>
350
- * format.</p>
351
- * <p>For example, an event ARN might look like the following:</p>
352
- * <p>
353
- * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
354
- * </p>
355
- */
166
+
356
167
  eventArn?: string;
357
- /**
358
- * <p>The name of the error.</p>
359
- */
168
+
360
169
  errorName?: string;
361
- /**
362
- * <p>The unique identifier for the event type. The format is
363
- * <code>AWS_SERVICE_DESCRIPTION</code>. For example,
364
- * <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code>.</p>
365
- */
170
+
366
171
  errorMessage?: string;
367
172
  }
368
173
  export declare namespace OrganizationAffectedEntitiesErrorItem {
369
- /**
370
- * @internal
371
- */
174
+
372
175
  const filterSensitiveLog: (obj: OrganizationAffectedEntitiesErrorItem) => any;
373
176
  }
374
177
  export interface DescribeAffectedEntitiesForOrganizationResponse {
375
- /**
376
- * <p>A JSON set of elements including the <code>awsAccountId</code> and its
377
- * <code>entityArn</code>, <code>entityValue</code> and its <code>entityArn</code>,
378
- * <code>lastUpdatedTime</code>, and <code>statusCode</code>.</p>
379
- */
178
+
380
179
  entities?: AffectedEntity[];
381
- /**
382
- * <p>A JSON set of elements of the failed response, including the <code>awsAccountId</code>,
383
- * <code>errorMessage</code>, <code>errorName</code>, and <code>eventArn</code>.</p>
384
- */
180
+
385
181
  failedSet?: OrganizationAffectedEntitiesErrorItem[];
386
- /**
387
- * <p>If the results of a search are large, only a portion of the
388
- * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
389
- * retrieve the next batch of results, reissue the search request and include the returned token.
390
- * When all results have been returned, the response does not contain a pagination token value.</p>
391
- */
182
+
392
183
  nextToken?: string;
393
184
  }
394
185
  export declare namespace DescribeAffectedEntitiesForOrganizationResponse {
395
- /**
396
- * @internal
397
- */
186
+
398
187
  const filterSensitiveLog: (obj: DescribeAffectedEntitiesForOrganizationResponse) => any;
399
188
  }
400
189
  export interface DescribeEntityAggregatesRequest {
401
- /**
402
- * <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>
403
- * </p>
404
- */
190
+
405
191
  eventArns?: string[];
406
192
  }
407
193
  export declare namespace DescribeEntityAggregatesRequest {
408
- /**
409
- * @internal
410
- */
194
+
411
195
  const filterSensitiveLog: (obj: DescribeEntityAggregatesRequest) => any;
412
196
  }
413
- /**
414
- * <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>
415
- */
197
+
416
198
  export interface EntityAggregate {
417
- /**
418
- * <p>The unique identifier for the event. The event ARN has the
419
- * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
420
- * </code>
421
- * format.</p>
422
- * <p>For example, an event ARN might look like the following:</p>
423
- * <p>
424
- * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
425
- * </p>
426
- */
199
+
427
200
  eventArn?: string;
428
- /**
429
- * <p>The number of entities that match the criteria for the specified events.</p>
430
- */
201
+
431
202
  count?: number;
432
203
  }
433
204
  export declare namespace EntityAggregate {
434
- /**
435
- * @internal
436
- */
205
+
437
206
  const filterSensitiveLog: (obj: EntityAggregate) => any;
438
207
  }
439
208
  export interface DescribeEntityAggregatesResponse {
440
- /**
441
- * <p>The number of entities that are affected by each of the specified events.</p>
442
- */
209
+
443
210
  entityAggregates?: EntityAggregate[];
444
211
  }
445
212
  export declare namespace DescribeEntityAggregatesResponse {
446
- /**
447
- * @internal
448
- */
213
+
449
214
  const filterSensitiveLog: (obj: DescribeEntityAggregatesResponse) => any;
450
215
  }
451
216
  export declare enum EventAggregateField {
@@ -462,866 +227,383 @@ export declare enum EventTypeCategory {
462
227
  ISSUE = "issue",
463
228
  SCHEDULED_CHANGE = "scheduledChange"
464
229
  }
465
- /**
466
- * <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
467
- * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html">DescribeEventAggregates</a> operations.</p>
468
- */
230
+
469
231
  export interface EventFilter {
470
- /**
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>
472
- * </p>
473
- */
232
+
474
233
  eventArns?: string[];
475
- /**
476
- * <p>A list of unique identifiers for event types. For example, <code>"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".</code>
477
- * </p>
478
- */
234
+
479
235
  eventTypeCodes?: string[];
480
- /**
481
- * <p>The AWS services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
482
- */
236
+
483
237
  services?: string[];
484
- /**
485
- * <p>A list of AWS Regions.</p>
486
- */
238
+
487
239
  regions?: string[];
488
- /**
489
- * <p>A list of AWS Availability Zones.</p>
490
- */
240
+
491
241
  availabilityZones?: string[];
492
- /**
493
- * <p>A list of dates and times that the event began.</p>
494
- */
242
+
495
243
  startTimes?: DateTimeRange[];
496
- /**
497
- * <p>A list of dates and times that the event ended.</p>
498
- */
244
+
499
245
  endTimes?: DateTimeRange[];
500
- /**
501
- * <p>A list of dates and times that the event was last updated.</p>
502
- */
246
+
503
247
  lastUpdatedTimes?: DateTimeRange[];
504
- /**
505
- * <p>A list of entity ARNs (unique identifiers).</p>
506
- */
248
+
507
249
  entityArns?: string[];
508
- /**
509
- * <p>A list of entity identifiers, such as EC2 instance IDs (<code>i-34ab692e</code>) or EBS
510
- * volumes (<code>vol-426ab23e</code>).</p>
511
- */
250
+
512
251
  entityValues?: string[];
513
- /**
514
- * <p>A list of event type category codes (<code>issue</code>, <code>scheduledChange</code>,
515
- * or <code>accountNotification</code>).</p>
516
- */
252
+
517
253
  eventTypeCategories?: (EventTypeCategory | string)[];
518
- /**
519
- * <p>A map of entity tags attached to the affected entity.</p>
520
- * <note>
521
- * <p>Currently, the <code>tags</code> property isn't supported.</p>
522
- * </note>
523
- */
254
+
524
255
  tags?: {
525
256
  [key: string]: string;
526
257
  }[];
527
- /**
528
- * <p>A list of event status codes.</p>
529
- */
258
+
530
259
  eventStatusCodes?: (EventStatusCode | string)[];
531
260
  }
532
261
  export declare namespace EventFilter {
533
- /**
534
- * @internal
535
- */
262
+
536
263
  const filterSensitiveLog: (obj: EventFilter) => any;
537
264
  }
538
265
  export interface DescribeEventAggregatesRequest {
539
- /**
540
- * <p>Values to narrow the results returned.</p>
541
- */
266
+
542
267
  filter?: EventFilter;
543
- /**
544
- * <p>The only currently supported value is <code>eventTypeCategory</code>.</p>
545
- */
268
+
546
269
  aggregateField: EventAggregateField | string | undefined;
547
- /**
548
- * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
549
- */
270
+
550
271
  maxResults?: number;
551
- /**
552
- * <p>If the results of a search are large, only a portion of the
553
- * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
554
- * retrieve the next batch of results, reissue the search request and include the returned token.
555
- * When all results have been returned, the response does not contain a pagination token value.</p>
556
- */
272
+
557
273
  nextToken?: string;
558
274
  }
559
275
  export declare namespace DescribeEventAggregatesRequest {
560
- /**
561
- * @internal
562
- */
276
+
563
277
  const filterSensitiveLog: (obj: DescribeEventAggregatesRequest) => any;
564
278
  }
565
- /**
566
- * <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>
567
- */
279
+
568
280
  export interface EventAggregate {
569
- /**
570
- * <p>The issue type for the associated count.</p>
571
- */
281
+
572
282
  aggregateValue?: string;
573
- /**
574
- * <p>The number of events of the associated issue type.</p>
575
- */
283
+
576
284
  count?: number;
577
285
  }
578
286
  export declare namespace EventAggregate {
579
- /**
580
- * @internal
581
- */
287
+
582
288
  const filterSensitiveLog: (obj: EventAggregate) => any;
583
289
  }
584
290
  export interface DescribeEventAggregatesResponse {
585
- /**
586
- * <p>The number of events in each category that meet the optional filter criteria.</p>
587
- */
291
+
588
292
  eventAggregates?: EventAggregate[];
589
- /**
590
- * <p>If the results of a search are large, only a portion of the
591
- * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
592
- * retrieve the next batch of results, reissue the search request and include the returned token.
593
- * When all results have been returned, the response does not contain a pagination token value.</p>
594
- */
293
+
595
294
  nextToken?: string;
596
295
  }
597
296
  export declare namespace DescribeEventAggregatesResponse {
598
- /**
599
- * @internal
600
- */
297
+
601
298
  const filterSensitiveLog: (obj: DescribeEventAggregatesResponse) => any;
602
299
  }
603
300
  export interface DescribeEventDetailsRequest {
604
- /**
605
- * <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>
606
- * </p>
607
- */
301
+
608
302
  eventArns: string[] | undefined;
609
- /**
610
- * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
611
- */
303
+
612
304
  locale?: string;
613
305
  }
614
306
  export declare namespace DescribeEventDetailsRequest {
615
- /**
616
- * @internal
617
- */
307
+
618
308
  const filterSensitiveLog: (obj: DescribeEventDetailsRequest) => any;
619
309
  }
620
- /**
621
- * <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>
622
- */
310
+
623
311
  export interface EventDetailsErrorItem {
624
- /**
625
- * <p>The unique identifier for the event. The event ARN has the
626
- * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
627
- * </code>
628
- * format.</p>
629
- * <p>For example, an event ARN might look like the following:</p>
630
- * <p>
631
- * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
632
- * </p>
633
- */
312
+
634
313
  eventArn?: string;
635
- /**
636
- * <p>The name of the error.</p>
637
- */
314
+
638
315
  errorName?: string;
639
- /**
640
- * <p>A message that describes the error.</p>
641
- */
316
+
642
317
  errorMessage?: string;
643
318
  }
644
319
  export declare namespace EventDetailsErrorItem {
645
- /**
646
- * @internal
647
- */
320
+
648
321
  const filterSensitiveLog: (obj: EventDetailsErrorItem) => any;
649
322
  }
650
- /**
651
- * <p>Summary information about an AWS Health event.</p>
652
- * <p>AWS Health events can be public or account-specific:</p>
653
- * <ul>
654
- * <li>
655
- * <p>
656
- * <i>Public events</i> might be service events that are not specific
657
- * to an AWS account. For example, if there is an issue with an AWS Region,
658
- * AWS Health provides information about the event, even if you don't use services or
659
- * resources in that Region.</p>
660
- * </li>
661
- * <li>
662
- * <p>
663
- * <i>Account-specific</i> events are specific to either your AWS
664
- * account or an account in your organization. For example, if there's an issue with
665
- * Amazon Elastic Compute Cloud in a Region that you use, AWS Health provides information about the event
666
- * and the affected resources in the account.</p>
667
- * </li>
668
- * </ul>
669
- * <p>You can determine if an event is public or account-specific by using the
670
- * <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>
671
- */
323
+
672
324
  export interface Event {
673
- /**
674
- * <p>The unique identifier for the event. The event ARN has the
675
- * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
676
- * </code>
677
- * format.</p>
678
- * <p>For example, an event ARN might look like the following:</p>
679
- * <p>
680
- * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
681
- * </p>
682
- */
325
+
683
326
  arn?: string;
684
- /**
685
- * <p>The AWS service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
686
- */
327
+
687
328
  service?: string;
688
- /**
689
- * <p>The unique identifier for the event type. The format is <code>AWS_<i>SERVICE</i>_<i>DESCRIPTION</i>
690
- * </code>; for example, <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code>.</p>
691
- */
329
+
692
330
  eventTypeCode?: string;
693
- /**
694
- * <p>The category of the event. Possible values are <code>issue</code>,
695
- * <code>scheduledChange</code>, and <code>accountNotification</code>.</p>
696
- */
331
+
697
332
  eventTypeCategory?: EventTypeCategory | string;
698
- /**
699
- * <p>The AWS Region name of the event.</p>
700
- */
333
+
701
334
  region?: string;
702
- /**
703
- * <p>The AWS Availability Zone of the event. For example, us-east-1a.</p>
704
- */
335
+
705
336
  availabilityZone?: string;
706
- /**
707
- * <p>The date and time that the event began.</p>
708
- */
337
+
709
338
  startTime?: Date;
710
- /**
711
- * <p>The date and time that the event ended.</p>
712
- */
339
+
713
340
  endTime?: Date;
714
- /**
715
- * <p>The most recent date and time that the event was updated.</p>
716
- */
341
+
717
342
  lastUpdatedTime?: Date;
718
- /**
719
- * <p>The most recent status of the event. Possible values are <code>open</code>,
720
- * <code>closed</code>, and <code>upcoming</code>.</p>
721
- */
343
+
722
344
  statusCode?: EventStatusCode | string;
723
- /**
724
- * <p>This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event.</p>
725
- * <ul>
726
- * <li>
727
- * <p>If the <code>eventScopeCode</code> value is <code>PUBLIC</code>, then the
728
- * <code>affectedAccounts</code> value is always empty.</p>
729
- * </li>
730
- * <li>
731
- * <p>If the <code>eventScopeCode</code> value is <code>ACCOUNT_SPECIFIC</code>, then
732
- * the <code>affectedAccounts</code> value lists the affected AWS accounts in your
733
- * organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you
734
- * have AWS accounts that use that service, those account IDs appear in the
735
- * response.</p>
736
- * </li>
737
- * <li>
738
- * <p>If the <code>eventScopeCode</code> value is <code>NONE</code>, then the
739
- * <code>eventArn</code> that you specified in the request is invalid or doesn't
740
- * exist.</p>
741
- * </li>
742
- * </ul>
743
- */
345
+
744
346
  eventScopeCode?: EventScopeCode | string;
745
347
  }
746
348
  export declare namespace Event {
747
- /**
748
- * @internal
749
- */
349
+
750
350
  const filterSensitiveLog: (obj: Event) => any;
751
351
  }
752
- /**
753
- * <p>The detailed description of the event. Included in the information returned by the
754
- * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html">DescribeEventDetails</a> operation.</p>
755
- */
352
+
756
353
  export interface EventDescription {
757
- /**
758
- * <p>The most recent description of the event.</p>
759
- */
354
+
760
355
  latestDescription?: string;
761
356
  }
762
357
  export declare namespace EventDescription {
763
- /**
764
- * @internal
765
- */
358
+
766
359
  const filterSensitiveLog: (obj: EventDescription) => any;
767
360
  }
768
- /**
769
- * <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
770
- * the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html">DescribeEventDetails</a> operation.</p>
771
- */
361
+
772
362
  export interface EventDetails {
773
- /**
774
- * <p>Summary information about the event.</p>
775
- */
363
+
776
364
  event?: Event;
777
- /**
778
- * <p>The most recent description of the event.</p>
779
- */
365
+
780
366
  eventDescription?: EventDescription;
781
- /**
782
- * <p>Additional metadata about the event.</p>
783
- */
367
+
784
368
  eventMetadata?: {
785
369
  [key: string]: string;
786
370
  };
787
371
  }
788
372
  export declare namespace EventDetails {
789
- /**
790
- * @internal
791
- */
373
+
792
374
  const filterSensitiveLog: (obj: EventDetails) => any;
793
375
  }
794
376
  export interface DescribeEventDetailsResponse {
795
- /**
796
- * <p>Information about the events that could be retrieved.</p>
797
- */
377
+
798
378
  successfulSet?: EventDetails[];
799
- /**
800
- * <p>Error messages for any events that could not be retrieved.</p>
801
- */
379
+
802
380
  failedSet?: EventDetailsErrorItem[];
803
381
  }
804
382
  export declare namespace DescribeEventDetailsResponse {
805
- /**
806
- * @internal
807
- */
383
+
808
384
  const filterSensitiveLog: (obj: DescribeEventDetailsResponse) => any;
809
385
  }
810
386
  export interface DescribeEventDetailsForOrganizationRequest {
811
- /**
812
- * <p>A set of JSON elements that includes the <code>awsAccountId</code> and the
813
- * <code>eventArn</code>.</p>
814
- */
387
+
815
388
  organizationEventDetailFilters: EventAccountFilter[] | undefined;
816
- /**
817
- * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
818
- */
389
+
819
390
  locale?: string;
820
391
  }
821
392
  export declare namespace DescribeEventDetailsForOrganizationRequest {
822
- /**
823
- * @internal
824
- */
393
+
825
394
  const filterSensitiveLog: (obj: DescribeEventDetailsForOrganizationRequest) => any;
826
395
  }
827
- /**
828
- * <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
829
- * event.</p>
830
- */
396
+
831
397
  export interface OrganizationEventDetailsErrorItem {
832
- /**
833
- * <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
834
- * event.</p>
835
- */
398
+
836
399
  awsAccountId?: string;
837
- /**
838
- * <p>The unique identifier for the event. The event ARN has the
839
- * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
840
- * </code>
841
- * format.</p>
842
- * <p>For example, an event ARN might look like the following:</p>
843
- * <p>
844
- * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
845
- * </p>
846
- */
400
+
847
401
  eventArn?: string;
848
- /**
849
- * <p>The name of the error.</p>
850
- */
402
+
851
403
  errorName?: string;
852
- /**
853
- * <p>A message that describes the error.</p>
854
- * <p>If you call the <code>DescribeEventDetailsForOrganization</code>
855
- * operation and receive one of the following errors, follow the recommendations in the message:</p>
856
- * <ul>
857
- * <li>
858
- * <p>We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an AWS account ID in the request.</p>
859
- * </li>
860
- * <li>
861
- * <p>We couldn't find an account specific event for the specified AWS account. To find an event that is public, you must enter a null value for the AWS account ID in the request.</p>
862
- * </li>
863
- * <li>
864
- * <p>Your AWS account doesn't include the AWS Support plan required to use the AWS Health API. You must have either a Business or Enterprise Support plan.</p>
865
- * </li>
866
- * </ul>
867
- */
404
+
868
405
  errorMessage?: string;
869
406
  }
870
407
  export declare namespace OrganizationEventDetailsErrorItem {
871
- /**
872
- * @internal
873
- */
408
+
874
409
  const filterSensitiveLog: (obj: OrganizationEventDetailsErrorItem) => any;
875
410
  }
876
- /**
877
- * <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
878
- * the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html">DescribeEventDetailsForOrganization</a> operation.</p>
879
- */
411
+
880
412
  export interface OrganizationEventDetails {
881
- /**
882
- * <p>The 12-digit AWS account numbers that contains the affected entities.</p>
883
- */
413
+
884
414
  awsAccountId?: string;
885
- /**
886
- * <p>Summary information about an AWS Health event.</p>
887
- * <p>AWS Health events can be public or account-specific:</p>
888
- * <ul>
889
- * <li>
890
- * <p>
891
- * <i>Public events</i> might be service events that are not specific
892
- * to an AWS account. For example, if there is an issue with an AWS Region,
893
- * AWS Health provides information about the event, even if you don't use services or
894
- * resources in that Region.</p>
895
- * </li>
896
- * <li>
897
- * <p>
898
- * <i>Account-specific</i> events are specific to either your AWS
899
- * account or an account in your organization. For example, if there's an issue with
900
- * Amazon Elastic Compute Cloud in a Region that you use, AWS Health provides information about the event
901
- * and the affected resources in the account.</p>
902
- * </li>
903
- * </ul>
904
- * <p>You can determine if an event is public or account-specific by using the
905
- * <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>
906
- */
415
+
907
416
  event?: Event;
908
- /**
909
- * <p>The detailed description of the event. Included in the information returned by the
910
- * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html">DescribeEventDetails</a> operation.</p>
911
- */
417
+
912
418
  eventDescription?: EventDescription;
913
- /**
914
- * <p>Additional metadata about the event.</p>
915
- */
419
+
916
420
  eventMetadata?: {
917
421
  [key: string]: string;
918
422
  };
919
423
  }
920
424
  export declare namespace OrganizationEventDetails {
921
- /**
922
- * @internal
923
- */
425
+
924
426
  const filterSensitiveLog: (obj: OrganizationEventDetails) => any;
925
427
  }
926
428
  export interface DescribeEventDetailsForOrganizationResponse {
927
- /**
928
- * <p>Information about the events that could be retrieved.</p>
929
- */
429
+
930
430
  successfulSet?: OrganizationEventDetails[];
931
- /**
932
- * <p>Error messages for any events that could not be retrieved.</p>
933
- */
431
+
934
432
  failedSet?: OrganizationEventDetailsErrorItem[];
935
433
  }
936
434
  export declare namespace DescribeEventDetailsForOrganizationResponse {
937
- /**
938
- * @internal
939
- */
435
+
940
436
  const filterSensitiveLog: (obj: DescribeEventDetailsForOrganizationResponse) => any;
941
437
  }
942
438
  export interface DescribeEventsRequest {
943
- /**
944
- * <p>Values to narrow the results returned.</p>
945
- */
439
+
946
440
  filter?: EventFilter;
947
- /**
948
- * <p>If the results of a search are large, only a portion of the
949
- * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
950
- * retrieve the next batch of results, reissue the search request and include the returned token.
951
- * When all results have been returned, the response does not contain a pagination token value.</p>
952
- */
441
+
953
442
  nextToken?: string;
954
- /**
955
- * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
956
- */
443
+
957
444
  maxResults?: number;
958
- /**
959
- * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
960
- */
445
+
961
446
  locale?: string;
962
447
  }
963
448
  export declare namespace DescribeEventsRequest {
964
- /**
965
- * @internal
966
- */
449
+
967
450
  const filterSensitiveLog: (obj: DescribeEventsRequest) => any;
968
451
  }
969
452
  export interface DescribeEventsResponse {
970
- /**
971
- * <p>The events that match the specified filter criteria.</p>
972
- */
453
+
973
454
  events?: Event[];
974
- /**
975
- * <p>If the results of a search are large, only a portion of the
976
- * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
977
- * retrieve the next batch of results, reissue the search request and include the returned token.
978
- * When all results have been returned, the response does not contain a pagination token value.</p>
979
- */
455
+
980
456
  nextToken?: string;
981
457
  }
982
458
  export declare namespace DescribeEventsResponse {
983
- /**
984
- * @internal
985
- */
459
+
986
460
  const filterSensitiveLog: (obj: DescribeEventsResponse) => any;
987
461
  }
988
- /**
989
- * <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>
990
- */
462
+
991
463
  export interface OrganizationEventFilter {
992
- /**
993
- * <p>A list of unique identifiers for event types. For example, <code>"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".</code>
994
- * </p>
995
- */
464
+
996
465
  eventTypeCodes?: string[];
997
- /**
998
- * <p>A list of 12-digit AWS account numbers that contains the affected entities.</p>
999
- */
466
+
1000
467
  awsAccountIds?: string[];
1001
- /**
1002
- * <p>The AWS services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1003
- */
468
+
1004
469
  services?: string[];
1005
- /**
1006
- * <p>A list of AWS Regions.</p>
1007
- */
470
+
1008
471
  regions?: string[];
1009
- /**
1010
- * <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:
1011
- * match items where the timestamp (<code>startTime</code>, <code>endTime</code>, or
1012
- * <code>lastUpdatedTime</code>) is between <code>from</code> and <code>to</code>
1013
- * inclusive. If <code>from</code> is set and <code>to</code> is not set: match items where
1014
- * the timestamp value is equal to or after <code>from</code>. If <code>from</code> is not set
1015
- * and <code>to</code> is set: match items where the timestamp value is equal to or before
1016
- * <code>to</code>.</p>
1017
- */
472
+
1018
473
  startTime?: DateTimeRange;
1019
- /**
1020
- * <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:
1021
- * match items where the timestamp (<code>startTime</code>, <code>endTime</code>, or
1022
- * <code>lastUpdatedTime</code>) is between <code>from</code> and <code>to</code>
1023
- * inclusive. If <code>from</code> is set and <code>to</code> is not set: match items where
1024
- * the timestamp value is equal to or after <code>from</code>. If <code>from</code> is not set
1025
- * and <code>to</code> is set: match items where the timestamp value is equal to or before
1026
- * <code>to</code>.</p>
1027
- */
474
+
1028
475
  endTime?: DateTimeRange;
1029
- /**
1030
- * <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:
1031
- * match items where the timestamp (<code>startTime</code>, <code>endTime</code>, or
1032
- * <code>lastUpdatedTime</code>) is between <code>from</code> and <code>to</code>
1033
- * inclusive. If <code>from</code> is set and <code>to</code> is not set: match items where
1034
- * the timestamp value is equal to or after <code>from</code>. If <code>from</code> is not set
1035
- * and <code>to</code> is set: match items where the timestamp value is equal to or before
1036
- * <code>to</code>.</p>
1037
- */
476
+
1038
477
  lastUpdatedTime?: DateTimeRange;
1039
- /**
1040
- * <p>A list of entity ARNs (unique identifiers).</p>
1041
- */
478
+
1042
479
  entityArns?: string[];
1043
- /**
1044
- * <p>A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).</p>
1045
- */
480
+
1046
481
  entityValues?: string[];
1047
- /**
1048
- * <p>A list of event type category codes (issue, scheduledChange, or accountNotification).</p>
1049
- */
482
+
1050
483
  eventTypeCategories?: (EventTypeCategory | string)[];
1051
- /**
1052
- * <p>A list of event status codes.</p>
1053
- */
484
+
1054
485
  eventStatusCodes?: (EventStatusCode | string)[];
1055
486
  }
1056
487
  export declare namespace OrganizationEventFilter {
1057
- /**
1058
- * @internal
1059
- */
488
+
1060
489
  const filterSensitiveLog: (obj: OrganizationEventFilter) => any;
1061
490
  }
1062
491
  export interface DescribeEventsForOrganizationRequest {
1063
- /**
1064
- * <p>Values to narrow the results returned.</p>
1065
- */
492
+
1066
493
  filter?: OrganizationEventFilter;
1067
- /**
1068
- * <p>If the results of a search are large, only a portion of the
1069
- * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
1070
- * retrieve the next batch of results, reissue the search request and include the returned token.
1071
- * When all results have been returned, the response does not contain a pagination token value.</p>
1072
- */
494
+
1073
495
  nextToken?: string;
1074
- /**
1075
- * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
1076
- */
496
+
1077
497
  maxResults?: number;
1078
- /**
1079
- * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
1080
- */
498
+
1081
499
  locale?: string;
1082
500
  }
1083
501
  export declare namespace DescribeEventsForOrganizationRequest {
1084
- /**
1085
- * @internal
1086
- */
502
+
1087
503
  const filterSensitiveLog: (obj: DescribeEventsForOrganizationRequest) => any;
1088
504
  }
1089
- /**
1090
- * <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>
1091
- */
505
+
1092
506
  export interface OrganizationEvent {
1093
- /**
1094
- * <p>The unique identifier for the event. The event ARN has the
1095
- * <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i>
1096
- * </code>
1097
- * format.</p>
1098
- * <p>For example, an event ARN might look like the following:</p>
1099
- * <p>
1100
- * <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code>
1101
- * </p>
1102
- */
507
+
1103
508
  arn?: string;
1104
- /**
1105
- * <p>The AWS service that is affected by the event, such as EC2 and RDS.</p>
1106
- */
509
+
1107
510
  service?: string;
1108
- /**
1109
- * <p>The unique identifier for the event type. The format is
1110
- * <code>AWS_SERVICE_DESCRIPTION</code>. For example,
1111
- * <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code>.</p>
1112
- */
511
+
1113
512
  eventTypeCode?: string;
1114
- /**
1115
- * <p>The category of the event type.</p>
1116
- */
513
+
1117
514
  eventTypeCategory?: EventTypeCategory | string;
1118
- /**
1119
- * <p>This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event.</p>
1120
- * <ul>
1121
- * <li>
1122
- * <p>If the <code>eventScopeCode</code> value is <code>PUBLIC</code>, then the
1123
- * <code>affectedAccounts</code> value is always empty.</p>
1124
- * </li>
1125
- * <li>
1126
- * <p>If the <code>eventScopeCode</code> value is <code>ACCOUNT_SPECIFIC</code>, then
1127
- * the <code>affectedAccounts</code> value lists the affected AWS accounts in your
1128
- * organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you
1129
- * have AWS accounts that use that service, those account IDs appear in the
1130
- * response.</p>
1131
- * </li>
1132
- * <li>
1133
- * <p>If the <code>eventScopeCode</code> value is <code>NONE</code>, then the
1134
- * <code>eventArn</code> that you specified in the request is invalid or doesn't
1135
- * exist.</p>
1136
- * </li>
1137
- * </ul>
1138
- */
515
+
1139
516
  eventScopeCode?: EventScopeCode | string;
1140
- /**
1141
- * <p>The AWS Region name of the event.</p>
1142
- */
517
+
1143
518
  region?: string;
1144
- /**
1145
- * <p>The date and time that the event began.</p>
1146
- */
519
+
1147
520
  startTime?: Date;
1148
- /**
1149
- * <p>The date and time that the event ended.</p>
1150
- */
521
+
1151
522
  endTime?: Date;
1152
- /**
1153
- * <p>The most recent date and time that the event was updated.</p>
1154
- */
523
+
1155
524
  lastUpdatedTime?: Date;
1156
- /**
1157
- * <p>The most recent status of the event. Possible values are <code>open</code>,
1158
- * <code>closed</code>, and <code>upcoming</code>.</p>
1159
- */
525
+
1160
526
  statusCode?: EventStatusCode | string;
1161
527
  }
1162
528
  export declare namespace OrganizationEvent {
1163
- /**
1164
- * @internal
1165
- */
529
+
1166
530
  const filterSensitiveLog: (obj: OrganizationEvent) => any;
1167
531
  }
1168
532
  export interface DescribeEventsForOrganizationResponse {
1169
- /**
1170
- * <p>The events that match the specified filter criteria.</p>
1171
- */
533
+
1172
534
  events?: OrganizationEvent[];
1173
- /**
1174
- * <p>If the results of a search are large, only a portion of the
1175
- * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
1176
- * retrieve the next batch of results, reissue the search request and include the returned token.
1177
- * When all results have been returned, the response does not contain a pagination token value.</p>
1178
- */
535
+
1179
536
  nextToken?: string;
1180
537
  }
1181
538
  export declare namespace DescribeEventsForOrganizationResponse {
1182
- /**
1183
- * @internal
1184
- */
539
+
1185
540
  const filterSensitiveLog: (obj: DescribeEventsForOrganizationResponse) => any;
1186
541
  }
1187
- /**
1188
- * <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>
1189
- * operation.</p>
1190
- */
542
+
1191
543
  export interface EventTypeFilter {
1192
- /**
1193
- * <p>A list of event type codes.</p>
1194
- */
544
+
1195
545
  eventTypeCodes?: string[];
1196
- /**
1197
- * <p>The AWS services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1198
- */
546
+
1199
547
  services?: string[];
1200
- /**
1201
- * <p>A list of event type category codes (<code>issue</code>, <code>scheduledChange</code>,
1202
- * or <code>accountNotification</code>).</p>
1203
- */
548
+
1204
549
  eventTypeCategories?: (EventTypeCategory | string)[];
1205
550
  }
1206
551
  export declare namespace EventTypeFilter {
1207
- /**
1208
- * @internal
1209
- */
552
+
1210
553
  const filterSensitiveLog: (obj: EventTypeFilter) => any;
1211
554
  }
1212
555
  export interface DescribeEventTypesRequest {
1213
- /**
1214
- * <p>Values to narrow the results returned.</p>
1215
- */
556
+
1216
557
  filter?: EventTypeFilter;
1217
- /**
1218
- * <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
1219
- */
558
+
1220
559
  locale?: string;
1221
- /**
1222
- * <p>If the results of a search are large, only a portion of the
1223
- * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
1224
- * retrieve the next batch of results, reissue the search request and include the returned token.
1225
- * When all results have been returned, the response does not contain a pagination token value.</p>
1226
- */
560
+
1227
561
  nextToken?: string;
1228
- /**
1229
- * <p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>
1230
- */
562
+
1231
563
  maxResults?: number;
1232
564
  }
1233
565
  export declare namespace DescribeEventTypesRequest {
1234
- /**
1235
- * @internal
1236
- */
566
+
1237
567
  const filterSensitiveLog: (obj: DescribeEventTypesRequest) => any;
1238
568
  }
1239
- /**
1240
- * <p>Contains the metadata about a type of event that is reported by AWS Health. The
1241
- * <code>EventType</code> shows the category, service, and the event type code of the
1242
- * event. For example, an <code>issue</code> might be the category, <code>EC2</code> the
1243
- * service, and <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code> the event type code.</p>
1244
- * <p>You can use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html">DescribeEventTypes</a> API operation to return this information
1245
- * about an event.</p>
1246
- * <p>You can also use the Amazon CloudWatch Events console to create a rule so that you can get notified or
1247
- * take action when AWS Health delivers a specific event to your AWS account. For more
1248
- * information, see <a href="https://docs.aws.amazon.com/health/latest/ug/cloudwatch-events-health.html">Monitor for AWS Health events with Amazon CloudWatch Events</a> in the
1249
- * <i>AWS Health User Guide</i>.</p>
1250
- */
569
+
1251
570
  export interface EventType {
1252
- /**
1253
- * <p>The AWS service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
1254
- */
571
+
1255
572
  service?: string;
1256
- /**
1257
- * <p>The unique identifier for the event type. The format is <code>AWS_<i>SERVICE</i>_<i>DESCRIPTION</i>
1258
- * </code>; for example, <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code>.</p>
1259
- */
573
+
1260
574
  code?: string;
1261
- /**
1262
- * <p>A list of event type category codes (<code>issue</code>, <code>scheduledChange</code>,
1263
- * or <code>accountNotification</code>).</p>
1264
- */
575
+
1265
576
  category?: EventTypeCategory | string;
1266
577
  }
1267
578
  export declare namespace EventType {
1268
- /**
1269
- * @internal
1270
- */
579
+
1271
580
  const filterSensitiveLog: (obj: EventType) => any;
1272
581
  }
1273
582
  export interface DescribeEventTypesResponse {
1274
- /**
1275
- * <p>A list of event types that match the filter criteria. Event types have a category
1276
- * (<code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>),
1277
- * a service (for example, <code>EC2</code>, <code>RDS</code>, <code>DATAPIPELINE</code>,
1278
- * <code>BILLING</code>), and a code (in the format
1279
- * <code>AWS_<i>SERVICE</i>_<i>DESCRIPTION</i>
1280
- * </code>; for
1281
- * example, <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code>).</p>
1282
- */
583
+
1283
584
  eventTypes?: EventType[];
1284
- /**
1285
- * <p>If the results of a search are large, only a portion of the
1286
- * results are returned, and a <code>nextToken</code> pagination token is returned in the response. To
1287
- * retrieve the next batch of results, reissue the search request and include the returned token.
1288
- * When all results have been returned, the response does not contain a pagination token value.</p>
1289
- */
585
+
1290
586
  nextToken?: string;
1291
587
  }
1292
588
  export declare namespace DescribeEventTypesResponse {
1293
- /**
1294
- * @internal
1295
- */
589
+
1296
590
  const filterSensitiveLog: (obj: DescribeEventTypesResponse) => any;
1297
591
  }
1298
592
  export interface DescribeHealthServiceStatusForOrganizationResponse {
1299
- /**
1300
- * <p>Information about the status of enabling or disabling AWS Health Organizational View in
1301
- * your organization.</p>
1302
- * <p>Valid values are <code>ENABLED | DISABLED | PENDING</code>. </p>
1303
- */
593
+
1304
594
  healthServiceAccessStatusForOrganization?: string;
1305
595
  }
1306
596
  export declare namespace DescribeHealthServiceStatusForOrganizationResponse {
1307
- /**
1308
- * @internal
1309
- */
597
+
1310
598
  const filterSensitiveLog: (obj: DescribeHealthServiceStatusForOrganizationResponse) => any;
1311
599
  }
1312
- /**
1313
- * <p>
1314
- * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a> is already in progress. Wait for the
1315
- * 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>
1316
- */
600
+
1317
601
  export interface ConcurrentModificationException extends __SmithyException, $MetadataBearer {
1318
602
  name: "ConcurrentModificationException";
1319
603
  $fault: "client";
1320
604
  message?: string;
1321
605
  }
1322
606
  export declare namespace ConcurrentModificationException {
1323
- /**
1324
- * @internal
1325
- */
607
+
1326
608
  const filterSensitiveLog: (obj: ConcurrentModificationException) => any;
1327
609
  }