@aws-sdk/client-health 3.295.0 → 3.297.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 (26) hide show
  1. package/dist-types/Health.d.ts +14 -0
  2. package/dist-types/HealthClient.d.ts +24 -4
  3. package/dist-types/commands/DescribeAffectedAccountsForOrganizationCommand.d.ts +16 -0
  4. package/dist-types/commands/DescribeAffectedEntitiesCommand.d.ts +16 -0
  5. package/dist-types/commands/DescribeAffectedEntitiesForOrganizationCommand.d.ts +16 -0
  6. package/dist-types/commands/DescribeEntityAggregatesCommand.d.ts +16 -0
  7. package/dist-types/commands/DescribeEventAggregatesCommand.d.ts +16 -0
  8. package/dist-types/commands/DescribeEventDetailsCommand.d.ts +16 -0
  9. package/dist-types/commands/DescribeEventDetailsForOrganizationCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeEventTypesCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeEventsCommand.d.ts +16 -0
  12. package/dist-types/commands/DescribeEventsForOrganizationCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeHealthServiceStatusForOrganizationCommand.d.ts +16 -0
  14. package/dist-types/commands/DisableHealthServiceAccessForOrganizationCommand.d.ts +16 -0
  15. package/dist-types/commands/EnableHealthServiceAccessForOrganizationCommand.d.ts +16 -0
  16. package/dist-types/models/HealthServiceException.d.ts +2 -0
  17. package/dist-types/models/models_0.d.ts +99 -0
  18. package/dist-types/pagination/DescribeAffectedAccountsForOrganizationPaginator.d.ts +3 -0
  19. package/dist-types/pagination/DescribeAffectedEntitiesForOrganizationPaginator.d.ts +3 -0
  20. package/dist-types/pagination/DescribeAffectedEntitiesPaginator.d.ts +3 -0
  21. package/dist-types/pagination/DescribeEventAggregatesPaginator.d.ts +3 -0
  22. package/dist-types/pagination/DescribeEventTypesPaginator.d.ts +3 -0
  23. package/dist-types/pagination/DescribeEventsForOrganizationPaginator.d.ts +3 -0
  24. package/dist-types/pagination/DescribeEventsPaginator.d.ts +3 -0
  25. package/dist-types/pagination/Interfaces.d.ts +3 -0
  26. package/package.json +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
5
5
  import { DescribeEventsForOrganizationRequest, DescribeEventsForOrganizationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeEventsForOrganizationCommand}.
8
10
  */
9
11
  export interface DescribeEventsForOrganizationCommandInput extends DescribeEventsForOrganizationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeEventsForOrganizationCommand}.
13
17
  */
14
18
  export interface DescribeEventsForOrganizationCommandOutput extends DescribeEventsForOrganizationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about events across your organization in Organizations. You can use
18
23
  * the<code>filters</code> parameter to specify the events that you want to return. Events
19
24
  * are returned in a summary form and don't include the affected accounts, detailed
@@ -56,6 +61,8 @@ export interface DescribeEventsForOrganizationCommandOutput extends DescribeEven
56
61
  * const response = await client.send(command);
