@aws-sdk/client-health 3.36.0 → 3.39.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/dist-cjs/Health.js +0 -52
  3. package/dist-cjs/HealthClient.js +0 -57
  4. package/dist-cjs/commands/DescribeAffectedAccountsForOrganizationCommand.js +0 -32
  5. package/dist-cjs/commands/DescribeAffectedEntitiesCommand.js +0 -42
  6. package/dist-cjs/commands/DescribeAffectedEntitiesForOrganizationCommand.js +0 -45
  7. package/dist-cjs/commands/DescribeEntityAggregatesCommand.js +0 -25
  8. package/dist-cjs/commands/DescribeEventAggregatesCommand.js +0 -29
  9. package/dist-cjs/commands/DescribeEventDetailsCommand.js +0 -33
  10. package/dist-cjs/commands/DescribeEventDetailsForOrganizationCommand.js +0 -56
  11. package/dist-cjs/commands/DescribeEventTypesCommand.js +0 -31
  12. package/dist-cjs/commands/DescribeEventsCommand.js +0 -46
  13. package/dist-cjs/commands/DescribeEventsForOrganizationCommand.js +0 -55
  14. package/dist-cjs/commands/DescribeHealthServiceStatusForOrganizationCommand.js +0 -27
  15. package/dist-cjs/commands/DisableHealthServiceAccessForOrganizationCommand.js +0 -38
  16. package/dist-cjs/commands/EnableHealthServiceAccessForOrganizationCommand.js +0 -46
  17. package/dist-cjs/commands/index.js +16 -0
  18. package/dist-cjs/endpoints.js +6 -1
  19. package/dist-cjs/index.js +4 -23
  20. package/dist-cjs/models/models_0.js +0 -126
  21. package/dist-cjs/pagination/DescribeAffectedAccountsForOrganizationPaginator.js +0 -10
  22. package/dist-cjs/pagination/DescribeAffectedEntitiesForOrganizationPaginator.js +0 -10
  23. package/dist-cjs/pagination/DescribeAffectedEntitiesPaginator.js +0 -10
  24. package/dist-cjs/pagination/DescribeEventAggregatesPaginator.js +0 -10
  25. package/dist-cjs/pagination/DescribeEventTypesPaginator.js +0 -10
  26. package/dist-cjs/pagination/DescribeEventsForOrganizationPaginator.js +0 -10
  27. package/dist-cjs/pagination/DescribeEventsPaginator.js +0 -10
  28. package/dist-cjs/pagination/index.js +11 -0
  29. package/dist-cjs/protocols/Aws_json1_1.js +0 -5
  30. package/dist-cjs/runtimeConfig.browser.js +1 -5
  31. package/dist-cjs/runtimeConfig.js +1 -5
  32. package/dist-cjs/runtimeConfig.native.js +0 -3
  33. package/dist-cjs/runtimeConfig.shared.js +0 -3
  34. package/dist-es/commands/index.js +13 -0
  35. package/dist-es/endpoints.js +6 -1
  36. package/dist-es/index.js +4 -23
  37. package/dist-es/pagination/index.js +8 -0
  38. package/dist-types/commands/index.d.ts +13 -0
  39. package/dist-types/index.d.ts +4 -23
  40. package/dist-types/pagination/index.d.ts +8 -0
  41. package/dist-types/ts3.4/Health.d.ts +14 -284
  42. package/dist-types/ts3.4/HealthClient.d.ts +24 -138
  43. package/dist-types/ts3.4/commands/DescribeAffectedAccountsForOrganizationCommand.d.ts +2 -28
  44. package/dist-types/ts3.4/commands/DescribeAffectedEntitiesCommand.d.ts +2 -38
  45. package/dist-types/ts3.4/commands/DescribeAffectedEntitiesForOrganizationCommand.d.ts +2 -41
  46. package/dist-types/ts3.4/commands/DescribeEntityAggregatesCommand.d.ts +2 -21
  47. package/dist-types/ts3.4/commands/DescribeEventAggregatesCommand.d.ts +2 -25
  48. package/dist-types/ts3.4/commands/DescribeEventDetailsCommand.d.ts +2 -29
  49. package/dist-types/ts3.4/commands/DescribeEventDetailsForOrganizationCommand.d.ts +2 -52
  50. package/dist-types/ts3.4/commands/DescribeEventTypesCommand.d.ts +2 -27
  51. package/dist-types/ts3.4/commands/DescribeEventsCommand.d.ts +2 -42
  52. package/dist-types/ts3.4/commands/DescribeEventsForOrganizationCommand.d.ts +2 -51
  53. package/dist-types/ts3.4/commands/DescribeHealthServiceStatusForOrganizationCommand.d.ts +2 -23
  54. package/dist-types/ts3.4/commands/DisableHealthServiceAccessForOrganizationCommand.d.ts +2 -34
  55. package/dist-types/ts3.4/commands/EnableHealthServiceAccessForOrganizationCommand.d.ts +2 -42
  56. package/dist-types/ts3.4/commands/index.d.ts +13 -0
  57. package/dist-types/ts3.4/index.d.ts +4 -23
  58. package/dist-types/ts3.4/models/models_0.d.ts +209 -927
  59. package/dist-types/ts3.4/pagination/index.d.ts +8 -0
  60. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  61. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  62. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  63. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  64. package/package.json +32 -32
