@aws-sdk/client-health 3.315.0 → 3.319.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 (5) hide show
  1. package/dist-cjs/Health.js +17 -182
  2. package/dist-es/Health.js +17 -182
  3. package/dist-types/Health.d.ts +68 -268
  4. package/dist-types/ts3.4/Health.d.ts +2 -1
  5. package/package.json +8 -8
package/dist-cjs/Health.js CHANGED
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.Health = void 0;
4
+ const smithy_client_1 = require("@aws-sdk/smithy-client");
4
5
  const DescribeAffectedAccountsForOrganizationCommand_1 = require("./commands/DescribeAffectedAccountsForOrganizationCommand");
5
6
  const DescribeAffectedEntitiesCommand_1 = require("./commands/DescribeAffectedEntitiesCommand");
6
7
  const DescribeAffectedEntitiesForOrganizationCommand_1 = require("./commands/DescribeAffectedEntitiesForOrganizationCommand");
@@ -15,188 +16,22 @@ const DescribeHealthServiceStatusForOrganizationCommand_1 = require("./commands/
15
16
  const DisableHealthServiceAccessForOrganizationCommand_1 = require("./commands/DisableHealthServiceAccessForOrganizationCommand");
16
17
  const EnableHealthServiceAccessForOrganizationCommand_1 = require("./commands/EnableHealthServiceAccessForOrganizationCommand");
17
18
  const HealthClient_1 = require("./HealthClient");
19
+ const commands = {
20
+ DescribeAffectedAccountsForOrganizationCommand: DescribeAffectedAccountsForOrganizationCommand_1.DescribeAffectedAccountsForOrganizationCommand,
21
+ DescribeAffectedEntitiesCommand: DescribeAffectedEntitiesCommand_1.DescribeAffectedEntitiesCommand,
22
+ DescribeAffectedEntitiesForOrganizationCommand: DescribeAffectedEntitiesForOrganizationCommand_1.DescribeAffectedEntitiesForOrganizationCommand,
23
+ DescribeEntityAggregatesCommand: DescribeEntityAggregatesCommand_1.DescribeEntityAggregatesCommand,
24
+ DescribeEventAggregatesCommand: DescribeEventAggregatesCommand_1.DescribeEventAggregatesCommand,
25
+ DescribeEventDetailsCommand: DescribeEventDetailsCommand_1.DescribeEventDetailsCommand,
26
+ DescribeEventDetailsForOrganizationCommand: DescribeEventDetailsForOrganizationCommand_1.DescribeEventDetailsForOrganizationCommand,
27
+ DescribeEventsCommand: DescribeEventsCommand_1.DescribeEventsCommand,
28
+ DescribeEventsForOrganizationCommand: DescribeEventsForOrganizationCommand_1.DescribeEventsForOrganizationCommand,
29
+ DescribeEventTypesCommand: DescribeEventTypesCommand_1.DescribeEventTypesCommand,
30
+ DescribeHealthServiceStatusForOrganizationCommand: DescribeHealthServiceStatusForOrganizationCommand_1.DescribeHealthServiceStatusForOrganizationCommand,
31
+ DisableHealthServiceAccessForOrganizationCommand: DisableHealthServiceAccessForOrganizationCommand_1.DisableHealthServiceAccessForOrganizationCommand,
32
+ EnableHealthServiceAccessForOrganizationCommand: EnableHealthServiceAccessForOrganizationCommand_1.EnableHealthServiceAccessForOrganizationCommand,
33
+ };
18
34
  class Health extends HealthClient_1.HealthClient {
19
- describeAffectedAccountsForOrganization(args, optionsOrCb, cb) {
20
- const command = new DescribeAffectedAccountsForOrganizationCommand_1.DescribeAffectedAccountsForOrganizationCommand(args);
21
- if (typeof optionsOrCb === "function") {
22
- this.send(command, optionsOrCb);
23
- }
24
- else if (typeof cb === "function") {
25
- if (typeof optionsOrCb !== "object")
26
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
27
- this.send(command, optionsOrCb || {}, cb);
28
- }
29
- else {
30
- return this.send(command, optionsOrCb);
31
- }
32
- }
33
- describeAffectedEntities(args, optionsOrCb, cb) {
34
- const command = new DescribeAffectedEntitiesCommand_1.DescribeAffectedEntitiesCommand(args);
35
- if (typeof optionsOrCb === "function") {
36
- this.send(command, optionsOrCb);
37
- }
38
- else if (typeof cb === "function") {
39
- if (typeof optionsOrCb !== "object")
40
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
41
- this.send(command, optionsOrCb || {}, cb);
42
- }
43
- else {
44
- return this.send(command, optionsOrCb);
45
- }
46
- }
47
- describeAffectedEntitiesForOrganization(args, optionsOrCb, cb) {
48
- const command = new DescribeAffectedEntitiesForOrganizationCommand_1.DescribeAffectedEntitiesForOrganizationCommand(args);
49
- if (typeof optionsOrCb === "function") {
50
- this.send(command, optionsOrCb);
51
- }
52
- else if (typeof cb === "function") {
53
- if (typeof optionsOrCb !== "object")
54
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
55
- this.send(command, optionsOrCb || {}, cb);
56
- }
57
- else {
58
- return this.send(command, optionsOrCb);
59
- }
60
- }
61
- describeEntityAggregates(args, optionsOrCb, cb) {
62
- const command = new DescribeEntityAggregatesCommand_1.DescribeEntityAggregatesCommand(args);
63
- if (typeof optionsOrCb === "function") {
64
- this.send(command, optionsOrCb);
65
- }
66
- else if (typeof cb === "function") {
67
- if (typeof optionsOrCb !== "object")
68
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
69
- this.send(command, optionsOrCb || {}, cb);
70
- }
71
- else {
72
- return this.send(command, optionsOrCb);
73
- }
74
- }
75
- describeEventAggregates(args, optionsOrCb, cb) {
76
- const command = new DescribeEventAggregatesCommand_1.DescribeEventAggregatesCommand(args);
77
- if (typeof optionsOrCb === "function") {
78
- this.send(command, optionsOrCb);
79
- }
80
- else if (typeof cb === "function") {
81
- if (typeof optionsOrCb !== "object")
82
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
83
- this.send(command, optionsOrCb || {}, cb);
84
- }
85
- else {
86
- return this.send(command, optionsOrCb);
87
- }
88
- }
89
- describeEventDetails(args, optionsOrCb, cb) {
90
- const command = new DescribeEventDetailsCommand_1.DescribeEventDetailsCommand(args);
91
- if (typeof optionsOrCb === "function") {
92
- this.send(command, optionsOrCb);
93
- }
94
- else if (typeof cb === "function") {
95
- if (typeof optionsOrCb !== "object")
96
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
97
- this.send(command, optionsOrCb || {}, cb);
98
- }
99
- else {
100
- return this.send(command, optionsOrCb);
101
- }
102
- }
103
- describeEventDetailsForOrganization(args, optionsOrCb, cb) {
104
- const command = new DescribeEventDetailsForOrganizationCommand_1.DescribeEventDetailsForOrganizationCommand(args);
105
- if (typeof optionsOrCb === "function") {
106
- this.send(command, optionsOrCb);
107
- }
108
- else if (typeof cb === "function") {
109
- if (typeof optionsOrCb !== "object")
110
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
111
- this.send(command, optionsOrCb || {}, cb);
112
- }
113
- else {
114
- return this.send(command, optionsOrCb);
115
- }
116
- }
117
- describeEvents(args, optionsOrCb, cb) {
118
- const command = new DescribeEventsCommand_1.DescribeEventsCommand(args);
119
- if (typeof optionsOrCb === "function") {
120
- this.send(command, optionsOrCb);
121
- }
122
- else if (typeof cb === "function") {
123
- if (typeof optionsOrCb !== "object")
124
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
125
- this.send(command, optionsOrCb || {}, cb);
126
- }
127
- else {
128
- return this.send(command, optionsOrCb);
129
- }
130
- }
131
- describeEventsForOrganization(args, optionsOrCb, cb) {
132
- const command = new DescribeEventsForOrganizationCommand_1.DescribeEventsForOrganizationCommand(args);
133
- if (typeof optionsOrCb === "function") {
134
- this.send(command, optionsOrCb);
135
- }
136
- else if (typeof cb === "function") {
137
- if (typeof optionsOrCb !== "object")
138
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
139
- this.send(command, optionsOrCb || {}, cb);
140
- }
141
- else {
142
- return this.send(command, optionsOrCb);
143
- }
144
- }
145
- describeEventTypes(args, optionsOrCb, cb) {
146
- const command = new DescribeEventTypesCommand_1.DescribeEventTypesCommand(args);
147
- if (typeof optionsOrCb === "function") {
148
- this.send(command, optionsOrCb);
149
- }
150
- else if (typeof cb === "function") {
151
- if (typeof optionsOrCb !== "object")
152
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
153
- this.send(command, optionsOrCb || {}, cb);
154
- }
155
- else {
156
- return this.send(command, optionsOrCb);
157
- }
158
- }
159
- describeHealthServiceStatusForOrganization(args, optionsOrCb, cb) {
160
- const command = new DescribeHealthServiceStatusForOrganizationCommand_1.DescribeHealthServiceStatusForOrganizationCommand(args);
161
- if (typeof optionsOrCb === "function") {
162
- this.send(command, optionsOrCb);
163
- }
164
- else if (typeof cb === "function") {
165
- if (typeof optionsOrCb !== "object")
166
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
167
- this.send(command, optionsOrCb || {}, cb);
168
- }
169
- else {
170
- return this.send(command, optionsOrCb);
171
- }
172
- }
173
- disableHealthServiceAccessForOrganization(args, optionsOrCb, cb) {
174
- const command = new DisableHealthServiceAccessForOrganizationCommand_1.DisableHealthServiceAccessForOrganizationCommand(args);
175
- if (typeof optionsOrCb === "function") {
176
- this.send(command, optionsOrCb);
177
- }
178
- else if (typeof cb === "function") {
179
- if (typeof optionsOrCb !== "object")
180
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
181
- this.send(command, optionsOrCb || {}, cb);
182
- }
183
- else {
184
- return this.send(command, optionsOrCb);
185
- }
186
- }
187
- enableHealthServiceAccessForOrganization(args, optionsOrCb, cb) {
188
- const command = new EnableHealthServiceAccessForOrganizationCommand_1.EnableHealthServiceAccessForOrganizationCommand(args);
189
- if (typeof optionsOrCb === "function") {
190
- this.send(command, optionsOrCb);
191
- }
192
- else if (typeof cb === "function") {
193
- if (typeof optionsOrCb !== "object")
194
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
195
- this.send(command, optionsOrCb || {}, cb);
196
- }
197
- else {
198
- return this.send(command, optionsOrCb);
199
- }
200
- }
201
35
  }
202
36
  exports.Health = Health;
37
+ (0, smithy_client_1.createAggregatedClient)(commands, Health);
package/dist-es/Health.js CHANGED
@@ -1,3 +1,4 @@
1
+ import { createAggregatedClient } from "@aws-sdk/smithy-client";
1
2
  import { DescribeAffectedAccountsForOrganizationCommand, } from "./commands/DescribeAffectedAccountsForOrganizationCommand";
2
3
  import { DescribeAffectedEntitiesCommand, } from "./commands/DescribeAffectedEntitiesCommand";
3
4
  import { DescribeAffectedEntitiesForOrganizationCommand, } from "./commands/DescribeAffectedEntitiesForOrganizationCommand";
@@ -12,187 +13,21 @@ import { DescribeHealthServiceStatusForOrganizationCommand, } from "./commands/D
12
13
  import { DisableHealthServiceAccessForOrganizationCommand, } from "./commands/DisableHealthServiceAccessForOrganizationCommand";
13
14
  import { EnableHealthServiceAccessForOrganizationCommand, } from "./commands/EnableHealthServiceAccessForOrganizationCommand";
14
15
  import { HealthClient } from "./HealthClient";
16
+ const commands = {
17
+ DescribeAffectedAccountsForOrganizationCommand,
18
+ DescribeAffectedEntitiesCommand,
19
+ DescribeAffectedEntitiesForOrganizationCommand,
20
+ DescribeEntityAggregatesCommand,
21
+ DescribeEventAggregatesCommand,
22
+ DescribeEventDetailsCommand,
23
+ DescribeEventDetailsForOrganizationCommand,
24
+ DescribeEventsCommand,
25
+ DescribeEventsForOrganizationCommand,
26
+ DescribeEventTypesCommand,
27
+ DescribeHealthServiceStatusForOrganizationCommand,
28
+ DisableHealthServiceAccessForOrganizationCommand,
29
+ EnableHealthServiceAccessForOrganizationCommand,
30
+ };
15
31
  export class Health extends HealthClient {
16
- describeAffectedAccountsForOrganization(args, optionsOrCb, cb) {
17
- const command = new DescribeAffectedAccountsForOrganizationCommand(args);
18
- if (typeof optionsOrCb === "function") {
19
- this.send(command, optionsOrCb);
20
- }
21
- else if (typeof cb === "function") {
22
- if (typeof optionsOrCb !== "object")
23
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
24
- this.send(command, optionsOrCb || {}, cb);
25
- }
26
- else {
27
- return this.send(command, optionsOrCb);
28
- }
29
- }
30
- describeAffectedEntities(args, optionsOrCb, cb) {
31
- const command = new DescribeAffectedEntitiesCommand(args);
32
- if (typeof optionsOrCb === "function") {
33
- this.send(command, optionsOrCb);
34
- }
35
- else if (typeof cb === "function") {
36
- if (typeof optionsOrCb !== "object")
37
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
38
- this.send(command, optionsOrCb || {}, cb);
39
- }
40
- else {
41
- return this.send(command, optionsOrCb);
42
- }
43
- }
44
- describeAffectedEntitiesForOrganization(args, optionsOrCb, cb) {
45
- const command = new DescribeAffectedEntitiesForOrganizationCommand(args);
46
- if (typeof optionsOrCb === "function") {
47
- this.send(command, optionsOrCb);
48
- }
49
- else if (typeof cb === "function") {
50
- if (typeof optionsOrCb !== "object")
51
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
52
- this.send(command, optionsOrCb || {}, cb);
53
- }
54
- else {
55
- return this.send(command, optionsOrCb);
56
- }
57
- }
58
- describeEntityAggregates(args, optionsOrCb, cb) {
59
- const command = new DescribeEntityAggregatesCommand(args);
60
- if (typeof optionsOrCb === "function") {
61
- this.send(command, optionsOrCb);
62
- }
63
- else if (typeof cb === "function") {
64
- if (typeof optionsOrCb !== "object")
65
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
66
- this.send(command, optionsOrCb || {}, cb);
67
- }
68
- else {
69
- return this.send(command, optionsOrCb);
70
- }
71
- }
72
- describeEventAggregates(args, optionsOrCb, cb) {
73
- const command = new DescribeEventAggregatesCommand(args);
74
- if (typeof optionsOrCb === "function") {
75
- this.send(command, optionsOrCb);
76
- }
77
- else if (typeof cb === "function") {
78
- if (typeof optionsOrCb !== "object")
79
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
80
- this.send(command, optionsOrCb || {}, cb);
81
- }
82
- else {
83
- return this.send(command, optionsOrCb);
84
- }
85
- }
86
- describeEventDetails(args, optionsOrCb, cb) {
87
- const command = new DescribeEventDetailsCommand(args);
88
- if (typeof optionsOrCb === "function") {
89
- this.send(command, optionsOrCb);
90
- }
91
- else if (typeof cb === "function") {
92
- if (typeof optionsOrCb !== "object")
93
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
94
- this.send(command, optionsOrCb || {}, cb);
95
- }
96
- else {
97
- return this.send(command, optionsOrCb);
98
- }
99
- }
100
- describeEventDetailsForOrganization(args, optionsOrCb, cb) {
101
- const command = new DescribeEventDetailsForOrganizationCommand(args);
102
- if (typeof optionsOrCb === "function") {
103
- this.send(command, optionsOrCb);
104
- }
105
- else if (typeof cb === "function") {
106
- if (typeof optionsOrCb !== "object")
107
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
108
- this.send(command, optionsOrCb || {}, cb);
109
- }
110
- else {
111
- return this.send(command, optionsOrCb);
112
- }
113
- }
114
- describeEvents(args, optionsOrCb, cb) {
115
- const command = new DescribeEventsCommand(args);
116
- if (typeof optionsOrCb === "function") {
117
- this.send(command, optionsOrCb);
118
- }
119
- else if (typeof cb === "function") {
120
- if (typeof optionsOrCb !== "object")
121
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
122
- this.send(command, optionsOrCb || {}, cb);
123
- }
124
- else {
125
- return this.send(command, optionsOrCb);
126
- }
127
- }
128
- describeEventsForOrganization(args, optionsOrCb, cb) {
129
- const command = new DescribeEventsForOrganizationCommand(args);
130
- if (typeof optionsOrCb === "function") {
131
- this.send(command, optionsOrCb);
132
- }
133
- else if (typeof cb === "function") {
134
- if (typeof optionsOrCb !== "object")
135
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
136
- this.send(command, optionsOrCb || {}, cb);
137
- }
138
- else {
139
- return this.send(command, optionsOrCb);
140
- }
141
- }
142
- describeEventTypes(args, optionsOrCb, cb) {
143
- const command = new DescribeEventTypesCommand(args);
144
- if (typeof optionsOrCb === "function") {
145
- this.send(command, optionsOrCb);
146
- }
147
- else if (typeof cb === "function") {
148
- if (typeof optionsOrCb !== "object")
149
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
150
- this.send(command, optionsOrCb || {}, cb);
151
- }
152
- else {
153
- return this.send(command, optionsOrCb);
154
- }
155
- }
156
- describeHealthServiceStatusForOrganization(args, optionsOrCb, cb) {
157
- const command = new DescribeHealthServiceStatusForOrganizationCommand(args);
158
- if (typeof optionsOrCb === "function") {
159
- this.send(command, optionsOrCb);
160
- }
161
- else if (typeof cb === "function") {
162
- if (typeof optionsOrCb !== "object")
163
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
164
- this.send(command, optionsOrCb || {}, cb);
165
- }
166
- else {
167
- return this.send(command, optionsOrCb);
168
- }
169
- }
170
- disableHealthServiceAccessForOrganization(args, optionsOrCb, cb) {
171
- const command = new DisableHealthServiceAccessForOrganizationCommand(args);
172
- if (typeof optionsOrCb === "function") {
173
- this.send(command, optionsOrCb);
174
- }
175
- else if (typeof cb === "function") {
176
- if (typeof optionsOrCb !== "object")
177
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
178
- this.send(command, optionsOrCb || {}, cb);
179
- }
180
- else {
181
- return this.send(command, optionsOrCb);
182
- }
183
- }
184
- enableHealthServiceAccessForOrganization(args, optionsOrCb, cb) {
185
- const command = new EnableHealthServiceAccessForOrganizationCommand(args);
186
- if (typeof optionsOrCb === "function") {
187
- this.send(command, optionsOrCb);
188
- }
189
- else if (typeof cb === "function") {
190
- if (typeof optionsOrCb !== "object")
191
- throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
192
- this.send(command, optionsOrCb || {}, cb);
193
- }
194
- else {
195
- return this.send(command, optionsOrCb);
196
- }
197
- }
198
32
  }
33
+ createAggregatedClient(commands, Health);
package/dist-types/Health.d.ts CHANGED
@@ -13,337 +13,137 @@ import { DescribeHealthServiceStatusForOrganizationCommandInput, DescribeHealthS
13
13
  import { DisableHealthServiceAccessForOrganizationCommandInput, DisableHealthServiceAccessForOrganizationCommandOutput } from "./commands/DisableHealthServiceAccessForOrganizationCommand";
14
14
  import { EnableHealthServiceAccessForOrganizationCommandInput, EnableHealthServiceAccessForOrganizationCommandOutput } from "./commands/EnableHealthServiceAccessForOrganizationCommand";
15
15
  import { HealthClient } from "./HealthClient";
16
- /**
17
- * @public
18
- * <fullname>Health</fullname>
19
- *
20
- * <p>The Health API provides programmatic access to the Health information that
21
- * appears in the <a href="https://phd.aws.amazon.com/phd/home#/">Personal Health Dashboard</a>. You
22
- * can use the API operations to get information about events that might affect your Amazon Web Services services and resources.</p>
23
- * <note>
24
- * <ul>
25
- * <li>
26
- * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the Health
27
- * API. If you call the Health API from an Amazon Web Services account that
28
- * doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
29
- * <code>SubscriptionRequiredException</code> error.</p>
30
- * </li>
31
- * <li>
32
- * <p>You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to
33
- * call the Health API operations. Health supports a multi-Region
34
- * application architecture and has two regional endpoints in an active-passive
35
- * configuration. You can use the high availability endpoint example to determine
36
- * which Amazon Web Services Region is active, so that you can get the latest information from the
37
- * API. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/health-api.html">Accessing the Health API</a> in the
38
- * <i>Health User Guide</i>.</p>
39
- * </li>
40
- * </ul>
41
- * </note>
42
- * <p>For authentication of requests, Health uses the <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing
43
- * Process</a>.</p>
44
- * <p>If your Amazon Web Services account is part of Organizations, you can use the Health organizational
45
- * view feature. This feature provides a centralized view of Health events across all
46
- * accounts in your organization. You can aggregate Health events in real time to
47
- * identify accounts in your organization that are affected by an operational event or get
48
- * notified of security vulnerabilities. Use the organizational view API operations to enable
49
- * this feature and return event information. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html">Aggregating
50
- * Health events</a> in the <i>Health User Guide</i>.</p>
51
- * <note>
52
- * <p>When you use the Health API operations to return Health events, see the
53
- * following recommendations:</p>
54
- * <ul>
55
- * <li>
56
- * <p>Use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode">eventScopeCode</a> parameter to specify whether to return Health
57
- * events that are public or account-specific.</p>
58
- * </li>
59
- * <li>
60
- * <p>Use pagination to view all events from the response. For example, if you call
61
- * the <code>DescribeEventsForOrganization</code> operation to get all events in your
62
- * organization, you might receive several page results. Specify the
63
- * <code>nextToken</code> in the next request to return more results.</p>
64
- * </li>
65
- * </ul>
66
- * </note>
67
- */
68
- export declare class Health extends HealthClient {
16
+ export interface Health {
69
17
  /**
70
- * @public
71
- * <p>Returns a list of accounts in the organization from Organizations that are affected by the
72
- * provided event. For more information about the different types of Health events, see
73
- * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>. </p>
74
- * <p>Before you can call this operation, you must first enable Health to work with
75
- * Organizations. To do this, call the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a> operation from your organization's
76
- * management account.</p>
77
- * <note>
78
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
79
- * </note>
18
+ * @see {@link DescribeAffectedAccountsForOrganizationCommand}
80
19
  */
81
20
  describeAffectedAccountsForOrganization(args: DescribeAffectedAccountsForOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAffectedAccountsForOrganizationCommandOutput>;
82
21
  describeAffectedAccountsForOrganization(args: DescribeAffectedAccountsForOrganizationCommandInput, cb: (err: any, data?: DescribeAffectedAccountsForOrganizationCommandOutput) => void): void;
83
22
  describeAffectedAccountsForOrganization(args: DescribeAffectedAccountsForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAffectedAccountsForOrganizationCommandOutput) => void): void;
84
23
  /**
85
- * @public
86
- * <p>Returns a list of entities that have been affected by the specified events, based on the
87
- * specified filter criteria. Entities can refer to individual customer resources, groups of
88
- * customer resources, or any other construct, depending on the Amazon Web Services service. Events that
89
- * have impact beyond that of the affected entities, or where the extent of impact is unknown,
90
- * include at least one entity indicating this.</p>
91
- * <p>At least one event ARN is required.</p>
92
- *
93
- * <note>
94
- * <ul>
95
- * <li>
96
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
97
- * </li>
98
- * <li>
99
- * <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more
100
- * information, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in the <i>Health User Guide</i>.</p>
101
- * </li>
102
- * </ul>
103
- * </note>
24
+ * @see {@link DescribeAffectedEntitiesCommand}
104
25
  */
105
26
  describeAffectedEntities(args: DescribeAffectedEntitiesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAffectedEntitiesCommandOutput>;
106
27
  describeAffectedEntities(args: DescribeAffectedEntitiesCommandInput, cb: (err: any, data?: DescribeAffectedEntitiesCommandOutput) => void): void;
107
28
  describeAffectedEntities(args: DescribeAffectedEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAffectedEntitiesCommandOutput) => void): void;
108
29
  /**
109
- * @public
110
- * <p>Returns a list of entities that have been affected by one or more events for one or more
111
- * accounts in your organization in Organizations, based on the filter criteria. Entities can refer
112
- * to individual customer resources, groups of customer resources, or any other construct,
113
- * depending on the Amazon Web Services service.</p>
114
- * <p>At least one event Amazon Resource Name (ARN) and account ID are required.</p>
115
- * <p>Before you can call this operation, you must first enable Health to work with
116
- * Organizations. To do this, call the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a> operation from your organization's
117
- * management account.</p>
118
- * <note>
119
- * <ul>
120
- * <li>
121
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
122
- * </li>
123
- * <li>
124
- * <p>This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more
125
- * information, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in the <i>Health User Guide</i>.</p>
126
- * </li>
127
- * </ul>
128
- *
129
- * </note>
30
+ * @see {@link DescribeAffectedEntitiesForOrganizationCommand}
130
31
  */
131
32
  describeAffectedEntitiesForOrganization(args: DescribeAffectedEntitiesForOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAffectedEntitiesForOrganizationCommandOutput>;
132
33
  describeAffectedEntitiesForOrganization(args: DescribeAffectedEntitiesForOrganizationCommandInput, cb: (err: any, data?: DescribeAffectedEntitiesForOrganizationCommandOutput) => void): void;
133
34
  describeAffectedEntitiesForOrganization(args: DescribeAffectedEntitiesForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAffectedEntitiesForOrganizationCommandOutput) => void): void;
134
35
  /**
135
- * @public
136
- * <p>Returns the number of entities that are affected by each of the specified events.</p>
36
+ * @see {@link DescribeEntityAggregatesCommand}
137
37
  */
138
38
  describeEntityAggregates(args: DescribeEntityAggregatesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEntityAggregatesCommandOutput>;
139
39
  describeEntityAggregates(args: DescribeEntityAggregatesCommandInput, cb: (err: any, data?: DescribeEntityAggregatesCommandOutput) => void): void;
140
40
  describeEntityAggregates(args: DescribeEntityAggregatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEntityAggregatesCommandOutput) => void): void;
141
41
  /**
142
- * @public
143
- * <p>Returns the number of events of each event type (issue, scheduled change, and account
144
- * notification). If no filter is specified, the counts of all events in each category are
145
- * returned.</p>
146
- * <note>
147
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
148
- * </note>
42
+ * @see {@link DescribeEventAggregatesCommand}
149
43
  */
150
44
  describeEventAggregates(args: DescribeEventAggregatesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventAggregatesCommandOutput>;
151
45
  describeEventAggregates(args: DescribeEventAggregatesCommandInput, cb: (err: any, data?: DescribeEventAggregatesCommandOutput) => void): void;
152
46
  describeEventAggregates(args: DescribeEventAggregatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventAggregatesCommandOutput) => void): void;
153
47
  /**
154
- * @public
155
- * <p>Returns detailed information about one or more specified events. Information includes
156
- * standard event data (Amazon Web Services Region, service, and so on, as returned by <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html">DescribeEvents</a>), a detailed event description, and possible additional metadata
157
- * that depends upon the nature of the event. Affected entities are not included. To retrieve
158
- * the entities, use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html">DescribeAffectedEntities</a> operation.</p>
159
- * <p>If a specified event can't be retrieved, an error message is returned for that
160
- * event.</p>
161
- * <note>
162
- * <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more
163
- * information, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in the <i>Health User Guide</i>.</p>
164
- * </note>
48
+ * @see {@link DescribeEventDetailsCommand}
165
49
  */
166
50
  describeEventDetails(args: DescribeEventDetailsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventDetailsCommandOutput>;
167
51
  describeEventDetails(args: DescribeEventDetailsCommandInput, cb: (err: any, data?: DescribeEventDetailsCommandOutput) => void): void;
168
52
  describeEventDetails(args: DescribeEventDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventDetailsCommandOutput) => void): void;
169
53
  /**
170
- * @public
171
- * <p>Returns detailed information about one or more specified events for one or more
172
- * Amazon Web Services accounts in your organization. This information includes standard event data (such as
173
- * the Amazon Web Services Region and service), an event description, and (depending on the event) possible
174
- * metadata. This operation doesn't return affected entities, such as the resources related to
175
- * the event. To return affected entities, use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html">DescribeAffectedEntitiesForOrganization</a> operation.</p>
176
- * <note>
177
- * <p>Before you can call this operation, you must first enable Health to work with
178
- * Organizations. To do this, call the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a> operation from your organization's
179
- * management account.</p>
180
- * </note>
181
- * <p>When you call the <code>DescribeEventDetailsForOrganization</code> operation, specify
182
- * the <code>organizationEventDetailFilters</code> object in the request. Depending on the
183
- * Health event type, note the following differences:</p>
184
- * <ul>
185
- * <li>
186
- * <p>To return event details for a public event, you must specify a null value for the
187
- * <code>awsAccountId</code> parameter. If you specify an account ID for a public
188
- * event, Health returns an error message because public events aren't specific to
189
- * an account.</p>
190
- * </li>
191
- * <li>
192
- * <p>To return event details for an event that is specific to an account in your
193
- * organization, you must specify the <code>awsAccountId</code> parameter in the
194
- * request. If you don't specify an account ID, Health returns an error message
195
- * because the event is specific to an account in your organization. </p>
196
- * </li>
197
- * </ul>
198
- * <p>For more information, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p>
199
- *
200
- * <note>
201
- * <p>This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more
202
- * information, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in the <i>Health User Guide</i>.</p>
203
- * </note>
54
+ * @see {@link DescribeEventDetailsForOrganizationCommand}
204
55
  */
205
56
  describeEventDetailsForOrganization(args: DescribeEventDetailsForOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventDetailsForOrganizationCommandOutput>;
206
57
  describeEventDetailsForOrganization(args: DescribeEventDetailsForOrganizationCommandInput, cb: (err: any, data?: DescribeEventDetailsForOrganizationCommandOutput) => void): void;
207
58
  describeEventDetailsForOrganization(args: DescribeEventDetailsForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventDetailsForOrganizationCommandOutput) => void): void;
208
59
  /**
209
- * @public
210
- * <p> Returns information about events that meet the specified filter criteria. Events are
211
- * returned in a summary form and do not include the detailed description, any additional
212
- * metadata that depends on the event type, or any affected resources. To retrieve that
213
- * information, use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html">DescribeEventDetails</a> and <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html">DescribeAffectedEntities</a> operations.</p>
214
- * <p>If no filter criteria are specified, all events are returned. Results are sorted by
215
- * <code>lastModifiedTime</code>, starting with the most recent event.</p>
216
- * <note>
217
- * <ul>
218
- * <li>
219
- * <p>When you call the <code>DescribeEvents</code> operation and specify an entity
220
- * for the <code>entityValues</code> parameter, Health might return public
221
- * events that aren't specific to that resource. For example, if you call
222
- * <code>DescribeEvents</code> and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2)
223
- * instance, Health might return events that aren't specific to that resource or
224
- * service. To get events that are specific to a service, use the
225
- * <code>services</code> parameter in the <code>filter</code> object. For more
226
- * information, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p>
227
- * </li>
228
- * <li>
229
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
230
- * </li>
231
- * </ul>
232
- * </note>
60
+ * @see {@link DescribeEventsCommand}
233
61
  */
234
62
  describeEvents(args: DescribeEventsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventsCommandOutput>;
235
63
  describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void;
236
64
  describeEvents(args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void;
237
65
  /**
238
- * @public
239
- * <p>Returns information about events across your organization in Organizations. You can use
240
- * the<code>filters</code> parameter to specify the events that you want to return. Events
241
- * are returned in a summary form and don't include the affected accounts, detailed
242
- * description, any additional metadata that depends on the event type, or any affected
243
- * resources. To retrieve that information, use the following operations:</p>
244
- * <ul>
245
- * <li>
246
- * <p>
247
- * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedAccountsForOrganization.html">DescribeAffectedAccountsForOrganization</a>
248
- * </p>
249
- * </li>
250
- * <li>
251
- * <p>
252
- * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html">DescribeEventDetailsForOrganization</a>
253
- * </p>
254
- * </li>
255
- * <li>
256
- * <p>
257
- * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html">DescribeAffectedEntitiesForOrganization</a>
258
- * </p>
259
- * </li>
260
- * </ul>
261
- * <p>If you don't specify a <code>filter</code>, the
262
- * <code>DescribeEventsForOrganizations</code> returns all events across your organization.
263
- * Results are sorted by <code>lastModifiedTime</code>, starting with the most recent event. </p>
264
- * <p>For more information about the different types of Health events, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p>
265
- * <p>Before you can call this operation, you must first enable Health to work with
266
- * Organizations. To do this, call the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a> operation from your organization's
267
- * management account.</p>
268
- * <note>
269
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
270
- * </note>
66
+ * @see {@link DescribeEventsForOrganizationCommand}
271
67
  */
272
68
  describeEventsForOrganization(args: DescribeEventsForOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventsForOrganizationCommandOutput>;
273
69
  describeEventsForOrganization(args: DescribeEventsForOrganizationCommandInput, cb: (err: any, data?: DescribeEventsForOrganizationCommandOutput) => void): void;
274
70
  describeEventsForOrganization(args: DescribeEventsForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsForOrganizationCommandOutput) => void): void;
275
71
  /**
276
- * @public
277
- * <p>Returns the event types that meet the specified filter criteria. You can use this API
278
- * operation to find information about the Health event, such as the category, Amazon Web Services
279
- * service, and event code. The metadata for each event appears in the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EventType.html">EventType</a> object. </p>
280
- * <p>If you don't specify a filter criteria, the API operation returns all event types, in no
281
- * particular order. </p>
282
- * <note>
283
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
284
- * </note>
72
+ * @see {@link DescribeEventTypesCommand}
285
73
  */
286
74
  describeEventTypes(args: DescribeEventTypesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventTypesCommandOutput>;
287
75
  describeEventTypes(args: DescribeEventTypesCommandInput, cb: (err: any, data?: DescribeEventTypesCommandOutput) => void): void;
288
76
  describeEventTypes(args: DescribeEventTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventTypesCommandOutput) => void): void;
289
77
  /**
290
- * @public
291
- * <p>This operation provides status information on enabling or disabling Health to work
292
- * with your organization. To call this operation, you must sign in as an IAM user, assume
293
- * an IAM role, or sign in as the root user (not recommended) in the organization's
294
- * management account.</p>
78
+ * @see {@link DescribeHealthServiceStatusForOrganizationCommand}
295
79
  */
296
80
  describeHealthServiceStatusForOrganization(args: DescribeHealthServiceStatusForOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeHealthServiceStatusForOrganizationCommandOutput>;
297
81
  describeHealthServiceStatusForOrganization(args: DescribeHealthServiceStatusForOrganizationCommandInput, cb: (err: any, data?: DescribeHealthServiceStatusForOrganizationCommandOutput) => void): void;
298
82
  describeHealthServiceStatusForOrganization(args: DescribeHealthServiceStatusForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHealthServiceStatusForOrganizationCommandOutput) => void): void;
299
83
  /**
300
- * @public
301
- * <p>Disables Health from working with Organizations. To call this operation, you must sign
302
- * in as an Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not
303
- * 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
304
- * Health events</a> in the <i>Health User Guide</i>.</p>
305
- * <p>This operation doesn't remove the service-linked role from the management account in your
306
- * organization. You must use the IAM console, API, or Command Line Interface (CLI) to remove the
307
- * service-linked role. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#delete-service-linked-role">Deleting a Service-Linked Role</a> in the
308
- * <i>IAM User Guide</i>.</p>
309
- * <note>
310
- * <p>You can also disable the organizational feature by using the Organizations <a href="https://docs.aws.amazon.com/organizations/latest/APIReference/API_DisableAWSServiceAccess.html">DisableAWSServiceAccess</a> API operation. After you call this operation,
311
- * Health stops aggregating events for all other Amazon Web Services accounts in your organization.
312
- * If you call the Health API operations for organizational view, Health returns
313
- * an error. Health continues to aggregate health events for your
314
- * Amazon Web Services account.</p>
315
- * </note>
84
+ * @see {@link DisableHealthServiceAccessForOrganizationCommand}
316
85
  */
317
86
  disableHealthServiceAccessForOrganization(args: DisableHealthServiceAccessForOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<DisableHealthServiceAccessForOrganizationCommandOutput>;
318
87
  disableHealthServiceAccessForOrganization(args: DisableHealthServiceAccessForOrganizationCommandInput, cb: (err: any, data?: DisableHealthServiceAccessForOrganizationCommandOutput) => void): void;
319
88
  disableHealthServiceAccessForOrganization(args: DisableHealthServiceAccessForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableHealthServiceAccessForOrganizationCommandOutput) => void): void;
320
89
  /**
321
- * @public
322
- * <p>Enables Health to work with Organizations. You can use the organizational view feature
323
- * to aggregate events from all Amazon Web Services accounts in your organization in a centralized location. </p>
324
- * <p>This operation also creates a service-linked role for the management account in the
325
- * organization. </p>
326
- * <note>
327
- * <p>To call this operation, you must meet the following requirements:</p>
328
- * <ul>
329
- * <li>
330
- * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the Health
331
- * API. If you call the Health API from an Amazon Web Services account that doesn't have a
332
- * Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
333
- * <code>SubscriptionRequiredException</code> error.</p>
334
- * </li>
335
- * <li>
336
- * <p>You must have permission to call this operation from the organization's
337
- * management account. For example IAM policies, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html">Health
338
- * identity-based policy examples</a>.</p>
339
- * </li>
340
- * </ul>
341
- * </note>
342
- * <p>If you don't have the required support plan, you can instead use the Health console
343
- * to enable the organizational view feature. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html">Aggregating
344
- * Health events</a> in the <i>Health User Guide</i>.</p>
90
+ * @see {@link EnableHealthServiceAccessForOrganizationCommand}
345
91
  */
346
92
  enableHealthServiceAccessForOrganization(args: EnableHealthServiceAccessForOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<EnableHealthServiceAccessForOrganizationCommandOutput>;
347
93
  enableHealthServiceAccessForOrganization(args: EnableHealthServiceAccessForOrganizationCommandInput, cb: (err: any, data?: EnableHealthServiceAccessForOrganizationCommandOutput) => void): void;
348
94
  enableHealthServiceAccessForOrganization(args: EnableHealthServiceAccessForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableHealthServiceAccessForOrganizationCommandOutput) => void): void;
349
95
  }
96
+ /**
97
+ * @public
98
+ * <fullname>Health</fullname>
99
+ *
100
+ * <p>The Health API provides programmatic access to the Health information that
101
+ * appears in the <a href="https://phd.aws.amazon.com/phd/home#/">Personal Health Dashboard</a>. You
102
+ * can use the API operations to get information about events that might affect your Amazon Web Services services and resources.</p>
103
+ * <note>
104
+ * <ul>
105
+ * <li>
106
+ * <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the Health
107
+ * API. If you call the Health API from an Amazon Web Services account that
108
+ * doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
109
+ * <code>SubscriptionRequiredException</code> error.</p>
110
+ * </li>
111
+ * <li>
112
+ * <p>You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to
113
+ * call the Health API operations. Health supports a multi-Region
114
+ * application architecture and has two regional endpoints in an active-passive
115
+ * configuration. You can use the high availability endpoint example to determine
116
+ * which Amazon Web Services Region is active, so that you can get the latest information from the
117
+ * API. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/health-api.html">Accessing the Health API</a> in the
118
+ * <i>Health User Guide</i>.</p>
119
+ * </li>
120
+ * </ul>
121
+ * </note>
122
+ * <p>For authentication of requests, Health uses the <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing
123
+ * Process</a>.</p>
124
+ * <p>If your Amazon Web Services account is part of Organizations, you can use the Health organizational
125
+ * view feature. This feature provides a centralized view of Health events across all
126
+ * accounts in your organization. You can aggregate Health events in real time to
127
+ * identify accounts in your organization that are affected by an operational event or get
128
+ * notified of security vulnerabilities. Use the organizational view API operations to enable
129
+ * this feature and return event information. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html">Aggregating
130
+ * Health events</a> in the <i>Health User Guide</i>.</p>
131
+ * <note>
132
+ * <p>When you use the Health API operations to return Health events, see the
133
+ * following recommendations:</p>
134
+ * <ul>
135
+ * <li>
136
+ * <p>Use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode">eventScopeCode</a> parameter to specify whether to return Health
137
+ * events that are public or account-specific.</p>
138
+ * </li>
139
+ * <li>
140
+ * <p>Use pagination to view all events from the response. For example, if you call
141
+ * the <code>DescribeEventsForOrganization</code> operation to get all events in your
142
+ * organization, you might receive several page results. Specify the
143
+ * <code>nextToken</code> in the next request to return more results.</p>
144
+ * </li>
145
+ * </ul>
146
+ * </note>
147
+ */
148
+ export declare class Health extends HealthClient implements Health {
149
+ }
package/dist-types/ts3.4/Health.d.ts CHANGED
@@ -52,7 +52,7 @@ import {
52
52
  EnableHealthServiceAccessForOrganizationCommandOutput,
53
53
  } from "./commands/EnableHealthServiceAccessForOrganizationCommand";
54
54
  import { HealthClient } from "./HealthClient";
55
- export declare class Health extends HealthClient {
55
+ export interface Health {
56
56
  describeAffectedAccountsForOrganization(
57
57
  args: DescribeAffectedAccountsForOrganizationCommandInput,
58
58
  options?: __HttpHandlerOptions
@@ -259,3 +259,4 @@ export declare class Health extends HealthClient {
259
259
  ) => void
260
260
  ): void;
261
261
  }
262
+ export declare class Health extends HealthClient implements Health {}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-health",
3
3
  "description": "AWS SDK for JavaScript Health Client for Node.js, Browser and React Native",
4
- "version": "3.315.0",
4
+ "version": "3.319.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.315.0",
24
+ "@aws-sdk/client-sts": "3.319.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.315.0",
26
+ "@aws-sdk/credential-provider-node": "3.319.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -36,19 +36,19 @@
36
36
  "@aws-sdk/middleware-serde": "3.310.0",
37
37
  "@aws-sdk/middleware-signing": "3.310.0",
38
38
  "@aws-sdk/middleware-stack": "3.310.0",
39
- "@aws-sdk/middleware-user-agent": "3.310.0",
39
+ "@aws-sdk/middleware-user-agent": "3.319.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.310.0",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.315.0",
43
+ "@aws-sdk/smithy-client": "3.316.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.315.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.315.0",
51
- "@aws-sdk/util-endpoints": "3.310.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.316.0",
51
+ "@aws-sdk/util-endpoints": "3.319.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",
54
54
  "@aws-sdk/util-user-agent-node": "3.310.0",