57
62
  * ```
58
63
  *
64
+ * @param DescribeEventsForOrganizationCommandInput - {@link DescribeEventsForOrganizationCommandInput}
65
+ * @returns {@link DescribeEventsForOrganizationCommandOutput}
59
66
  * @see {@link DescribeEventsForOrganizationCommandInput} for command's `input` shape.
60
67
  * @see {@link DescribeEventsForOrganizationCommandOutput} for command's `response` shape.
61
68
  * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
@@ -71,11 +78,20 @@ export interface DescribeEventsForOrganizationCommandOutput extends DescribeEven
71
78
  export declare class DescribeEventsForOrganizationCommand extends $Command<DescribeEventsForOrganizationCommandInput, DescribeEventsForOrganizationCommandOutput, HealthClientResolvedConfig> {
72
79
  readonly input: DescribeEventsForOrganizationCommandInput;
73
80
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
81
+ /**
82
+ * @public
83
+ */
74
84
  constructor(input: DescribeEventsForOrganizationCommandInput);
75
85
  /**
76
86
  * @internal
77
87
  */
78
88
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventsForOrganizationCommandInput, DescribeEventsForOrganizationCommandOutput>;
89
+ /**
90
+ * @internal
91
+ */
79
92
  private serialize;
93
+ /**
94
+ * @internal
95
+ */
80
96
  private deserialize;
81
97
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
5
5
  import { DescribeHealthServiceStatusForOrganizationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeHealthServiceStatusForOrganizationCommand}.
8
10
  */
9
11
  export interface DescribeHealthServiceStatusForOrganizationCommandInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeHealthServiceStatusForOrganizationCommand}.
13
17
  */
14
18
  export interface DescribeHealthServiceStatusForOrganizationCommandOutput extends DescribeHealthServiceStatusForOrganizationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>This operation provides status information on enabling or disabling Health to work
18
23
  * with your organization. To call this operation, you must sign in as an IAM user, assume
19
24
  * an IAM role, or sign in as the root user (not recommended) in the organization's
@@ -28,6 +33,8 @@ export interface DescribeHealthServiceStatusForOrganizationCommandOutput extends
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DescribeHealthServiceStatusForOrganizationCommandInput - {@link DescribeHealthServiceStatusForOrganizationCommandInput}
37
+ * @returns {@link DescribeHealthServiceStatusForOrganizationCommandOutput}
31
38
  * @see {@link DescribeHealthServiceStatusForOrganizationCommandInput} for command's `input` shape.
32
39
  * @see {@link DescribeHealthServiceStatusForOrganizationCommandOutput} for command's `response` shape.
33
40
  * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
@@ -37,11 +44,20 @@ export interface DescribeHealthServiceStatusForOrganizationCommandOutput extends
37
44
  export declare class DescribeHealthServiceStatusForOrganizationCommand extends $Command<DescribeHealthServiceStatusForOrganizationCommandInput, DescribeHealthServiceStatusForOrganizationCommandOutput, HealthClientResolvedConfig> {
38
45
  readonly input: DescribeHealthServiceStatusForOrganizationCommandInput;
39
46
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
47
+ /**
48
+ * @public
49
+ */
40
50
  constructor(input: DescribeHealthServiceStatusForOrganizationCommandInput);
41
51
  /**
42
52
  * @internal
43
53
  */
44
54
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeHealthServiceStatusForOrganizationCommandInput, DescribeHealthServiceStatusForOrganizationCommandOutput>;
55
+ /**
56
+ * @internal
57
+ */
45
58
  private serialize;
59
+ /**
60
+ * @internal
61
+ */
46
62
  private deserialize;
47
63
  }
@@ -3,16 +3,21 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
5
5
  /**
6
+ * @public
7
+ *
6
8
  * The input for {@link DisableHealthServiceAccessForOrganizationCommand}.
7
9
  */
8
10
  export interface DisableHealthServiceAccessForOrganizationCommandInput {
9
11
  }
10
12
  /**
13
+ * @public
14
+ *
11
15
  * The output of {@link DisableHealthServiceAccessForOrganizationCommand}.
12
16
  */
13
17
  export interface DisableHealthServiceAccessForOrganizationCommandOutput extends __MetadataBearer {
14
18
  }
15
19
  /**
20
+ * @public
16
21
  * <p>Disables Health from working with Organizations. To call this operation, you must sign
17
22
  * in as an Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not
18
23
  * recommended) in the organization's management account. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html">Aggregating
@@ -38,6 +43,8 @@ export interface DisableHealthServiceAccessForOrganizationCommandOutput extends
38
43
  * const response = await client.send(command);
39
44
  * ```
40
45
  *
46
+ * @param DisableHealthServiceAccessForOrganizationCommandInput - {@link DisableHealthServiceAccessForOrganizationCommandInput}
47
+ * @returns {@link DisableHealthServiceAccessForOrganizationCommandOutput}
41
48
  * @see {@link DisableHealthServiceAccessForOrganizationCommandInput} for command's `input` shape.
42
49
  * @see {@link DisableHealthServiceAccessForOrganizationCommandOutput} for command's `response` shape.
43
50
  * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DisableHealthServiceAccessForOrganizationCommandOutput extends