@@ -3,9 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getRuntimeConfig = void 0;
4
4
  const sha256_js_1 = require("@aws-crypto/sha256-js");
5
5
  const runtimeConfig_browser_1 = require("./runtimeConfig.browser");
6
- /**
7
- * @internal
8
- */
9
6
  const getRuntimeConfig = (config) => {
10
7
  var _a;
11
8
  const browserDefaults = runtimeConfig_browser_1.getRuntimeConfig(config);
@@ -3,9 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getRuntimeConfig = void 0;
4
4
  const url_parser_1 = require("@aws-sdk/url-parser");
5
5
  const endpoints_1 = require("./endpoints");
6
- /**
7
- * @internal
8
- */
9
6
  const getRuntimeConfig = (config) => {
10
7
  var _a, _b, _c, _d, _e;
11
8
  return ({
@@ -0,0 +1,13 @@
1
+ export * from "./DescribeAffectedAccountsForOrganizationCommand";
2
+ export * from "./DescribeAffectedEntitiesCommand";
3
+ export * from "./DescribeAffectedEntitiesForOrganizationCommand";
4
+ export * from "./DescribeEntityAggregatesCommand";
5
+ export * from "./DescribeEventAggregatesCommand";
6
+ export * from "./DescribeEventDetailsCommand";
7
+ export * from "./DescribeEventDetailsForOrganizationCommand";
8
+ export * from "./DescribeEventTypesCommand";
9
+ export * from "./DescribeEventsCommand";
10
+ export * from "./DescribeEventsForOrganizationCommand";
11
+ export * from "./DescribeHealthServiceStatusForOrganizationCommand";
12
+ export * from "./DisableHealthServiceAccessForOrganizationCommand";
13
+ export * from "./EnableHealthServiceAccessForOrganizationCommand";
@@ -36,22 +36,27 @@ var partitionHash = {
36
36
  "us-west-1",
37
37
  "us-west-2",
38
38
  ],
39
+ regionRegex: "^(us|eu|ap|sa|ca|me|af)\\-\\w+\\-\\d+$",
39
40
  hostname: "health.{region}.amazonaws.com",
40
41
  },
41
42
  "aws-cn": {
42
43
  regions: ["cn-north-1", "cn-northwest-1"],
44
+ regionRegex: "^cn\\-\\w+\\-\\d+$",
43
45
  hostname: "health.{region}.amazonaws.com.cn",
44
46
  },
45
47
  "aws-iso": {
46
- regions: ["us-iso-east-1"],
48
+ regions: ["us-iso-east-1", "us-iso-west-1"],
49
+ regionRegex: "^us\\-iso\\-\\w+\\-\\d+$",
47
50
  hostname: "health.{region}.c2s.ic.gov",
48
51
  },
49
52
  "aws-iso-b": {
50
53
  regions: ["us-isob-east-1"],
54
+ regionRegex: "^us\\-isob\\-\\w+\\-\\d+$",
51
55
  hostname: "health.{region}.sc2s.sgov.gov",
52
56
  },
53
57
  "aws-us-gov": {
54
58
  regions: ["fips-us-gov-west-1", "us-gov-east-1", "us-gov-west-1"],
59
+ regionRegex: "^us\\-gov\\-\\w+\\-\\d+$",
55
60
  hostname: "health.{region}.amazonaws.com",
56
61
  },
57
62
  };
package/dist-es/index.js CHANGED
@@ -1,24 +1,5 @@
1
- export * from "./HealthClient";
2
1
  export * from "./Health";
3
- export * from "./commands/DescribeAffectedAccountsForOrganizationCommand";
4
- export * from "./pagination/DescribeAffectedAccountsForOrganizationPaginator";
5
- export * from "./commands/DescribeAffectedEntitiesCommand";
6
- export * from "./pagination/DescribeAffectedEntitiesPaginator";
7
- export * from "./commands/DescribeAffectedEntitiesForOrganizationCommand";
8
- export * from "./pagination/DescribeAffectedEntitiesForOrganizationPaginator";
9
- export * from "./commands/DescribeEntityAggregatesCommand";
10
- export * from "./commands/DescribeEventAggregatesCommand";
11
- export * from "./pagination/DescribeEventAggregatesPaginator";
12
- export * from "./commands/DescribeEventDetailsCommand";
13
- export * from "./commands/DescribeEventDetailsForOrganizationCommand";
14
- export * from "./commands/DescribeEventsCommand";
15
- export * from "./pagination/DescribeEventsPaginator";
16
- export * from "./commands/DescribeEventsForOrganizationCommand";
17
- export * from "./pagination/DescribeEventsForOrganizationPaginator";
18
- export * from "./commands/DescribeEventTypesCommand";
19
- export * from "./pagination/DescribeEventTypesPaginator";
20
- export * from "./commands/DescribeHealthServiceStatusForOrganizationCommand";
21
- export * from "./commands/DisableHealthServiceAccessForOrganizationCommand";
22
- export * from "./commands/EnableHealthServiceAccessForOrganizationCommand";
23
- export * from "./pagination/Interfaces";
24
- export * from "./models/index";
2
+ export * from "./HealthClient";
3
+ export * from "./commands";
4
+ export * from "./models";
5
+ export * from "./pagination";
@@ -0,0 +1,8 @@
1
+ export * from "./DescribeAffectedAccountsForOrganizationPaginator";
2
+ export * from "./DescribeAffectedEntitiesForOrganizationPaginator";
3
+ export * from "./DescribeAffectedEntitiesPaginator";
4
+ export * from "./DescribeEventAggregatesPaginator";
5
+ export * from "./DescribeEventTypesPaginator";
6
+ export * from "./DescribeEventsForOrganizationPaginator";
7
+ export * from "./DescribeEventsPaginator";
8
+ export * from "./Interfaces";
@@ -0,0 +1,13 @@
1
+ export * from "./DescribeAffectedAccountsForOrganizationCommand";
2
+ export * from "./DescribeAffectedEntitiesCommand";
3
+ export * from "./DescribeAffectedEntitiesForOrganizationCommand";
4
+ export * from "./DescribeEntityAggregatesCommand";
5
+ export * from "./DescribeEventAggregatesCommand";
6
+ export * from "./DescribeEventDetailsCommand";
7
+ export * from "./DescribeEventDetailsForOrganizationCommand";
8
+ export * from "./DescribeEventTypesCommand";
9
+ export * from "./DescribeEventsCommand";
10
+ export * from "./DescribeEventsForOrganizationCommand";
11
+ export * from "./DescribeHealthServiceStatusForOrganizationCommand";
12
+ export * from "./DisableHealthServiceAccessForOrganizationCommand";
13
+ export * from "./EnableHealthServiceAccessForOrganizationCommand";
@@ -1,24 +1,5 @@
1
- export * from "./HealthClient";
2
1
  export * from "./Health";
3
- export * from "./commands/DescribeAffectedAccountsForOrganizationCommand";
4
- export * from "./pagination/DescribeAffectedAccountsForOrganizationPaginator";
5
- export * from "./commands/DescribeAffectedEntitiesCommand";
6
- export * from "./pagination/DescribeAffectedEntitiesPaginator";
7
- export * from "./commands/DescribeAffectedEntitiesForOrganizationCommand";
8
- export * from "./pagination/DescribeAffectedEntitiesForOrganizationPaginator";
9
- export * from "./commands/DescribeEntityAggregatesCommand";
10
- export * from "./commands/DescribeEventAggregatesCommand";
11
- export * from "./pagination/DescribeEventAggregatesPaginator";
12
- export * from "./commands/DescribeEventDetailsCommand";
13
- export * from "./commands/DescribeEventDetailsForOrganizationCommand";
14
- export * from "./commands/DescribeEventsCommand";
15
- export * from "./pagination/DescribeEventsPaginator";
16
- export * from "./commands/DescribeEventsForOrganizationCommand";
17
- export * from "./pagination/DescribeEventsForOrganizationPaginator";
18
- export * from "./commands/DescribeEventTypesCommand";
19
- export * from "./pagination/DescribeEventTypesPaginator";
20
- export * from "./commands/DescribeHealthServiceStatusForOrganizationCommand";
21
- export * from "./commands/DisableHealthServiceAccessForOrganizationCommand";
22
- export * from "./commands/EnableHealthServiceAccessForOrganizationCommand";
23
- export * from "./pagination/Interfaces";
24
- export * from "./models/index";
2
+ export * from "./HealthClient";
3
+ export * from "./commands";
4
+ export * from "./models";
5
+ export * from "./pagination";
@@ -0,0 +1,8 @@
1
+ export * from "./DescribeAffectedAccountsForOrganizationPaginator";
2
+ export * from "./DescribeAffectedEntitiesForOrganizationPaginator";
3
+ export * from "./DescribeAffectedEntitiesPaginator";
4
+ export * from "./DescribeEventAggregatesPaginator";
5
+ export * from "./DescribeEventTypesPaginator";
6
+ export * from "./DescribeEventsForOrganizationPaginator";
7
+ export * from "./DescribeEventsPaginator";
8
+ export * from "./Interfaces";
@@ -13,327 +13,57 @@ import { DescribeHealthServiceStatusForOrganizationCommandInput, DescribeHealthS
13
13
  import { DisableHealthServiceAccessForOrganizationCommandInput, DisableHealthServiceAccessForOrganizationCommandOutput } from "./commands/DisableHealthServiceAccessForOrganizationCommand";
14
14
  import { EnableHealthServiceAccessForOrganizationCommandInput, EnableHealthServiceAccessForOrganizationCommandOutput } from "./commands/EnableHealthServiceAccessForOrganizationCommand";
15
15
  import { HealthClient } from "./HealthClient";
16
- /**
17
- * <fullname>AWS Health</fullname>
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>
23
- * <note>
24
- * <ul>
25
- * <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
29
- * <code>SubscriptionRequiredException</code> error.</p>
30
- * </li>
31
- * <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
34
- * application architecture and has two regional endpoints in an active-passive
35
- * configuration. You can use the high availability endpoint example to determine
36
- * which 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>
39
- * </li>
40
- * </ul>
41
- * </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
43
- * 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
47
- * identify accounts in your organization that are affected by an operational event or get
48
- * notified of security vulnerabilities. Use the organizational view API operations to enable
49
- * this feature and return event information. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html">Aggregating
50
- * AWS Health events</a> in the <i>AWS Health User Guide</i>.</p>
51
- * <note>
52
- * <p>When you use the AWS Health API operations to return AWS Health events, see the
53
- * following recommendations:</p>
54
- * <ul>
55
- * <li>
56
- * <p>Use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode">eventScopeCode</a> parameter to specify whether to return AWS Health
57
- * events that are public or account-specific.</p>
58
- * </li>
59
- * <li>
60
- * <p>Use pagination to view all events from the response. For example, if you call
61
- * the <code>DescribeEventsForOrganization</code> operation to get all events in your
62
- * organization, you might receive several page results. Specify the
63
- * <code>nextToken</code> in the next request to return more results.</p>
64
- * </li>
65
- * </ul>
66
- * </note>
67
- */
16
+
68
17
  export declare class Health extends HealthClient {
69
- /**
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
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 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
75
- * management account.</p>
76
- * <note>
77
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
78
- * </note>
79
- */
18
+
80
19
  describeAffectedAccountsForOrganization(args: DescribeAffectedAccountsForOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAffectedAccountsForOrganizationCommandOutput>;
81
20
  describeAffectedAccountsForOrganization(args: DescribeAffectedAccountsForOrganizationCommandInput, cb: (err: any, data?: DescribeAffectedAccountsForOrganizationCommandOutput) => void): void;
82
21
  describeAffectedAccountsForOrganization(args: DescribeAffectedAccountsForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAffectedAccountsForOrganizationCommandOutput) => void): void;
83
- /**
84
- * <p>Returns a list of entities that have been affected by the specified events, based on the
85
- * 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
87
- * have impact beyond that of the affected entities, or where the extent of impact is unknown,
88
- * 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>
91
- *
92
- * <note>
93
- * <ul>
94
- * <li>
95
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
96
- * </li>
97
- * <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>
100
- * </li>
101
- * </ul>
102
- * </note>
103
- */
22
+
104
23
  describeAffectedEntities(args: DescribeAffectedEntitiesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAffectedEntitiesCommandOutput>;
105
24
  describeAffectedEntities(args: DescribeAffectedEntitiesCommandInput, cb: (err: any, data?: DescribeAffectedEntitiesCommandOutput) => void): void;
106
25
  describeAffectedEntities(args: DescribeAffectedEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAffectedEntitiesCommandOutput) => void): void;
107
- /**
108
- * <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
110
- * 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>
118
- * <note>
119
- * <ul>
120
- * <li>
121
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
122
- * </li>
123
- * <li>
124
- * <p>This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific 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>
126
- * </li>
127
- * </ul>
128
- *
129
- * </note>
130
- */
26
+
131
27
  describeAffectedEntitiesForOrganization(args: DescribeAffectedEntitiesForOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAffectedEntitiesForOrganizationCommandOutput>;
132
28
  describeAffectedEntitiesForOrganization(args: DescribeAffectedEntitiesForOrganizationCommandInput, cb: (err: any, data?: DescribeAffectedEntitiesForOrganizationCommandOutput) => void): void;
133
29
  describeAffectedEntitiesForOrganization(args: DescribeAffectedEntitiesForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAffectedEntitiesForOrganizationCommandOutput) => void): void;
134
- /**
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>
137
- */
30
+
138
31
  describeEntityAggregates(args: DescribeEntityAggregatesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEntityAggregatesCommandOutput>;
139
32
  describeEntityAggregates(args: DescribeEntityAggregatesCommandInput, cb: (err: any, data?: DescribeEntityAggregatesCommandOutput) => void): void;
140
33
  describeEntityAggregates(args: DescribeEntityAggregatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEntityAggregatesCommandOutput) => void): void;
141
- /**
142
- * <p>Returns the number of events of each event type (issue, scheduled change, and account
143
- * notification). If no filter is specified, the counts of all events in each category are
144
- * returned.</p>
145
- * <note>
146
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
147
- * </note>
148
- */
34
+
149
35
  describeEventAggregates(args: DescribeEventAggregatesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventAggregatesCommandOutput>;
150
36
  describeEventAggregates(args: DescribeEventAggregatesCommandInput, cb: (err: any, data?: DescribeEventAggregatesCommandOutput) => void): void;
151
37
  describeEventAggregates(args: DescribeEventAggregatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventAggregatesCommandOutput) => void): void;
152
- /**
153
- * <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
155
- * that depends upon the nature of the event. Affected entities are not included. To retrieve
156
- * the entities, use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html">DescribeAffectedEntities</a> operation.</p>
157
- * <p>If a specified event can't be retrieved, an error message is returned for that
158
- * event.</p>
159
- * <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>
162
- * </note>
163
- */
38
+
164
39
  describeEventDetails(args: DescribeEventDetailsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventDetailsCommandOutput>;
165
40
  describeEventDetails(args: DescribeEventDetailsCommandInput, cb: (err: any, data?: DescribeEventDetailsCommandOutput) => void): void;
166
41
  describeEventDetails(args: DescribeEventDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventDetailsCommandOutput) => void): void;
167
- /**
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
171
- * metadata. This operation doesn't return affected entities, such as the resources related to
172
- * 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
- * <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
176
- * management account.</p>
177
- * </note>
178
- * <p>When you call the <code>DescribeEventDetailsForOrganization</code> operation, specify
179
- * the <code>organizationEventDetailFilters</code> object in the request. Depending on the
180
- * AWS Health event type, note the following differences:</p>
181
- * <ul>
182
- * <li>
183
- * <p>To return event details for a public event, you must specify a null value for the
184
- * <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
186
- * an account.</p>
187
- * </li>
188
- * <li>
189
- * <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
192
- * because the event is specific to an account in your organization. </p>
193
- * </li>
194
- * </ul>
195
- * <p>For more information, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p>
196
- *
197
- * <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>
200
- * </note>
201
- */
42
+
202
43
  describeEventDetailsForOrganization(args: DescribeEventDetailsForOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventDetailsForOrganizationCommandOutput>;
203
44
  describeEventDetailsForOrganization(args: DescribeEventDetailsForOrganizationCommandInput, cb: (err: any, data?: DescribeEventDetailsForOrganizationCommandOutput) => void): void;
204
45
  describeEventDetailsForOrganization(args: DescribeEventDetailsForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventDetailsForOrganizationCommandOutput) => void): void;
205
- /**
206
- * <p> Returns information about events that meet the specified filter criteria. Events are
207
- * returned in a summary form and do not include the detailed description, any additional
208
- * metadata that depends on the event type, or any affected resources. To retrieve that
209
- * information, use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html">DescribeEventDetails</a> and <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html">DescribeAffectedEntities</a> operations.</p>
210
- * <p>If no filter criteria are specified, all events are returned. Results are sorted by
211
- * <code>lastModifiedTime</code>, starting with the most recent event.</p>
212
- * <note>
213
- * <ul>
214
- * <li>
215
- * <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
217
- * events that aren't specific to that resource. For example, if you call
218
- * <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
220
- * service. To get events that are specific to a service, use the
221
- * <code>services</code> parameter in the <code>filter</code> object. For more
222
- * information, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p>
223
- * </li>
224
- * <li>
225
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
226
- * </li>
227
- * </ul>
228
- * </note>
229
- */
46
+
230
47
  describeEvents(args: DescribeEventsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventsCommandOutput>;
231
48
  describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void;
232
49
  describeEvents(args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void;
233
- /**
234
- * <p>Returns information about events across your organization in AWS Organizations. You can use
235
- * the<code>filters</code> parameter to specify the events that you want to return. Events
236
- * are returned in a summary form and don't include the affected accounts, detailed
237
- * description, any additional metadata that depends on the event type, or any affected
238
- * resources. To retrieve that information, use the following operations:</p>
239
- * <ul>
240
- * <li>
241
- * <p>
242
- * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedAccountsForOrganization.html">DescribeAffectedAccountsForOrganization</a>
243
- * </p>
244
- * </li>
245
- * <li>
246
- * <p>
247
- * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html">DescribeEventDetailsForOrganization</a>
248
- * </p>
249
- * </li>
250
- * <li>
251
- * <p>
252
- * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html">DescribeAffectedEntitiesForOrganization</a>
253
- * </p>
254
- * </li>
255
- * </ul>
256
- * <p>If you don't specify a <code>filter</code>, the
257
- * <code>DescribeEventsForOrganizations</code> returns all events across your organization.
258
- * 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
262
- * management account.</p>
263
- * <note>
264
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
265
- * </note>
266
- */
50
+
267
51
  describeEventsForOrganization(args: DescribeEventsForOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventsForOrganizationCommandOutput>;
268
52
  describeEventsForOrganization(args: DescribeEventsForOrganizationCommandInput, cb: (err: any, data?: DescribeEventsForOrganizationCommandOutput) => void): void;
269
53
  describeEventsForOrganization(args: DescribeEventsForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsForOrganizationCommandOutput) => void): void;
270
- /**
271
- * <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
273
- * 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
- * <p>If you don't specify a filter criteria, the API operation returns all event types, in no
275
- * particular order. </p>
276
- * <note>
277
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
278
- * </note>
279
- */
54
+
280
55
  describeEventTypes(args: DescribeEventTypesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventTypesCommandOutput>;
281
56
  describeEventTypes(args: DescribeEventTypesCommandInput, cb: (err: any, data?: DescribeEventTypesCommandOutput) => void): void;
282
57
  describeEventTypes(args: DescribeEventTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventTypesCommandOutput) => void): void;
283
- /**
284
- * <p>This operation provides status information on enabling or disabling AWS Health to work
285
- * with your organization. To call this operation, you must sign in as an IAM user, assume
286
- * an IAM role, or sign in as the root user (not recommended) in the organization's
287
- * management account.</p>
288
- */
58
+
289
59
  describeHealthServiceStatusForOrganization(args: DescribeHealthServiceStatusForOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeHealthServiceStatusForOrganizationCommandOutput>;
290
60
  describeHealthServiceStatusForOrganization(args: DescribeHealthServiceStatusForOrganizationCommandInput, cb: (err: any, data?: DescribeHealthServiceStatusForOrganizationCommandOutput) => void): void;
291
61
  describeHealthServiceStatusForOrganization(args: DescribeHealthServiceStatusForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHealthServiceStatusForOrganizationCommandOutput) => void): void;
292
- /**
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
295
- * 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
300
- * <i>IAM User Guide</i>.</p>
301
- * <note>
302
- * <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>
307
- * </note>
308
- */
62
+
309
63
  disableHealthServiceAccessForOrganization(args: DisableHealthServiceAccessForOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<DisableHealthServiceAccessForOrganizationCommandOutput>;
310
64
  disableHealthServiceAccessForOrganization(args: DisableHealthServiceAccessForOrganizationCommandInput, cb: (err: any, data?: DisableHealthServiceAccessForOrganizationCommandOutput) => void): void;
311
65
  disableHealthServiceAccessForOrganization(args: DisableHealthServiceAccessForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableHealthServiceAccessForOrganizationCommandOutput) => void): void;
312
- /**
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>
315
- * <p>This operation also creates a service-linked role for the management account in the
316
- * organization. </p>
317
- * <note>
318
- * <p>To call this operation, you must meet the following requirements:</p>
319
- * <ul>
320
- * <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
324
- * <code>SubscriptionRequiredException</code> error.</p>
325
- * </li>
326
- * <li>
327
- * <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
329
- * identity-based policy examples</a>.</p>
330
- * </li>
331
- * </ul>
332
- * </note>
333
- * <p>If you don't have the required support plan, you can instead use the AWS Health console
334
- * 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>
336
- */
66
+
337
67
  enableHealthServiceAccessForOrganization(args: EnableHealthServiceAccessForOrganizationCommandInput, options?: __HttpHandlerOptions): Promise<EnableHealthServiceAccessForOrganizationCommandOutput>;
338
68
  enableHealthServiceAccessForOrganization(args: EnableHealthServiceAccessForOrganizationCommandInput, cb: (err: any, data?: EnableHealthServiceAccessForOrganizationCommandOutput) => void): void;
339
69
  enableHealthServiceAccessForOrganization(args: EnableHealthServiceAccessForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableHealthServiceAccessForOrganizationCommandOutput) => void): void;