@aws-sdk/client-health 3.40.0 → 3.45.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 (21) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/README.md +19 -20
  3. package/dist-cjs/endpoints.js +9 -0
  4. package/dist-es/endpoints.js +9 -0
  5. package/dist-types/Health.d.ts +77 -82
  6. package/dist-types/HealthClient.d.ts +19 -20
  7. package/dist-types/commands/DescribeAffectedAccountsForOrganizationCommand.d.ts +5 -5
  8. package/dist-types/commands/DescribeAffectedEntitiesCommand.d.ts +5 -6
  9. package/dist-types/commands/DescribeAffectedEntitiesForOrganizationCommand.d.ts +9 -11
  10. package/dist-types/commands/DescribeEntityAggregatesCommand.d.ts +2 -3
  11. package/dist-types/commands/DescribeEventAggregatesCommand.d.ts +1 -1
  12. package/dist-types/commands/DescribeEventDetailsCommand.d.ts +4 -4
  13. package/dist-types/commands/DescribeEventDetailsForOrganizationCommand.d.ts +12 -12
  14. package/dist-types/commands/DescribeEventTypesCommand.d.ts +3 -3
  15. package/dist-types/commands/DescribeEventsCommand.d.ts +3 -3
  16. package/dist-types/commands/DescribeEventsForOrganizationCommand.d.ts +5 -5
  17. package/dist-types/commands/DescribeHealthServiceStatusForOrganizationCommand.d.ts +2 -2
  18. package/dist-types/commands/DisableHealthServiceAccessForOrganizationCommand.d.ts +11 -11
  19. package/dist-types/commands/EnableHealthServiceAccessForOrganizationCommand.d.ts +9 -9
  20. package/dist-types/models/models_0.d.ts +72 -65
  21. package/package.json +6 -6
