@aws-sdk/client-health 3.39.0 → 3.43.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.
- package/CHANGELOG.md +38 -0
- package/README.md +19 -19
- package/dist-cjs/endpoints.js +75 -15
- package/dist-cjs/runtimeConfig.browser.js +6 -3
- package/dist-cjs/runtimeConfig.js +5 -3
- package/dist-es/endpoints.js +75 -15
- package/dist-es/runtimeConfig.browser.js +3 -2
- package/dist-es/runtimeConfig.js +3 -3
- package/dist-types/Health.d.ts +71 -76
- package/dist-types/HealthClient.d.ts +27 -19
- package/dist-types/commands/DescribeAffectedAccountsForOrganizationCommand.d.ts +5 -5
- package/dist-types/commands/DescribeAffectedEntitiesCommand.d.ts +5 -6
- package/dist-types/commands/DescribeAffectedEntitiesForOrganizationCommand.d.ts +8 -10
- package/dist-types/commands/DescribeEntityAggregatesCommand.d.ts +2 -3
- package/dist-types/commands/DescribeEventAggregatesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventDetailsCommand.d.ts +4 -4
- package/dist-types/commands/DescribeEventDetailsForOrganizationCommand.d.ts +11 -11
- package/dist-types/commands/DescribeEventTypesCommand.d.ts +2 -2
- package/dist-types/commands/DescribeEventsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeEventsForOrganizationCommand.d.ts +5 -5
- package/dist-types/commands/DescribeHealthServiceStatusForOrganizationCommand.d.ts +2 -2
- package/dist-types/commands/DisableHealthServiceAccessForOrganizationCommand.d.ts +9 -10
- package/dist-types/commands/EnableHealthServiceAccessForOrganizationCommand.d.ts +8 -8
- package/dist-types/models/models_0.d.ts +67 -61
- package/dist-types/runtimeConfig.browser.d.ts +2 -0
- package/dist-types/runtimeConfig.d.ts +2 -0
- package/dist-types/runtimeConfig.native.d.ts +2 -0
- package/dist-types/ts3.4/HealthClient.d.ts +4 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -0
- package/package.json +23 -23
package/dist-types/Health.d.ts
CHANGED
|
@@ -14,46 +14,46 @@ import { DisableHealthServiceAccessForOrganizationCommandInput, DisableHealthSer
|
|
|
14
14
|
import { EnableHealthServiceAccessForOrganizationCommandInput, EnableHealthServiceAccessForOrganizationCommandOutput } from "./commands/EnableHealthServiceAccessForOrganizationCommand";
|
|
15
15
|
import { HealthClient } from "./HealthClient";
|
|
16
16
|
/**
|
|
17
|
-
* <fullname>
|
|
17
|
+
* <fullname>Health</fullname>
|
|
18
18
|
*
|
|
19
|
-
* <p>The
|
|
20
|
-
* appears in the <a href="https://phd.aws.amazon.com/phd/home#/">
|
|
21
|
-
* can use the API operations to get information about
|
|
22
|
-
*
|
|
19
|
+
* <p>The Health API provides programmatic access to the Health information that
|
|
20
|
+
* appears in the <a href="https://phd.aws.amazon.com/phd/home#/">Personal Health Dashboard</a>. You
|
|
21
|
+
* can use the API operations to get information about events that might affect your Amazon Web Services
|
|
22
|
+
* services and resources.</p>
|
|
23
23
|
* <note>
|
|
24
24
|
* <ul>
|
|
25
25
|
* <li>
|
|
26
|
-
* <p>You must have a Business or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">
|
|
27
|
-
*
|
|
26
|
+
* <p>You must have a Business or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the
|
|
27
|
+
* Health API. If you call the Health API from an Amazon Web Services account that
|
|
28
28
|
* doesn't have a Business or Enterprise Support plan, you receive a
|
|
29
29
|
* <code>SubscriptionRequiredException</code> error.</p>
|
|
30
30
|
* </li>
|
|
31
31
|
* <li>
|
|
32
|
-
* <p>You can use the
|
|
33
|
-
* call the
|
|
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
34
|
* application architecture and has two regional endpoints in an active-passive
|
|
35
35
|
* configuration. You can use the high availability endpoint example to determine
|
|
36
|
-
* which
|
|
37
|
-
* API. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/health-api.html">Accessing the
|
|
38
|
-
* <i>
|
|
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
39
|
* </li>
|
|
40
40
|
* </ul>
|
|
41
41
|
* </note>
|
|
42
|
-
* <p>For authentication of requests,
|
|
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
43
|
* Process</a>.</p>
|
|
44
|
-
* <p>If your
|
|
45
|
-
* view feature. This feature provides a centralized view of
|
|
46
|
-
* accounts in your organization. You can aggregate
|
|
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
47
|
* identify accounts in your organization that are affected by an operational event or get
|
|
48
48
|
* notified of security vulnerabilities. Use the organizational view API operations to enable
|
|
49
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
|
-
*
|
|
50
|
+
* Health events</a> in the <i>Health User Guide</i>.</p>
|
|
51
51
|
* <note>
|
|
52
|
-
* <p>When you use the
|
|
52
|
+
* <p>When you use the Health API operations to return Health events, see the
|
|
53
53
|
* following recommendations:</p>
|
|
54
54
|
* <ul>
|
|
55
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
|
|
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
57
|
* events that are public or account-specific.</p>
|
|
58
58
|
* </li>
|
|
59
59
|
* <li>
|
|
@@ -67,11 +67,11 @@ import { HealthClient } from "./HealthClient";
|
|
|
67
67
|
*/
|
|
68
68
|
export declare class Health extends HealthClient {
|
|
69
69
|
/**
|
|
70
|
-
* <p>Returns a list of accounts in the organization from
|
|
71
|
-
* provided event. For more information about the different types of
|
|
70
|
+
* <p>Returns a list of accounts in the organization from Organizations that are affected by the
|
|
71
|
+
* provided event. For more information about the different types of Health events, see
|
|
72
72
|
* <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>. </p>
|
|
73
|
-
* <p>Before you can call this operation, you must first enable
|
|
74
|
-
*
|
|
73
|
+
* <p>Before you can call this operation, you must first enable Health to work with
|
|
74
|
+
* 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
|
|
75
75
|
* management account.</p>
|
|
76
76
|
* <note>
|
|
77
77
|
* <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
|
|
@@ -83,11 +83,10 @@ export declare class Health extends HealthClient {
|
|
|
83
83
|
/**
|
|
84
84
|
* <p>Returns a list of entities that have been affected by the specified events, based on the
|
|
85
85
|
* specified filter criteria. Entities can refer to individual customer resources, groups of
|
|
86
|
-
* customer resources, or any other construct, depending on the
|
|
86
|
+
* customer resources, or any other construct, depending on the Amazon Web Services service. Events that
|
|
87
87
|
* have impact beyond that of the affected entities, or where the extent of impact is unknown,
|
|
88
88
|
* include at least one entity indicating this.</p>
|
|
89
|
-
* <p>At least one event ARN is required
|
|
90
|
-
* <code>lastUpdatedTime</code> of the entity, starting with the most recent.</p>
|
|
89
|
+
* <p>At least one event ARN is required.</p>
|
|
91
90
|
*
|
|
92
91
|
* <note>
|
|
93
92
|
* <ul>
|
|
@@ -95,8 +94,8 @@ export declare class Health extends HealthClient {
|
|
|
95
94
|
* <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
|
|
96
95
|
* </li>
|
|
97
96
|
* <li>
|
|
98
|
-
* <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific
|
|
99
|
-
* 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>
|
|
97
|
+
* <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more
|
|
98
|
+
* 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>
|
|
100
99
|
* </li>
|
|
101
100
|
* </ul>
|
|
102
101
|
* </note>
|
|
@@ -106,14 +105,12 @@ export declare class Health extends HealthClient {
|
|
|
106
105
|
describeAffectedEntities(args: DescribeAffectedEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAffectedEntitiesCommandOutput) => void): void;
|
|
107
106
|
/**
|
|
108
107
|
* <p>Returns a list of entities that have been affected by one or more events for one or more
|
|
109
|
-
* accounts in your organization in
|
|
108
|
+
* accounts in your organization in Organizations, based on the filter criteria. Entities can refer
|
|
110
109
|
* to individual customer resources, groups of customer resources, or any other construct,
|
|
111
|
-
* depending on the
|
|
112
|
-
* <p>At least one event Amazon Resource Name (ARN) and account ID are required
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
* <p>Before you can call this operation, you must first enable AWS Health to work with
|
|
116
|
-
* AWS Organizations. To do this, call the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a>
|
|
110
|
+
* depending on the Amazon Web Services service.</p>
|
|
111
|
+
* <p>At least one event Amazon Resource Name (ARN) and account ID are required.</p>
|
|
112
|
+
* <p>Before you can call this operation, you must first enable Health to work with
|
|
113
|
+
* Organizations. To do this, call the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a>
|
|
117
114
|
* operation from your organization's management account.</p>
|
|
118
115
|
* <note>
|
|
119
116
|
* <ul>
|
|
@@ -121,8 +118,8 @@ export declare class Health extends HealthClient {
|
|
|
121
118
|
* <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
|
|
122
119
|
* </li>
|
|
123
120
|
* <li>
|
|
124
|
-
* <p>This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific
|
|
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>
|
|
121
|
+
* <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
|
|
122
|
+
* 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
123
|
* </li>
|
|
127
124
|
* </ul>
|
|
128
125
|
*
|
|
@@ -132,8 +129,7 @@ export declare class Health extends HealthClient {
|
|
|
132
129
|
describeAffectedEntitiesForOrganization(args: DescribeAffectedEntitiesForOrganizationCommandInput, cb: (err: any, data?: DescribeAffectedEntitiesForOrganizationCommandOutput) => void): void;
|
|
133
130
|
describeAffectedEntitiesForOrganization(args: DescribeAffectedEntitiesForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAffectedEntitiesForOrganizationCommandOutput) => void): void;
|
|
134
131
|
/**
|
|
135
|
-
* <p>Returns the number of entities that are affected by each of the specified events
|
|
136
|
-
* events are specified, the counts of all affected entities are returned.</p>
|
|
132
|
+
* <p>Returns the number of entities that are affected by each of the specified events.</p>
|
|
137
133
|
*/
|
|
138
134
|
describeEntityAggregates(args: DescribeEntityAggregatesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEntityAggregatesCommandOutput>;
|
|
139
135
|
describeEntityAggregates(args: DescribeEntityAggregatesCommandInput, cb: (err: any, data?: DescribeEntityAggregatesCommandOutput) => void): void;
|
|
@@ -151,52 +147,52 @@ export declare class Health extends HealthClient {
|
|
|
151
147
|
describeEventAggregates(args: DescribeEventAggregatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventAggregatesCommandOutput) => void): void;
|
|
152
148
|
/**
|
|
153
149
|
* <p>Returns detailed information about one or more specified events. Information includes
|
|
154
|
-
* standard event data (
|
|
150
|
+
* 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
|
|
155
151
|
* that depends upon the nature of the event. Affected entities are not included. To retrieve
|
|
156
152
|
* the entities, use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html">DescribeAffectedEntities</a> operation.</p>
|
|
157
153
|
* <p>If a specified event can't be retrieved, an error message is returned for that
|
|
158
154
|
* event.</p>
|
|
159
155
|
* <note>
|
|
160
|
-
* <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific
|
|
161
|
-
* 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>
|
|
156
|
+
* <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more
|
|
157
|
+
* 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>
|
|
162
158
|
* </note>
|
|
163
159
|
*/
|
|
164
160
|
describeEventDetails(args: DescribeEventDetailsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventDetailsCommandOutput>;
|
|
165
161
|
describeEventDetails(args: DescribeEventDetailsCommandInput, cb: (err: any, data?: DescribeEventDetailsCommandOutput) => void): void;
|
|
166
162
|
describeEventDetails(args: DescribeEventDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventDetailsCommandOutput) => void): void;
|
|
167
163
|
/**
|
|
168
|
-
* <p>Returns detailed information about one or more specified events for one or more
|
|
169
|
-
* accounts in your organization. This information includes standard event data (such as the
|
|
170
|
-
*
|
|
164
|
+
* <p>Returns detailed information about one or more specified events for one or more
|
|
165
|
+
* Amazon Web Services accounts in your organization. This information includes standard event data (such as the
|
|
166
|
+
* Amazon Web Services Region and service), an event description, and (depending on the event) possible
|
|
171
167
|
* metadata. This operation doesn't return affected entities, such as the resources related to
|
|
172
168
|
* 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>
|
|
173
169
|
* <note>
|
|
174
|
-
* <p>Before you can call this operation, you must first enable
|
|
175
|
-
*
|
|
170
|
+
* <p>Before you can call this operation, you must first enable Health to work with
|
|
171
|
+
* 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
|
|
176
172
|
* management account.</p>
|
|
177
173
|
* </note>
|
|
178
174
|
* <p>When you call the <code>DescribeEventDetailsForOrganization</code> operation, specify
|
|
179
175
|
* the <code>organizationEventDetailFilters</code> object in the request. Depending on the
|
|
180
|
-
*
|
|
176
|
+
* Health event type, note the following differences:</p>
|
|
181
177
|
* <ul>
|
|
182
178
|
* <li>
|
|
183
179
|
* <p>To return event details for a public event, you must specify a null value for the
|
|
184
180
|
* <code>awsAccountId</code> parameter. If you specify an account ID for a public
|
|
185
|
-
* event,
|
|
181
|
+
* event, Health returns an error message because public events aren't specific to
|
|
186
182
|
* an account.</p>
|
|
187
183
|
* </li>
|
|
188
184
|
* <li>
|
|
189
185
|
* <p>To return event details for an event that is specific to an account in your
|
|
190
186
|
* organization, you must specify the <code>awsAccountId</code> parameter in the
|
|
191
|
-
* request. If you don't specify an account ID,
|
|
187
|
+
* request. If you don't specify an account ID, Health returns an error message
|
|
192
188
|
* because the event is specific to an account in your organization. </p>
|
|
193
189
|
* </li>
|
|
194
190
|
* </ul>
|
|
195
191
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p>
|
|
196
192
|
*
|
|
197
193
|
* <note>
|
|
198
|
-
* <p>This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific
|
|
199
|
-
* 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>
|
|
194
|
+
* <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
|
|
195
|
+
* 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>
|
|
200
196
|
* </note>
|
|
201
197
|
*/
|
|
202
198
|
describeEventDetailsForOrganization(args: DescribeEventDetailsForOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventDetailsForOrganizationCommandOutput>;
|
|
@@ -213,10 +209,10 @@ export declare class Health extends HealthClient {
|
|
|
213
209
|
* <ul>
|
|
214
210
|
* <li>
|
|
215
211
|
* <p>When you call the <code>DescribeEvents</code> operation and specify an entity
|
|
216
|
-
* for the <code>entityValues</code> parameter,
|
|
212
|
+
* for the <code>entityValues</code> parameter, Health might return public
|
|
217
213
|
* events that aren't specific to that resource. For example, if you call
|
|
218
214
|
* <code>DescribeEvents</code> and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2)
|
|
219
|
-
* instance,
|
|
215
|
+
* instance, Health might return events that aren't specific to that resource or
|
|
220
216
|
* service. To get events that are specific to a service, use the
|
|
221
217
|
* <code>services</code> parameter in the <code>filter</code> object. For more
|
|
222
218
|
* information, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p>
|
|
@@ -231,7 +227,7 @@ export declare class Health extends HealthClient {
|
|
|
231
227
|
describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void;
|
|
232
228
|
describeEvents(args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void;
|
|
233
229
|
/**
|
|
234
|
-
* <p>Returns information about events across your organization in
|
|
230
|
+
* <p>Returns information about events across your organization in Organizations. You can use
|
|
235
231
|
* the<code>filters</code> parameter to specify the events that you want to return. Events
|
|
236
232
|
* are returned in a summary form and don't include the affected accounts, detailed
|
|
237
233
|
* description, any additional metadata that depends on the event type, or any affected
|
|
@@ -256,9 +252,9 @@ export declare class Health extends HealthClient {
|
|
|
256
252
|
* <p>If you don't specify a <code>filter</code>, the
|
|
257
253
|
* <code>DescribeEventsForOrganizations</code> returns all events across your organization.
|
|
258
254
|
* Results are sorted by <code>lastModifiedTime</code>, starting with the most recent event. </p>
|
|
259
|
-
* <p>For more information about the different types of
|
|
260
|
-
* <p>Before you can call this operation, you must first enable
|
|
261
|
-
*
|
|
255
|
+
* <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>
|
|
256
|
+
* <p>Before you can call this operation, you must first enable Health to work with
|
|
257
|
+
* 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
|
|
262
258
|
* management account.</p>
|
|
263
259
|
* <note>
|
|
264
260
|
* <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
|
|
@@ -269,7 +265,7 @@ export declare class Health extends HealthClient {
|
|
|
269
265
|
describeEventsForOrganization(args: DescribeEventsForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsForOrganizationCommandOutput) => void): void;
|
|
270
266
|
/**
|
|
271
267
|
* <p>Returns the event types that meet the specified filter criteria. You can use this API
|
|
272
|
-
* operation to find information about the
|
|
268
|
+
* operation to find information about the Health event, such as the category, Amazon Web Services
|
|
273
269
|
* 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>
|
|
274
270
|
* <p>If you don't specify a filter criteria, the API operation returns all event types, in no
|
|
275
271
|
* particular order. </p>
|
|
@@ -281,7 +277,7 @@ export declare class Health extends HealthClient {
|
|
|
281
277
|
describeEventTypes(args: DescribeEventTypesCommandInput, cb: (err: any, data?: DescribeEventTypesCommandOutput) => void): void;
|
|
282
278
|
describeEventTypes(args: DescribeEventTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventTypesCommandOutput) => void): void;
|
|
283
279
|
/**
|
|
284
|
-
* <p>This operation provides status information on enabling or disabling
|
|
280
|
+
* <p>This operation provides status information on enabling or disabling Health to work
|
|
285
281
|
* with your organization. To call this operation, you must sign in as an IAM user, assume
|
|
286
282
|
* an IAM role, or sign in as the root user (not recommended) in the organization's
|
|
287
283
|
* management account.</p>
|
|
@@ -290,49 +286,48 @@ export declare class Health extends HealthClient {
|
|
|
290
286
|
describeHealthServiceStatusForOrganization(args: DescribeHealthServiceStatusForOrganizationCommandInput, cb: (err: any, data?: DescribeHealthServiceStatusForOrganizationCommandOutput) => void): void;
|
|
291
287
|
describeHealthServiceStatusForOrganization(args: DescribeHealthServiceStatusForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHealthServiceStatusForOrganizationCommandOutput) => void): void;
|
|
292
288
|
/**
|
|
293
|
-
* <p>Disables
|
|
294
|
-
* in as an
|
|
289
|
+
* <p>Disables Health from working with Organizations. To call this operation, you must sign
|
|
290
|
+
* in as an Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not
|
|
295
291
|
* 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
|
|
296
|
-
*
|
|
297
|
-
* <i>
|
|
298
|
-
* <p>This operation doesn't remove the service-linked role from the management account in your organization. You must use the IAM console, API, or
|
|
292
|
+
* Health events</a> in the
|
|
293
|
+
* <i>Health User Guide</i>.</p>
|
|
294
|
+
* <p>This operation doesn't remove the service-linked role from the management account in your organization. You must use the IAM console, API, or Command Line Interface (CLI) to
|
|
299
295
|
* remove the 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
|
|
300
296
|
* <i>IAM User Guide</i>.</p>
|
|
301
297
|
* <note>
|
|
302
298
|
* <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,
|
|
303
|
-
*
|
|
304
|
-
* If you call the
|
|
305
|
-
* an error.
|
|
306
|
-
* account.</p>
|
|
299
|
+
* Health stops aggregating events for all other Amazon Web Services accounts in your organization.
|
|
300
|
+
* If you call the Health API operations for organizational view, Health returns
|
|
301
|
+
* an error. Health continues to aggregate health events for your Amazon Web Services account.</p>
|
|
307
302
|
* </note>
|
|
308
303
|
*/
|
|
309
304
|
disableHealthServiceAccessForOrganization(args: DisableHealthServiceAccessForOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<DisableHealthServiceAccessForOrganizationCommandOutput>;
|
|
310
305
|
disableHealthServiceAccessForOrganization(args: DisableHealthServiceAccessForOrganizationCommandInput, cb: (err: any, data?: DisableHealthServiceAccessForOrganizationCommandOutput) => void): void;
|
|
311
306
|
disableHealthServiceAccessForOrganization(args: DisableHealthServiceAccessForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableHealthServiceAccessForOrganizationCommandOutput) => void): void;
|
|
312
307
|
/**
|
|
313
|
-
* <p>Enables
|
|
314
|
-
* to aggregate events from all
|
|
308
|
+
* <p>Enables Health to work with Organizations. You can use the organizational view feature
|
|
309
|
+
* to aggregate events from all Amazon Web Services accounts in your organization in a centralized location. </p>
|
|
315
310
|
* <p>This operation also creates a service-linked role for the management account in the
|
|
316
311
|
* organization. </p>
|
|
317
312
|
* <note>
|
|
318
313
|
* <p>To call this operation, you must meet the following requirements:</p>
|
|
319
314
|
* <ul>
|
|
320
315
|
* <li>
|
|
321
|
-
* <p>You must have a Business or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">
|
|
322
|
-
* API. If you call the
|
|
316
|
+
* <p>You must have a Business or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the Health
|
|
317
|
+
* API. If you call the Health API from an Amazon Web Services account that doesn't have a
|
|
323
318
|
* Business or Enterprise Support plan, you receive a
|
|
324
319
|
* <code>SubscriptionRequiredException</code> error.</p>
|
|
325
320
|
* </li>
|
|
326
321
|
* <li>
|
|
327
322
|
* <p>You must have permission to call this operation from the organization's
|
|
328
|
-
* management account. For example IAM policies, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html">
|
|
323
|
+
* 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
|
|
329
324
|
* identity-based policy examples</a>.</p>
|
|
330
325
|
* </li>
|
|
331
326
|
* </ul>
|
|
332
327
|
* </note>
|
|
333
|
-
* <p>If you don't have the required support plan, you can instead use the
|
|
328
|
+
* <p>If you don't have the required support plan, you can instead use the Health console
|
|
334
329
|
* to enable the organizational view feature. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html">Aggregating
|
|
335
|
-
*
|
|
330
|
+
* Health events</a> in the <i>Health User Guide</i>.</p>
|
|
336
331
|
*/
|
|
337
332
|
enableHealthServiceAccessForOrganization(args: EnableHealthServiceAccessForOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<EnableHealthServiceAccessForOrganizationCommandOutput>;
|
|
338
333
|
enableHealthServiceAccessForOrganization(args: EnableHealthServiceAccessForOrganizationCommandInput, cb: (err: any, data?: EnableHealthServiceAccessForOrganizationCommandOutput) => void): void;
|
|
@@ -89,6 +89,14 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
89
89
|
* Optional logger for logging debug/info/warn/error.
|
|
90
90
|
*/
|
|
91
91
|
logger?: __Logger;
|
|
92
|
+
/**
|
|
93
|
+
* Enables IPv6/IPv4 dualstack endpoint.
|
|
94
|
+
*/
|
|
95
|
+
useDualstackEndpoint?: boolean | __Provider<boolean>;
|
|
96
|
+
/**
|
|
97
|
+
* Enables FIPS compatible endpoints.
|
|
98
|
+
*/
|
|
99
|
+
useFipsEndpoint?: boolean | __Provider<boolean>;
|
|
92
100
|
/**
|
|
93
101
|
* Unique service identifier.
|
|
94
102
|
* @internal
|
|
@@ -127,46 +135,46 @@ declare type HealthClientResolvedConfigType = __SmithyResolvedConfiguration<__Ht
|
|
|
127
135
|
export interface HealthClientResolvedConfig extends HealthClientResolvedConfigType {
|
|
128
136
|
}
|
|
129
137
|
/**
|
|
130
|
-
* <fullname>
|
|
138
|
+
* <fullname>Health</fullname>
|
|
131
139
|
*
|
|
132
|
-
* <p>The
|
|
133
|
-
* appears in the <a href="https://phd.aws.amazon.com/phd/home#/">
|
|
134
|
-
* can use the API operations to get information about
|
|
135
|
-
*
|
|
140
|
+
* <p>The Health API provides programmatic access to the Health information that
|
|
141
|
+
* appears in the <a href="https://phd.aws.amazon.com/phd/home#/">Personal Health Dashboard</a>. You
|
|
142
|
+
* can use the API operations to get information about events that might affect your Amazon Web Services
|
|
143
|
+
* services and resources.</p>
|
|
136
144
|
* <note>
|
|
137
145
|
* <ul>
|
|
138
146
|
* <li>
|
|
139
|
-
* <p>You must have a Business or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">
|
|
140
|
-
*
|
|
147
|
+
* <p>You must have a Business or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the
|
|
148
|
+
* Health API. If you call the Health API from an Amazon Web Services account that
|
|
141
149
|
* doesn't have a Business or Enterprise Support plan, you receive a
|
|
142
150
|
* <code>SubscriptionRequiredException</code> error.</p>
|
|
143
151
|
* </li>
|
|
144
152
|
* <li>
|
|
145
|
-
* <p>You can use the
|
|
146
|
-
* call the
|
|
153
|
+
* <p>You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to
|
|
154
|
+
* call the Health API operations. Health supports a multi-Region
|
|
147
155
|
* application architecture and has two regional endpoints in an active-passive
|
|
148
156
|
* configuration. You can use the high availability endpoint example to determine
|
|
149
|
-
* which
|
|
150
|
-
* API. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/health-api.html">Accessing the
|
|
151
|
-
* <i>
|
|
157
|
+
* which Amazon Web Services Region is active, so that you can get the latest information from the
|
|
158
|
+
* 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
|
|
159
|
+
* <i>Health User Guide</i>.</p>
|
|
152
160
|
* </li>
|
|
153
161
|
* </ul>
|
|
154
162
|
* </note>
|
|
155
|
-
* <p>For authentication of requests,
|
|
163
|
+
* <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
|
|
156
164
|
* Process</a>.</p>
|
|
157
|
-
* <p>If your
|
|
158
|
-
* view feature. This feature provides a centralized view of
|
|
159
|
-
* accounts in your organization. You can aggregate
|
|
165
|
+
* <p>If your Amazon Web Services account is part of Organizations, you can use the Health organizational
|
|
166
|
+
* view feature. This feature provides a centralized view of Health events across all
|
|
167
|
+
* accounts in your organization. You can aggregate Health events in real time to
|
|
160
168
|
* identify accounts in your organization that are affected by an operational event or get
|
|
161
169
|
* notified of security vulnerabilities. Use the organizational view API operations to enable
|
|
162
170
|
* this feature and return event information. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html">Aggregating
|
|
163
|
-
*
|
|
171
|
+
* Health events</a> in the <i>Health User Guide</i>.</p>
|
|
164
172
|
* <note>
|
|
165
|
-
* <p>When you use the
|
|
173
|
+
* <p>When you use the Health API operations to return Health events, see the
|
|
166
174
|
* following recommendations:</p>
|
|
167
175
|
* <ul>
|
|
168
176
|
* <li>
|
|
169
|
-
* <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
|
|
177
|
+
* <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
|
|
170
178
|
* events that are public or account-specific.</p>
|
|
171
179
|
* </li>
|
|
172
180
|
* <li>
|
|
@@ -7,11 +7,11 @@ export interface DescribeAffectedAccountsForOrganizationCommandInput extends Des
|
|
|
7
7
|
export interface DescribeAffectedAccountsForOrganizationCommandOutput extends DescribeAffectedAccountsForOrganizationResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns a list of accounts in the organization from
|
|
11
|
-
* provided event. For more information about the different types of
|
|
10
|
+
* <p>Returns a list of accounts in the organization from Organizations that are affected by the
|
|
11
|
+
* provided event. For more information about the different types of Health events, see
|
|
12
12
|
* <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>. </p>
|
|
13
|
-
* <p>Before you can call this operation, you must first enable
|
|
14
|
-
*
|
|
13
|
+
* <p>Before you can call this operation, you must first enable Health to work with
|
|
14
|
+
* 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
|
|
15
15
|
* management account.</p>
|
|
16
16
|
* <note>
|
|
17
17
|
* <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
|
|
@@ -28,7 +28,7 @@ export interface DescribeAffectedAccountsForOrganizationCommandOutput extends De
|
|
|
28
28
|
*
|
|
29
29
|
* @see {@link DescribeAffectedAccountsForOrganizationCommandInput} for command's `input` shape.
|
|
30
30
|
* @see {@link DescribeAffectedAccountsForOrganizationCommandOutput} for command's `response` shape.
|
|
31
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
31
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
32
32
|
*
|
|
33
33
|
*/
|
|
34
34
|
export declare class DescribeAffectedAccountsForOrganizationCommand extends $Command<DescribeAffectedAccountsForOrganizationCommandInput, DescribeAffectedAccountsForOrganizationCommandOutput, HealthClientResolvedConfig> {
|
|
@@ -9,11 +9,10 @@ export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedE
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Returns a list of entities that have been affected by the specified events, based on the
|
|
11
11
|
* specified filter criteria. Entities can refer to individual customer resources, groups of
|
|
12
|
-
* customer resources, or any other construct, depending on the
|
|
12
|
+
* customer resources, or any other construct, depending on the Amazon Web Services service. Events that
|
|
13
13
|
* have impact beyond that of the affected entities, or where the extent of impact is unknown,
|
|
14
14
|
* include at least one entity indicating this.</p>
|
|
15
|
-
* <p>At least one event ARN is required
|
|
16
|
-
* <code>lastUpdatedTime</code> of the entity, starting with the most recent.</p>
|
|
15
|
+
* <p>At least one event ARN is required.</p>
|
|
17
16
|
*
|
|
18
17
|
* <note>
|
|
19
18
|
* <ul>
|
|
@@ -21,8 +20,8 @@ export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedE
|
|
|
21
20
|
* <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
|
|
22
21
|
* </li>
|
|
23
22
|
* <li>
|
|
24
|
-
* <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific
|
|
25
|
-
* 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>
|
|
23
|
+
* <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more
|
|
24
|
+
* 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>
|
|
26
25
|
* </li>
|
|
27
26
|
* </ul>
|
|
28
27
|
* </note>
|
|
@@ -38,7 +37,7 @@ export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedE
|
|
|
38
37
|
*
|
|
39
38
|
* @see {@link DescribeAffectedEntitiesCommandInput} for command's `input` shape.
|
|
40
39
|
* @see {@link DescribeAffectedEntitiesCommandOutput} for command's `response` shape.
|
|
41
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
40
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
42
41
|
*
|
|
43
42
|
*/
|
|
44
43
|
export declare class DescribeAffectedEntitiesCommand extends $Command<DescribeAffectedEntitiesCommandInput, DescribeAffectedEntitiesCommandOutput, HealthClientResolvedConfig> {
|
|
@@ -8,14 +8,12 @@ export interface DescribeAffectedEntitiesForOrganizationCommandOutput extends De
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Returns a list of entities that have been affected by one or more events for one or more
|
|
11
|
-
* accounts in your organization in
|
|
11
|
+
* accounts in your organization in Organizations, based on the filter criteria. Entities can refer
|
|
12
12
|
* to individual customer resources, groups of customer resources, or any other construct,
|
|
13
|
-
* depending on the
|
|
14
|
-
* <p>At least one event Amazon Resource Name (ARN) and account ID are required
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
* <p>Before you can call this operation, you must first enable AWS Health to work with
|
|
18
|
-
* AWS Organizations. To do this, call the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a>
|
|
13
|
+
* depending on the Amazon Web Services service.</p>
|
|
14
|
+
* <p>At least one event Amazon Resource Name (ARN) and account ID are required.</p>
|
|
15
|
+
* <p>Before you can call this operation, you must first enable Health to work with
|
|
16
|
+
* Organizations. To do this, call the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a>
|
|
19
17
|
* operation from your organization's management account.</p>
|
|
20
18
|
* <note>
|
|
21
19
|
* <ul>
|
|
@@ -23,8 +21,8 @@ export interface DescribeAffectedEntitiesForOrganizationCommandOutput extends De
|
|
|
23
21
|
* <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
|
|
24
22
|
* </li>
|
|
25
23
|
* <li>
|
|
26
|
-
* <p>This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific
|
|
27
|
-
* 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>
|
|
24
|
+
* <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
|
|
25
|
+
* 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>
|
|
28
26
|
* </li>
|
|
29
27
|
* </ul>
|
|
30
28
|
*
|
|
@@ -41,7 +39,7 @@ export interface DescribeAffectedEntitiesForOrganizationCommandOutput extends De
|
|
|
41
39
|
*
|
|
42
40
|
* @see {@link DescribeAffectedEntitiesForOrganizationCommandInput} for command's `input` shape.
|
|
43
41
|
* @see {@link DescribeAffectedEntitiesForOrganizationCommandOutput} for command's `response` shape.
|
|
44
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
42
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
45
43
|
*
|
|
46
44
|
*/
|
|
47
45
|
export declare class DescribeAffectedEntitiesForOrganizationCommand extends $Command<DescribeAffectedEntitiesForOrganizationCommandInput, DescribeAffectedEntitiesForOrganizationCommandOutput, HealthClientResolvedConfig> {
|
|
@@ -7,8 +7,7 @@ export interface DescribeEntityAggregatesCommandInput extends DescribeEntityAggr
|
|
|
7
7
|
export interface DescribeEntityAggregatesCommandOutput extends DescribeEntityAggregatesResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns the number of entities that are affected by each of the specified events
|
|
11
|
-
* events are specified, the counts of all affected entities are returned.</p>
|
|
10
|
+
* <p>Returns the number of entities that are affected by each of the specified events.</p>
|
|
12
11
|
* @example
|
|
13
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
13
|
* ```javascript
|
|
@@ -21,7 +20,7 @@ export interface DescribeEntityAggregatesCommandOutput extends DescribeEntityAgg
|
|
|
21
20
|
*
|
|
22
21
|
* @see {@link DescribeEntityAggregatesCommandInput} for command's `input` shape.
|
|
23
22
|
* @see {@link DescribeEntityAggregatesCommandOutput} for command's `response` shape.
|
|
24
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
25
24
|
*
|
|
26
25
|
*/
|
|
27
26
|
export declare class DescribeEntityAggregatesCommand extends $Command<DescribeEntityAggregatesCommandInput, DescribeEntityAggregatesCommandOutput, HealthClientResolvedConfig> {
|
|
@@ -25,7 +25,7 @@ export interface DescribeEventAggregatesCommandOutput extends DescribeEventAggre
|
|
|
25
25
|
*
|
|
26
26
|
* @see {@link DescribeEventAggregatesCommandInput} for command's `input` shape.
|
|
27
27
|
* @see {@link DescribeEventAggregatesCommandOutput} for command's `response` shape.
|
|
28
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
28
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
29
29
|
*
|
|
30
30
|
*/
|
|
31
31
|
export declare class DescribeEventAggregatesCommand extends $Command<DescribeEventAggregatesCommandInput, DescribeEventAggregatesCommandOutput, HealthClientResolvedConfig> {
|
|
@@ -8,14 +8,14 @@ export interface DescribeEventDetailsCommandOutput extends DescribeEventDetailsR
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Returns detailed information about one or more specified events. Information includes
|
|
11
|
-
* standard event data (
|
|
11
|
+
* 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
|
|
12
12
|
* that depends upon the nature of the event. Affected entities are not included. To retrieve
|
|
13
13
|
* the entities, use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html">DescribeAffectedEntities</a> operation.</p>
|
|
14
14
|
* <p>If a specified event can't be retrieved, an error message is returned for that
|
|
15
15
|
* event.</p>
|
|
16
16
|
* <note>
|
|
17
|
-
* <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific
|
|
18
|
-
* 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>
|
|
17
|
+
* <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more
|
|
18
|
+
* 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>
|
|
19
19
|
* </note>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,7 +29,7 @@ export interface DescribeEventDetailsCommandOutput extends DescribeEventDetailsR
|
|
|
29
29
|
*
|
|
30
30
|
* @see {@link DescribeEventDetailsCommandInput} for command's `input` shape.
|
|
31
31
|
* @see {@link DescribeEventDetailsCommandOutput} for command's `response` shape.
|
|
32
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
32
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
33
33
|
*
|
|
34
34
|
*/
|
|
35
35
|
export declare class DescribeEventDetailsCommand extends $Command<DescribeEventDetailsCommandInput, DescribeEventDetailsCommandOutput, HealthClientResolvedConfig> {
|