52
59
  export declare class DisableHealthServiceAccessForOrganizationCommand extends $Command<DisableHealthServiceAccessForOrganizationCommandInput, DisableHealthServiceAccessForOrganizationCommandOutput, HealthClientResolvedConfig> {
53
60
  readonly input: DisableHealthServiceAccessForOrganizationCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DisableHealthServiceAccessForOrganizationCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableHealthServiceAccessForOrganizationCommandInput, DisableHealthServiceAccessForOrganizationCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -3,16 +3,21 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
5
5
  /**
6
+ * @public
7
+ *
6
8
  * The input for {@link EnableHealthServiceAccessForOrganizationCommand}.
7
9
  */
8
10
  export interface EnableHealthServiceAccessForOrganizationCommandInput {
9
11
  }
10
12
  /**
13
+ * @public
14
+ *
11
15
  * The output of {@link EnableHealthServiceAccessForOrganizationCommand}.
12
16
  */
13
17
  export interface EnableHealthServiceAccessForOrganizationCommandOutput extends __MetadataBearer {
14
18
  }
15
19
  /**
20
+ * @public
16
21
  * <p>Enables Health to work with Organizations. You can use the organizational view feature
17
22
  * to aggregate events from all Amazon Web Services accounts in your organization in a centralized location. </p>
18
23
  * <p>This operation also creates a service-linked role for the management account in the
@@ -46,6 +51,8 @@ export interface EnableHealthServiceAccessForOrganizationCommandOutput extends _
46
51
  * const response = await client.send(command);
47
52
  * ```
48
53
  *
54
+ * @param EnableHealthServiceAccessForOrganizationCommandInput - {@link EnableHealthServiceAccessForOrganizationCommandInput}
55
+ * @returns {@link EnableHealthServiceAccessForOrganizationCommandOutput}
49
56
  * @see {@link EnableHealthServiceAccessForOrganizationCommandInput} for command's `input` shape.
50
57
  * @see {@link EnableHealthServiceAccessForOrganizationCommandOutput} for command's `response` shape.
51
58
  * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
@@ -60,11 +67,20 @@ export interface EnableHealthServiceAccessForOrganizationCommandOutput extends _
60
67
  export declare class EnableHealthServiceAccessForOrganizationCommand extends $Command<EnableHealthServiceAccessForOrganizationCommandInput, EnableHealthServiceAccessForOrganizationCommandOutput, HealthClientResolvedConfig> {
61
68
  readonly input: EnableHealthServiceAccessForOrganizationCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: EnableHealthServiceAccessForOrganizationCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EnableHealthServiceAccessForOrganizationCommandInput, EnableHealthServiceAccessForOrganizationCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from Health service.
4
6
  */
5
7
  export declare class HealthServiceException extends __ServiceException {
@@ -1,11 +1,15 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { HealthServiceException as __BaseException } from "./HealthServiceException";
3
+ /**
4
+ * @public
5
+ */
3
6
  export declare enum EntityStatusCode {
4
7
  IMPAIRED = "IMPAIRED",
5
8
  UNIMPAIRED = "UNIMPAIRED",
6
9
  UNKNOWN = "UNKNOWN"
7
10
  }
8
11
  /**
12
+ * @public
9
13
  * <p>Information about an entity that is affected by a Health event.</p>
10
14
  */
11
15
  export interface AffectedEntity {
@@ -55,6 +59,9 @@ export interface AffectedEntity {
55
59
  */
56
60
  tags?: Record<string, string>;
57
61
  }
62
+ /**
63
+ * @public
64
+ */
58
65
  export interface DescribeAffectedAccountsForOrganizationRequest {
59
66
  /**
60
67
  * <p>The unique identifier for the event. The event ARN has the
@@ -79,11 +86,17 @@ export interface DescribeAffectedAccountsForOrganizationRequest {
79
86
  */
80
87
  maxResults?: number;
81
88
  }
89
+ /**
90
+ * @public
91
+ */
82
92
  export declare enum EventScopeCode {
83
93
  ACCOUNT_SPECIFIC = "ACCOUNT_SPECIFIC",
84
94
  NONE = "NONE",
85
95
  PUBLIC = "PUBLIC"
86
96
  }
97
+ /**
98
+ * @public
99
+ */
87
100
  export interface DescribeAffectedAccountsForOrganizationResponse {
88
101
  /**
89
102
  * <p>A JSON set of elements of the affected accounts.</p>
@@ -120,6 +133,7 @@ export interface DescribeAffectedAccountsForOrganizationResponse {
120
133
  nextToken?: string;
121
134
  }
122
135
  /**
136
+ * @public
123
137
  * <p>The specified pagination token (<code>nextToken</code>) is not valid.</p>
124
138
  */
125
139
  export declare class InvalidPaginationToken extends __BaseException {
@@ -131,6 +145,7 @@ export declare class InvalidPaginationToken extends __BaseException {
131
145
  constructor(opts: __ExceptionOptionType<InvalidPaginationToken, __BaseException>);
132
146
  }
133
147
  /**
148
+ * @public
134
149
  * <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:
135
150
  * match items where the timestamp (<code>startTime</code>, <code>endTime</code>, or
136
151
  * <code>lastUpdatedTime</code>) is between <code>from</code> and <code>to</code>
@@ -150,6 +165,7 @@ export interface DateTimeRange {
150
165
  to?: Date;
151
166
  }
152
167
  /**
168
+ * @public
153
169
  * <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>
154
170
  */
155
171
  export interface EntityFilter {
@@ -183,6 +199,9 @@ export interface EntityFilter {
183
199
  */
184
200
  statusCodes?: (EntityStatusCode | string)[];
185
201
  }
202
+ /**
203
+ * @public
204
+ */
186
205
  export interface DescribeAffectedEntitiesRequest {
187
206
  /**
188
207
  * <p>Values to narrow the results returned. At least one event ARN is required.</p>
@@ -204,6 +223,9 @@ export interface DescribeAffectedEntitiesRequest {
204
223
  */
205
224
  maxResults?: number;
206
225
  }
226
+ /**
227
+ * @public
228
+ */
207
229
  export interface DescribeAffectedEntitiesResponse {
208
230
  /**
209
231
  * <p>The entities that match the filter criteria.</p>
@@ -218,6 +240,7 @@ export interface DescribeAffectedEntitiesResponse {
218
240
  nextToken?: string;
219
241
  }
220
242
  /**
243
+ * @public
221
244
  * <p>The specified locale is not supported.</p>
222
245
  */
223
246
  export declare class UnsupportedLocale extends __BaseException {
@@ -229,6 +252,7 @@ export declare class UnsupportedLocale extends __BaseException {
229
252
  constructor(opts: __ExceptionOptionType<UnsupportedLocale, __BaseException>);
230
253
  }
231
254
  /**
255
+ * @public
232
256
  * <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>
233
257
  */
234
258
  export interface EventAccountFilter {
@@ -248,6 +272,9 @@ export interface EventAccountFilter {
248
272
  */
249
273
  awsAccountId?: string;
250
274
  }
275
+ /**
276
+ * @public
277
+ */
251
278
  export interface DescribeAffectedEntitiesForOrganizationRequest {
252
279
  /**
253
280
  * <p>A JSON set of elements including the <code>awsAccountId</code> and the
@@ -271,6 +298,7 @@ export interface DescribeAffectedEntitiesForOrganizationRequest {
271
298
  maxResults?: number;
272
299
  }
273
300
  /**
301
+ * @public
274
302
  * <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
275
303
  * specific entity.</p>
276
304
  */
@@ -301,6 +329,9 @@ export interface OrganizationAffectedEntitiesErrorItem {
301
329
  */
302
330
  errorMessage?: string;
303
331
  }
332
+ /**
333
+ * @public
334
+ */
304
335
  export interface DescribeAffectedEntitiesForOrganizationResponse {
305
336
  /**
306
337
  * <p>A JSON set of elements including the <code>awsAccountId</code> and its
@@ -321,6 +352,9 @@ export interface DescribeAffectedEntitiesForOrganizationResponse {
321
352
  */
322
353
  nextToken?: string;
323
354
  }
355
+ /**
356
+ * @public
357
+ */
324
358
  export interface DescribeEntityAggregatesRequest {
325
359
  /**
326
360
  * <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>
@@ -329,6 +363,7 @@ export interface DescribeEntityAggregatesRequest {
329
363
  eventArns?: string[];
330
364
  }
331
365
  /**
366
+ * @public
332
367
  * <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>
333
368
  */
334
369
  export interface EntityAggregate {
@@ -348,20 +383,32 @@ export interface EntityAggregate {
348
383
  */
349
384
  count?: number;
350
385
  }
386
+ /**
387
+ * @public
388
+ */
351
389
  export interface DescribeEntityAggregatesResponse {
352
390
  /**
353
391
  * <p>The number of entities that are affected by each of the specified events.</p>
354
392
  */
355
393
  entityAggregates?: EntityAggregate[];
356
394
  }
395
+ /**
396
+ * @public
397
+ */
357
398
  export declare enum EventAggregateField {
358
399
  EventTypeCategory = "eventTypeCategory"
359
400
  }
401
+ /**
402
+ * @public
403
+ */
360
404
  export declare enum EventStatusCode {
361
405
  CLOSED = "closed",
362
406
  OPEN = "open",
363
407
  UPCOMING = "upcoming"
364
408
  }
409
+ /**
410
+ * @public
411
+ */
365
412
  export declare enum EventTypeCategory {
366
413
  ACCOUNT_NOTIFICATION = "accountNotification",
367
414
  INVESTIGATION = "investigation",
@@ -369,6 +416,7 @@ export declare enum EventTypeCategory {
369
416
  SCHEDULED_CHANGE = "scheduledChange"
370
417
  }
371
418
  /**
419
+ * @public
372
420
  * <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
373
421
  * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html">DescribeEventAggregates</a> operations.</p>
374
422
  */
@@ -434,6 +482,9 @@ export interface EventFilter {
434
482
  */
435
483
  eventStatusCodes?: (EventStatusCode | string)[];
436
484
  }
485
+ /**
486
+ * @public
487
+ */
437
488
  export interface DescribeEventAggregatesRequest {
438
489
  /**
439
490
  * <p>Values to narrow the results returned.</p>
@@ -456,6 +507,7 @@ export interface DescribeEventAggregatesRequest {
456
507
  nextToken?: string;
457
508
  }
458
509
  /**
510
+ * @public
459
511
  * <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>
460
512
  */
461
513
  export interface EventAggregate {
@@ -468,6 +520,9 @@ export interface EventAggregate {
468
520
  */
469
521
  count?: number;
470
522
  }
523
+ /**
524
+ * @public
525
+ */
471
526
  export interface DescribeEventAggregatesResponse {
472
527
  /**
473
528
  * <p>The number of events in each category that meet the optional filter criteria.</p>
@@ -481,6 +536,9 @@ export interface DescribeEventAggregatesResponse {
481
536
  */
482
537
  nextToken?: string;
483
538
  }
539
+ /**
540
+ * @public
541
+ */
484
542
  export interface DescribeEventDetailsRequest {
485
543
  /**
486
544
  * <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>
@@ -493,6 +551,7 @@ export interface DescribeEventDetailsRequest {
493
551
  locale?: string;
494
552
  }
495
553
  /**
554
+ * @public
496
555
  * <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>
497
556
  */
498
557
  export interface EventDetailsErrorItem {
@@ -517,6 +576,7 @@ export interface EventDetailsErrorItem {
517
576
  errorMessage?: string;
518
577
  }
519
578
  /**
579
+ * @public
520
580
  * <p>Summary information about an Health event.</p>
521
581
  * <p>Health events can be public or account-specific:</p>
522
582
  * <ul>
@@ -614,6 +674,7 @@ export interface Event {
614
674
  eventScopeCode?: EventScopeCode | string;
615
675
  }
616
676
  /**
677
+ * @public
617
678
  * <p>The detailed description of the event. Included in the information returned by the
618
679
  * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html">DescribeEventDetails</a> operation.</p>
619
680
  */
@@ -624,6 +685,7 @@ export interface EventDescription {
624
685
  latestDescription?: string;
625
686
  }
626
687
  /**
688
+ * @public
627
689
  * <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
628
690
  * the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html">DescribeEventDetails</a> operation.</p>
629
691
  */
@@ -641,6 +703,9 @@ export interface EventDetails {
641
703
  */
642
704
  eventMetadata?: Record<string, string>;
643
705
  }
706
+ /**
707
+ * @public
708
+ */
644
709
  export interface DescribeEventDetailsResponse {
645
710
  /**
646
711
  * <p>Information about the events that could be retrieved.</p>
@@ -651,6 +716,9 @@ export interface DescribeEventDetailsResponse {
651
716
  */
652
717
  failedSet?: EventDetailsErrorItem[];
653
718
  }
719
+ /**
720
+ * @public
721
+ */
654
722
  export interface DescribeEventDetailsForOrganizationRequest {
655
723
  /**
656
724
  * <p>A set of JSON elements that includes the <code>awsAccountId</code> and the
@@ -663,6 +731,7 @@ export interface DescribeEventDetailsForOrganizationRequest {
663
731
  locale?: string;
664
732
  }
665
733
  /**
734
+ * @public
666
735
  * <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
667
736
  * event.</p>
668
737
  */
@@ -706,6 +775,7 @@ export interface OrganizationEventDetailsErrorItem {
706
775
  errorMessage?: string;
707
776
  }
708
777
  /**
778
+ * @public
709
779
  * <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
710
780
  * the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html">DescribeEventDetailsForOrganization</a> operation.</p>
711
781
  */
@@ -747,6 +817,9 @@ export interface OrganizationEventDetails {
747
817
  */
748
818
  eventMetadata?: Record<string, string>;
749
819
  }
820
+ /**
821
+ * @public
822
+ */
750
823
  export interface DescribeEventDetailsForOrganizationResponse {
751
824
  /**
752
825
  * <p>Information about the events that could be retrieved.</p>
@@ -757,6 +830,9 @@ export interface DescribeEventDetailsForOrganizationResponse {
757
830
  */
758
831
  failedSet?: OrganizationEventDetailsErrorItem[];
759
832
  }
833
+ /**
834
+ * @public
835
+ */
760
836
  export interface DescribeEventsRequest {
761
837
  /**
762
838
  * <p>Values to narrow the results returned.</p>
@@ -778,6 +854,9 @@ export interface DescribeEventsRequest {
778
854
  */
779
855
  locale?: string;
780
856
  }
857
+ /**
858
+ * @public
859
+ */
781
860
  export interface DescribeEventsResponse {
782
861
  /**
783
862
  * <p>The events that match the specified filter criteria.</p>
@@ -792,6 +871,7 @@ export interface DescribeEventsResponse {
792
871
  nextToken?: string;
793
872
  }
794
873
  /**
874
+ * @public
795
875
  * <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>
796
876
  */
797
877
  export interface OrganizationEventFilter {
@@ -861,6 +941,9 @@ export interface OrganizationEventFilter {
861
941
  */
862
942
  eventStatusCodes?: (EventStatusCode | string)[];
863
943
  }
944
+ /**
945
+ * @public
946
+ */
864
947
  export interface DescribeEventsForOrganizationRequest {
865
948
  /**
866
949
  * <p>Values to narrow the results returned.</p>
@@ -883,6 +966,7 @@ export interface DescribeEventsForOrganizationRequest {
883
966
  locale?: string;
884
967
  }
885
968
  /**
969
+ * @public
886
970
  * <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>
887
971
  */
888
972
  export interface OrganizationEvent {
@@ -957,6 +1041,9 @@ export interface OrganizationEvent {
957
1041
  */
958
1042
  statusCode?: EventStatusCode | string;
959
1043
  }
1044
+ /**
1045
+ * @public
1046
+ */
960
1047
  export interface DescribeEventsForOrganizationResponse {
961
1048
  /**
962
1049
  * <p>The events that match the specified filter criteria.</p>
@@ -971,6 +1058,7 @@ export interface DescribeEventsForOrganizationResponse {
971
1058
  nextToken?: string;
972
1059
  }
973
1060
  /**
1061
+ * @public
974
1062
  * <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>
975
1063
  * operation.</p>
976
1064
  */
@@ -990,6 +1078,9 @@ export interface EventTypeFilter {
990
1078
  */
991
1079
  eventTypeCategories?: (EventTypeCategory | string)[];
992
1080
  }
1081
+ /**
1082
+ * @public
1083
+ */
993
1084
  export interface DescribeEventTypesRequest {
994
1085
  /**
995
1086
  * <p>Values to narrow the results returned.</p>
@@ -1012,6 +1103,7 @@ export interface DescribeEventTypesRequest {
1012
1103
  maxResults?: number;
1013
1104
  }
1014
1105
  /**
1106
+ * @public
1015
1107
  * <p>Contains the metadata about a type of event that is reported by Health. The
1016
1108
  * <code>EventType</code> shows the category, service, and the event type code of the
1017
1109
  * event. For example, an <code>issue</code> might be the category, <code>EC2</code> the
@@ -1040,6 +1132,9 @@ export interface EventType {
1040
1132
  */
1041
1133
  category?: EventTypeCategory | string;
1042
1134
  }
1135
+ /**
1136
+ * @public
1137
+ */
1043
1138
  export interface DescribeEventTypesResponse {
1044
1139
  /**
1045
1140
  * <p>A list of event types that match the filter criteria. Event types have a category
@@ -1059,6 +1154,9 @@ export interface DescribeEventTypesResponse {
1059
1154
  */
1060
1155
  nextToken?: string;
1061
1156
  }
1157
+ /**
1158
+ * @public
1159
+ */
1062
1160
  export interface DescribeHealthServiceStatusForOrganizationResponse {
1063
1161
  /**
1064
1162
  * <p>Information about the status of enabling or disabling the Health organizational
@@ -1068,6 +1166,7 @@ export interface DescribeHealthServiceStatusForOrganizationResponse {
1068
1166
  healthServiceAccessStatusForOrganization?: string;
1069
1167
  }
1070
1168
  /**
1169
+ * @public
1071
1170
  * <p>
1072
1171
  * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a> is already in progress. Wait for the
1073
1172
  * 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>
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { DescribeAffectedAccountsForOrganizationCommandInput, DescribeAffectedAccountsForOrganizationCommandOutput } from "../commands/DescribeAffectedAccountsForOrganizationCommand";
3
3
  import { HealthPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateDescribeAffectedAccountsForOrganization(config: HealthPaginationConfiguration, input: DescribeAffectedAccountsForOrganizationCommandInput, ...additionalArguments: any): Paginator<DescribeAffectedAccountsForOrganizationCommandOutput>;
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { DescribeAffectedEntitiesForOrganizationCommandInput, DescribeAffectedEntitiesForOrganizationCommandOutput } from "../commands/DescribeAffectedEntitiesForOrganizationCommand";
3
3
  import { HealthPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateDescribeAffectedEntitiesForOrganization(config: HealthPaginationConfiguration, input: DescribeAffectedEntitiesForOrganizationCommandInput, ...additionalArguments: any): Paginator<DescribeAffectedEntitiesForOrganizationCommandOutput>;
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { DescribeAffectedEntitiesCommandInput, DescribeAffectedEntitiesCommandOutput } from "../commands/DescribeAffectedEntitiesCommand";
3
3
  import { HealthPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateDescribeAffectedEntities(config: HealthPaginationConfiguration, input: DescribeAffectedEntitiesCommandInput, ...additionalArguments: any): Paginator<DescribeAffectedEntitiesCommandOutput>;
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { DescribeEventAggregatesCommandInput, DescribeEventAggregatesCommandOutput } from "../commands/DescribeEventAggregatesCommand";
3
3
  import { HealthPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateDescribeEventAggregates(config: HealthPaginationConfiguration, input: DescribeEventAggregatesCommandInput, ...additionalArguments: any): Paginator<DescribeEventAggregatesCommandOutput>;
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { DescribeEventTypesCommandInput, DescribeEventTypesCommandOutput } from "../commands/DescribeEventTypesCommand";
3
3
  import { HealthPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateDescribeEventTypes(config: HealthPaginationConfiguration, input: DescribeEventTypesCommandInput, ...additionalArguments: any): Paginator<DescribeEventTypesCommandOutput>;
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { DescribeEventsForOrganizationCommandInput, DescribeEventsForOrganizationCommandOutput } from "../commands/DescribeEventsForOrganizationCommand";
3
3
  import { HealthPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateDescribeEventsForOrganization(config: HealthPaginationConfiguration, input: DescribeEventsForOrganizationCommandInput, ...additionalArguments: any): Paginator<DescribeEventsForOrganizationCommandOutput>;