package/CHANGELOG.md CHANGED
@@ -3,6 +3,44 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [3.45.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.44.0...v3.45.0) (2021-12-23)
7
+
8
+
9
+ ### Features
10
+
11
+ * **clients:** update clients as of 2021/12/23 ([#3110](https://github.com/aws/aws-sdk-js-v3/issues/3110)) ([5d638e1](https://github.com/aws/aws-sdk-js-v3/commit/5d638e188ce64fa80fe36b8cba79ba63b80b50b7))
12
+
13
+
14
+
15
+
16
+
17
+ # [3.43.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.42.0...v3.43.0) (2021-11-29)
18
+
19
+ **Note:** Version bump only for package @aws-sdk/client-health
20
+
21
+
22
+
23
+
24
+
25
+ # [3.42.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.41.0...v3.42.0) (2021-11-19)
26
+
27
+ **Note:** Version bump only for package @aws-sdk/client-health
28
+
29
+
30
+
31
+
32
+
33
+ # [3.41.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.40.1...v3.41.0) (2021-11-11)
34
+
35
+
36
+ ### Features
37
+
38
+ * **clients:** update clients as of 2021/11/11 ([#3015](https://github.com/aws/aws-sdk-js-v3/issues/3015)) ([3d82c4e](https://github.com/aws/aws-sdk-js-v3/commit/3d82c4e3c4d174533f46ce35495cf5cffabdb35a))
39
+
40
+
41
+
42
+
43
+
6
44
  # [3.40.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.39.0...v3.40.0) (2021-11-05)
7
45
 
8
46
 
package/README.md CHANGED
@@ -7,46 +7,45 @@
7
7
 
8
8
  AWS SDK for JavaScript Health Client for Node.js, Browser and React Native.
9
9
 
10
- <fullname>AWS Health</fullname>
10
+ <fullname>Health</fullname>
11
11
 
12
- <p>The AWS Health API provides programmatic access to the AWS Health information that
13
- appears in the <a href="https://phd.aws.amazon.com/phd/home#/">AWS Personal Health Dashboard</a>. You
14
- can use the API operations to get information about AWS Health events that affect your
15
- AWS services and resources.</p>
12
+ <p>The Health API provides programmatic access to the Health information that
13
+ appears in the <a href="https://phd.aws.amazon.com/phd/home#/">Personal Health Dashboard</a>. You
14
+ can use the API operations to get information about events that might affect your Amazon Web Services services and resources.</p>
16
15
  <note>
17
16
  <ul>
18
17
  <li>
19
- <p>You must have a Business or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">AWS Support</a> to use the
20
- AWS Health API. If you call the AWS Health API from an AWS account that
21
- doesn't have a Business or Enterprise Support plan, you receive a
18
+ <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
19
+ API. If you call the Health API from an Amazon Web Services account that
20
+ doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
22
21
  <code>SubscriptionRequiredException</code> error.</p>
23
22
  </li>
24
23
  <li>
25
- <p>You can use the AWS Health endpoint health.us-east-1.amazonaws.com (HTTPS) to
26
- call the AWS Health API operations. AWS Health supports a multi-Region
24
+ <p>You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to
25
+ call the Health API operations. Health supports a multi-Region
27
26
  application architecture and has two regional endpoints in an active-passive
28
27
  configuration. You can use the high availability endpoint example to determine
29
- which AWS Region is active, so that you can get the latest information from the
30
- API. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/health-api.html">Accessing the AWS Health API</a> in the
31
- <i>AWS Health User Guide</i>.</p>
28
+ which Amazon Web Services Region is active, so that you can get the latest information from the
29
+ 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
30
+ <i>Health User Guide</i>.</p>
32
31
  </li>
33
32
  </ul>
34
33
  </note>
35
- <p>For authentication of requests, AWS Health uses the <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing
34
+ <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
36
35
  Process</a>.</p>
37
- <p>If your AWS account is part of AWS Organizations, you can use the AWS Health organizational
38
- view feature. This feature provides a centralized view of AWS Health events across all
39
- accounts in your organization. You can aggregate AWS Health events in real time to
36
+ <p>If your Amazon Web Services account is part of Organizations, you can use the Health organizational
37
+ view feature. This feature provides a centralized view of Health events across all
38
+ accounts in your organization. You can aggregate Health events in real time to
40
39
  identify accounts in your organization that are affected by an operational event or get
41
40
  notified of security vulnerabilities. Use the organizational view API operations to enable
42
41
  this feature and return event information. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html">Aggregating
43
- AWS Health events</a> in the <i>AWS Health User Guide</i>.</p>
42
+ Health events</a> in the <i>Health User Guide</i>.</p>
44
43
  <note>
45
- <p>When you use the AWS Health API operations to return AWS Health events, see the
44
+ <p>When you use the Health API operations to return Health events, see the
46
45
  following recommendations:</p>
47
46
  <ul>
48
47
  <li>
49
- <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 AWS Health
48
+ <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
50
49
  events that are public or account-specific.</p>
51
50
  </li>
52
51
  <li>
package/dist-cjs/endpoints.js CHANGED
@@ -14,6 +14,7 @@ const partitionHash = {
14
14
  "ap-south-1",
15
15
  "ap-southeast-1",
16
16
  "ap-southeast-2",
17
+ "ap-southeast-3",
17
18
  "ca-central-1",
18
19
  "eu-central-1",
19
20
  "eu-north-1",
@@ -79,6 +80,10 @@ const partitionHash = {
79
80
  hostname: "health.{region}.c2s.ic.gov",
80
81
  tags: [],
81
82
  },
83
+ {
84
+ hostname: "health-fips.{region}.c2s.ic.gov",
85
+ tags: ["fips"],
86
+ },
82
87
  ],
83
88
  },
84
89
  "aws-iso-b": {
@@ -89,6 +94,10 @@ const partitionHash = {
89
94
  hostname: "health.{region}.sc2s.sgov.gov",
90
95
  tags: [],
91
96
  },
97
+ {
98
+ hostname: "health-fips.{region}.sc2s.sgov.gov",
99
+ tags: ["fips"],
100
+ },
92
101
  ],
93
102
  },
94
103
  "aws-us-gov": {
package/dist-es/endpoints.js CHANGED
@@ -12,6 +12,7 @@ var partitionHash = {
12
12
  "ap-south-1",
13
13
  "ap-southeast-1",
14
14
  "ap-southeast-2",
15
+ "ap-southeast-3",
15
16
  "ca-central-1",
16
17
  "eu-central-1",
17
18
  "eu-north-1",
@@ -77,6 +78,10 @@ var partitionHash = {
77
78
  hostname: "health.{region}.c2s.ic.gov",
78
79
  tags: [],
79
80
  },
81
+ {
82
+ hostname: "health-fips.{region}.c2s.ic.gov",
83
+ tags: ["fips"],
84
+ },
80
85
  ],
81
86
  },
82
87
  "aws-iso-b": {
@@ -87,6 +92,10 @@ var partitionHash = {
87
92
  hostname: "health.{region}.sc2s.sgov.gov",
88
93
  tags: [],
89
94
  },
95
+ {
96
+ hostname: "health-fips.{region}.sc2s.sgov.gov",
97
+ tags: ["fips"],
98
+ },
90
99
  ],
91
100
  },
92
101
  "aws-us-gov": {
package/dist-types/Health.d.ts CHANGED
@@ -14,46 +14,45 @@ import { DisableHealthServiceAccessForOrganizationCommandInput, DisableHealthSer
14
14
  import { EnableHealthServiceAccessForOrganizationCommandInput, EnableHealthServiceAccessForOrganizationCommandOutput } from "./commands/EnableHealthServiceAccessForOrganizationCommand";
15
15
  import { HealthClient } from "./HealthClient";
16
16
  /**
17
- * <fullname>AWS Health</fullname>
17
+ * <fullname>Health</fullname>
18
18
  *
19
- * <p>The AWS Health API provides programmatic access to the AWS Health information that
20
- * appears in the <a href="https://phd.aws.amazon.com/phd/home#/">AWS Personal Health Dashboard</a>. You
21
- * can use the API operations to get information about AWS Health events that affect your
22
- * AWS services and resources.</p>
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 services and resources.</p>
23
22
  * <note>
24
23
  * <ul>
25
24
  * <li>
26
- * <p>You must have a Business or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">AWS Support</a> to use the
27
- * AWS Health API. If you call the AWS Health API from an AWS account that
28
- * doesn't have a Business or Enterprise Support plan, you receive a
25
+ * <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
26
+ * API. If you call the Health API from an Amazon Web Services account that
27
+ * doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
29
28
  * <code>SubscriptionRequiredException</code> error.</p>
30
29
  * </li>
31
30
  * <li>
32
- * <p>You can use the AWS Health endpoint health.us-east-1.amazonaws.com (HTTPS) to
33
- * call the AWS Health API operations. AWS Health supports a multi-Region
31
+ * <p>You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to
32
+ * call the Health API operations. Health supports a multi-Region
34
33
  * application architecture and has two regional endpoints in an active-passive
35
34
  * configuration. You can use the high availability endpoint example to determine
36
- * which AWS 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 AWS Health API</a> in the
38
- * <i>AWS Health User Guide</i>.</p>
35
+ * which Amazon Web Services Region is active, so that you can get the latest information from the
36
+ * 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
37
+ * <i>Health User Guide</i>.</p>
39
38
  * </li>
40
39
  * </ul>
41
40
  * </note>
42
- * <p>For authentication of requests, AWS Health uses the <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing
41
+ * <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
42
  * Process</a>.</p>
44
- * <p>If your AWS account is part of AWS Organizations, you can use the AWS Health organizational
45
- * view feature. This feature provides a centralized view of AWS Health events across all
46
- * accounts in your organization. You can aggregate AWS Health events in real time to
43
+ * <p>If your Amazon Web Services account is part of Organizations, you can use the Health organizational
44
+ * view feature. This feature provides a centralized view of Health events across all
45
+ * accounts in your organization. You can aggregate Health events in real time to
47
46
  * identify accounts in your organization that are affected by an operational event or get
48
47
  * notified of security vulnerabilities. Use the organizational view API operations to enable
49
48
  * 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
- * AWS Health events</a> in the <i>AWS Health User Guide</i>.</p>
49
+ * Health events</a> in the <i>Health User Guide</i>.</p>
51
50
  * <note>
52
- * <p>When you use the AWS Health API operations to return AWS Health events, see the
51
+ * <p>When you use the Health API operations to return Health events, see the
53
52
  * following recommendations:</p>
54
53
  * <ul>
55
54
  * <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 AWS Health
55
+ * <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
56
  * events that are public or account-specific.</p>
58
57
  * </li>
59
58
  * <li>
@@ -67,11 +66,11 @@ import { HealthClient } from "./HealthClient";
67
66
  */
68
67
  export declare class Health extends HealthClient {
69
68
  /**
70
- * <p>Returns a list of accounts in the organization from AWS Organizations that are affected by the
71
- * provided event. For more information about the different types of AWS Health events, see
69
+ * <p>Returns a list of accounts in the organization from Organizations that are affected by the
70
+ * provided event. For more information about the different types of Health events, see
72
71
  * <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 AWS Health to work with
74
- * AWS 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
72
+ * <p>Before you can call this operation, you must first enable Health to work with
73
+ * 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
74
  * management account.</p>
76
75
  * <note>
77
76
  * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
@@ -83,11 +82,10 @@ export declare class Health extends HealthClient {
83
82
  /**
84
83
  * <p>Returns a list of entities that have been affected by the specified events, based on the
85
84
  * specified filter criteria. Entities can refer to individual customer resources, groups of
86
- * customer resources, or any other construct, depending on the AWS service. Events that
85
+ * customer resources, or any other construct, depending on the Amazon Web Services service. Events that
87
86
  * have impact beyond that of the affected entities, or where the extent of impact is unknown,
88
87
  * include at least one entity indicating this.</p>
89
- * <p>At least one event ARN is required. Results are sorted by the
90
- * <code>lastUpdatedTime</code> of the entity, starting with the most recent.</p>
88
+ * <p>At least one event ARN is required.</p>
91
89
  *
92
90
  * <note>
93
91
  * <ul>
@@ -95,8 +93,8 @@ export declare class Health extends HealthClient {
95
93
  * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
96
94
  * </li>
97
95
  * <li>
98
- * <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific AWS Health events. For more
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>AWS Health User Guide</i>.</p>
96
+ * <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more
97
+ * 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
98
  * </li>
101
99
  * </ul>
102
100
  * </note>
@@ -106,23 +104,21 @@ export declare class Health extends HealthClient {
106
104
  describeAffectedEntities(args: DescribeAffectedEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAffectedEntitiesCommandOutput) => void): void;
107
105
  /**
108
106
  * <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 AWS Organizations, based on the filter criteria. Entities can refer
107
+ * accounts in your organization in Organizations, based on the filter criteria. Entities can refer
110
108
  * to individual customer resources, groups of customer resources, or any other construct,
111
- * depending on the AWS service.</p>
112
- * <p>At least one event Amazon Resource Name (ARN) and account ID are required. Results are
113
- * sorted by the <code>lastUpdatedTime</code> of the entity, starting with the most
114
- * recent.</p>
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>
117
- * operation from your organization's management account.</p>
109
+ * depending on the Amazon Web Services service.</p>
110
+ * <p>At least one event Amazon Resource Name (ARN) and account ID are required.</p>
111
+ * <p>Before you can call this operation, you must first enable Health to work with
112
+ * 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
113
+ * management account.</p>
118
114
  * <note>
119
115
  * <ul>
120
116
  * <li>
121
117
  * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
122
118
  * </li>
123
119
  * <li>
124
- * <p>This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific AWS 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>AWS Health User Guide</i>.</p>
120
+ * <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
121
+ * 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
122
  * </li>
127
123
  * </ul>
128
124
  *
@@ -132,8 +128,7 @@ export declare class Health extends HealthClient {
132
128
  describeAffectedEntitiesForOrganization(args: DescribeAffectedEntitiesForOrganizationCommandInput, cb: (err: any, data?: DescribeAffectedEntitiesForOrganizationCommandOutput) => void): void;
133
129
  describeAffectedEntitiesForOrganization(args: DescribeAffectedEntitiesForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAffectedEntitiesForOrganizationCommandOutput) => void): void;
134
130
  /**
135
- * <p>Returns the number of entities that are affected by each of the specified events. If no
136
- * events are specified, the counts of all affected entities are returned.</p>
131
+ * <p>Returns the number of entities that are affected by each of the specified events.</p>
137
132
  */
138
133
  describeEntityAggregates(args: DescribeEntityAggregatesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEntityAggregatesCommandOutput>;
139
134
  describeEntityAggregates(args: DescribeEntityAggregatesCommandInput, cb: (err: any, data?: DescribeEntityAggregatesCommandOutput) => void): void;
@@ -151,52 +146,52 @@ export declare class Health extends HealthClient {
151
146
  describeEventAggregates(args: DescribeEventAggregatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventAggregatesCommandOutput) => void): void;
152
147
  /**
153
148
  * <p>Returns detailed information about one or more specified events. Information includes
154
- * standard event data (AWS 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
149
+ * 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
150
  * that depends upon the nature of the event. Affected entities are not included. To retrieve
156
151
  * the entities, use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html">DescribeAffectedEntities</a> operation.</p>
157
152
  * <p>If a specified event can't be retrieved, an error message is returned for that
158
153
  * event.</p>
159
154
  * <note>
160
- * <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific AWS Health events. For more
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>AWS Health User Guide</i>.</p>
155
+ * <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more
156
+ * 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
157
  * </note>
163
158
  */
164
159
  describeEventDetails(args: DescribeEventDetailsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventDetailsCommandOutput>;
165
160
  describeEventDetails(args: DescribeEventDetailsCommandInput, cb: (err: any, data?: DescribeEventDetailsCommandOutput) => void): void;
166
161
  describeEventDetails(args: DescribeEventDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventDetailsCommandOutput) => void): void;
167
162
  /**
168
- * <p>Returns detailed information about one or more specified events for one or more AWS
169
- * accounts in your organization. This information includes standard event data (such as the
170
- * AWS Region and service), an event description, and (depending on the event) possible
163
+ * <p>Returns detailed information about one or more specified events for one or more
164
+ * Amazon Web Services accounts in your organization. This information includes standard event data (such as
165
+ * the Amazon Web Services Region and service), an event description, and (depending on the event) possible
171
166
  * metadata. This operation doesn't return affected entities, such as the resources related to
172
167
  * 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
168
  * <note>
174
- * <p>Before you can call this operation, you must first enable AWS Health to work with
175
- * AWS 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
169
+ * <p>Before you can call this operation, you must first enable Health to work with
170
+ * 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
171
  * management account.</p>
177
172
  * </note>
178
173
  * <p>When you call the <code>DescribeEventDetailsForOrganization</code> operation, specify
179
174
  * the <code>organizationEventDetailFilters</code> object in the request. Depending on the
180
- * AWS Health event type, note the following differences:</p>
175
+ * Health event type, note the following differences:</p>
181
176
  * <ul>
182
177
  * <li>
183
178
  * <p>To return event details for a public event, you must specify a null value for the
184
179
  * <code>awsAccountId</code> parameter. If you specify an account ID for a public
185
- * event, AWS Health returns an error message because public events aren't specific to
180
+ * event, Health returns an error message because public events aren't specific to
186
181
  * an account.</p>
187
182
  * </li>
188
183
  * <li>
189
184
  * <p>To return event details for an event that is specific to an account in your
190
- * organization, you must specify the <code>awsAccountId</code> parameter in the
191
- * request. If you don't specify an account ID, AWS Health returns an error message
185
+ * organization, you must specify the <code>awsAccountId</code> parameter in the
186
+ * request. If you don't specify an account ID, Health returns an error message
192
187
  * because the event is specific to an account in your organization. </p>
193
188
  * </li>
194
189
  * </ul>
195
190
  * <p>For more information, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p>
196
191
  *
197
192
  * <note>
198
- * <p>This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific AWS Health events. For more
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>AWS Health User Guide</i>.</p>
193
+ * <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
194
+ * 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
195
  * </note>
201
196
  */
202
197
  describeEventDetailsForOrganization(args: DescribeEventDetailsForOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventDetailsForOrganizationCommandOutput>;
@@ -213,10 +208,10 @@ export declare class Health extends HealthClient {
213
208
  * <ul>
214
209
  * <li>
215
210
  * <p>When you call the <code>DescribeEvents</code> operation and specify an entity
216
- * for the <code>entityValues</code> parameter, AWS Health might return public
211
+ * for the <code>entityValues</code> parameter, Health might return public
217
212
  * events that aren't specific to that resource. For example, if you call
218
213
  * <code>DescribeEvents</code> and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2)
219
- * instance, AWS Health might return events that aren't specific to that resource or
214
+ * instance, Health might return events that aren't specific to that resource or
220
215
  * service. To get events that are specific to a service, use the
221
216
  * <code>services</code> parameter in the <code>filter</code> object. For more
222
217
  * information, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p>
@@ -231,7 +226,7 @@ export declare class Health extends HealthClient {
231
226
  describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void;
232
227
  describeEvents(args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void;
233
228
  /**
234
- * <p>Returns information about events across your organization in AWS Organizations. You can use
229
+ * <p>Returns information about events across your organization in Organizations. You can use
235
230
  * the<code>filters</code> parameter to specify the events that you want to return. Events
236
231
  * are returned in a summary form and don't include the affected accounts, detailed
237
232
  * description, any additional metadata that depends on the event type, or any affected
@@ -256,9 +251,9 @@ export declare class Health extends HealthClient {
256
251
  * <p>If you don't specify a <code>filter</code>, the
257
252
  * <code>DescribeEventsForOrganizations</code> returns all events across your organization.
258
253
  * Results are sorted by <code>lastModifiedTime</code>, starting with the most recent event. </p>
259
- * <p>For more information about the different types of AWS Health events, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p>
260
- * <p>Before you can call this operation, you must first enable AWS Health to work with
261
- * AWS 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
254
+ * <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>
255
+ * <p>Before you can call this operation, you must first enable Health to work with
256
+ * 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
257
  * management account.</p>
263
258
  * <note>
264
259
  * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
@@ -269,10 +264,10 @@ export declare class Health extends HealthClient {
269
264
  describeEventsForOrganization(args: DescribeEventsForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsForOrganizationCommandOutput) => void): void;
270
265
  /**
271
266
  * <p>Returns the event types that meet the specified filter criteria. You can use this API
272
- * operation to find information about the AWS Health event, such as the category, AWS
267
+ * operation to find information about the Health event, such as the category, Amazon Web Services
273
268
  * 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
269
  * <p>If you don't specify a filter criteria, the API operation returns all event types, in no
275
- * particular order. </p>
270
+ * particular order. </p>
276
271
  * <note>
277
272
  * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
278
273
  * </note>
@@ -281,7 +276,7 @@ export declare class Health extends HealthClient {
281
276
  describeEventTypes(args: DescribeEventTypesCommandInput, cb: (err: any, data?: DescribeEventTypesCommandOutput) => void): void;
282
277
  describeEventTypes(args: DescribeEventTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventTypesCommandOutput) => void): void;
283
278
  /**
284
- * <p>This operation provides status information on enabling or disabling AWS Health to work
279
+ * <p>This operation provides status information on enabling or disabling Health to work
285
280
  * with your organization. To call this operation, you must sign in as an IAM user, assume
286
281
  * an IAM role, or sign in as the root user (not recommended) in the organization's
287
282
  * management account.</p>
@@ -290,49 +285,49 @@ export declare class Health extends HealthClient {
290
285
  describeHealthServiceStatusForOrganization(args: DescribeHealthServiceStatusForOrganizationCommandInput, cb: (err: any, data?: DescribeHealthServiceStatusForOrganizationCommandOutput) => void): void;
291
286
  describeHealthServiceStatusForOrganization(args: DescribeHealthServiceStatusForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHealthServiceStatusForOrganizationCommandOutput) => void): void;
292
287
  /**
293
- * <p>Disables AWS Health from working with AWS Organizations. To call this operation, you must sign
294
- * in as an AWS Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not
288
+ * <p>Disables Health from working with Organizations. To call this operation, you must sign
289
+ * in as an Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not
295
290
  * 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
- * AWS Health events</a> in the
297
- * <i>AWS Health User Guide</i>.</p>
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 AWS Command Line Interface (AWS CLI) to
299
- * 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
291
+ * Health events</a> in the <i>Health User Guide</i>.</p>
292
+ * <p>This operation doesn't remove the service-linked role from the management account in your
293
+ * organization. You must use the IAM console, API, or Command Line Interface (CLI) to remove the
294
+ * 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
295
  * <i>IAM User Guide</i>.</p>
301
296
  * <note>
302
297
  * <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
- * AWS Health stops aggregating events for all other AWS accounts in your organization.
304
- * If you call the AWS Health API operations for organizational view, AWS Health returns
305
- * an error. AWS Health continues to aggregate health events for your AWS
306
- * account.</p>
298
+ * Health stops aggregating events for all other Amazon Web Services accounts in your organization.
299
+ * If you call the Health API operations for organizational view, Health returns
300
+ * an error. Health continues to aggregate health events for your
301
+ * 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 AWS Health to work with AWS Organizations. You can use the organizational view feature
314
- * to aggregate events from all AWS accounts in your organization in a centralized location. </p>
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/">AWS Support</a> to use the AWS Health
322
- * API. If you call the AWS Health API from an AWS account that doesn't have a
323
- * Business or Enterprise Support plan, you receive a
316
+ * <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
317
+ * API. If you call the Health API from an Amazon Web Services account that doesn't have a
318
+ * Business, Enterprise On-Ramp, 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">AWS Health
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 AWS Health console
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
- * AWS Health events</a> in the <i>AWS Health User Guide</i>.</p>
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;
package/dist-types/HealthClient.d.ts CHANGED
@@ -135,46 +135,45 @@ declare type HealthClientResolvedConfigType = __SmithyResolvedConfiguration<__Ht
135
135
  export interface HealthClientResolvedConfig extends HealthClientResolvedConfigType {
136
136
  }
137
137
  /**
138
- * <fullname>AWS Health</fullname>
138
+ * <fullname>Health</fullname>
139
139
  *
140
- * <p>The AWS Health API provides programmatic access to the AWS Health information that
141
- * appears in the <a href="https://phd.aws.amazon.com/phd/home#/">AWS Personal Health Dashboard</a>. You
142
- * can use the API operations to get information about AWS Health events that affect your
143
- * AWS services and resources.</p>
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 services and resources.</p>
144
143
  * <note>
145
144
  * <ul>
146
145
  * <li>
147
- * <p>You must have a Business or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">AWS Support</a> to use the
148
- * AWS Health API. If you call the AWS Health API from an AWS account that
149
- * doesn't have a Business or Enterprise Support plan, you receive a
146
+ * <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
147
+ * API. If you call the Health API from an Amazon Web Services account that
148
+ * doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
150
149
  * <code>SubscriptionRequiredException</code> error.</p>
151
150
  * </li>
152
151
  * <li>
153
- * <p>You can use the AWS Health endpoint health.us-east-1.amazonaws.com (HTTPS) to
154
- * call the AWS Health API operations. AWS Health supports a multi-Region
152
+ * <p>You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to
153
+ * call the Health API operations. Health supports a multi-Region
155
154
  * application architecture and has two regional endpoints in an active-passive
156
155
  * configuration. You can use the high availability endpoint example to determine
157
- * which AWS 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 AWS Health API</a> in the
159
- * <i>AWS Health User Guide</i>.</p>
156
+ * which Amazon Web Services Region is active, so that you can get the latest information from the
157
+ * 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
158
+ * <i>Health User Guide</i>.</p>
160
159
  * </li>
161
160
  * </ul>
162
161
  * </note>
163
- * <p>For authentication of requests, AWS Health uses the <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing
162
+ * <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
164
163
  * Process</a>.</p>
165
- * <p>If your AWS account is part of AWS Organizations, you can use the AWS Health organizational
166
- * view feature. This feature provides a centralized view of AWS Health events across all
167
- * accounts in your organization. You can aggregate AWS Health events in real time to
164
+ * <p>If your Amazon Web Services account is part of Organizations, you can use the Health organizational
165
+ * view feature. This feature provides a centralized view of Health events across all
166
+ * accounts in your organization. You can aggregate Health events in real time to
168
167
  * identify accounts in your organization that are affected by an operational event or get
169
168
  * notified of security vulnerabilities. Use the organizational view API operations to enable
170
169
  * this feature and return event information. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html">Aggregating
171
- * AWS Health events</a> in the <i>AWS Health User Guide</i>.</p>
170
+ * Health events</a> in the <i>Health User Guide</i>.</p>
172
171
  * <note>
173
- * <p>When you use the AWS Health API operations to return AWS Health events, see the
172
+ * <p>When you use the Health API operations to return Health events, see the
174
173
  * following recommendations:</p>
175
174
  * <ul>
176
175
  * <li>
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 AWS Health
176
+ * <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
178
177
  * events that are public or account-specific.</p>
179
178
  * </li>
180
179
  * <li>