@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
@@ -22,173 +22,59 @@ import { EnableHealthServiceAccessForOrganizationCommandInput, EnableHealthServi
22
22
  export declare type ServiceInputTypes = DescribeAffectedAccountsForOrganizationCommandInput | DescribeAffectedEntitiesCommandInput | DescribeAffectedEntitiesForOrganizationCommandInput | DescribeEntityAggregatesCommandInput | DescribeEventAggregatesCommandInput | DescribeEventDetailsCommandInput | DescribeEventDetailsForOrganizationCommandInput | DescribeEventTypesCommandInput | DescribeEventsCommandInput | DescribeEventsForOrganizationCommandInput | DescribeHealthServiceStatusForOrganizationCommandInput | DisableHealthServiceAccessForOrganizationCommandInput | EnableHealthServiceAccessForOrganizationCommandInput;
23
23
  export declare type ServiceOutputTypes = DescribeAffectedAccountsForOrganizationCommandOutput | DescribeAffectedEntitiesCommandOutput | DescribeAffectedEntitiesForOrganizationCommandOutput | DescribeEntityAggregatesCommandOutput | DescribeEventAggregatesCommandOutput | DescribeEventDetailsCommandOutput | DescribeEventDetailsForOrganizationCommandOutput | DescribeEventTypesCommandOutput | DescribeEventsCommandOutput | DescribeEventsForOrganizationCommandOutput | DescribeHealthServiceStatusForOrganizationCommandOutput | DisableHealthServiceAccessForOrganizationCommandOutput | EnableHealthServiceAccessForOrganizationCommandOutput;
24
24
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
25
- /**
26
- * The HTTP handler to use. Fetch in browser and Https in Nodejs.
27
- */
25
+
28
26
  requestHandler?: __HttpHandler;
29
- /**
30
- * A constructor for a class implementing the {@link __Hash} interface
31
- * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
32
- * @internal
33
- */
27
+
34
28
  sha256?: __HashConstructor;
35
- /**
36
- * The function that will be used to convert strings into HTTP endpoints.
37
- * @internal
38
- */
29
+
39
30
  urlParser?: __UrlParser;
40
- /**
41
- * A function that can calculate the length of a request body.
42
- * @internal
43
- */
31
+
44
32
  bodyLengthChecker?: (body: any) => number | undefined;
45
- /**
46
- * A function that converts a stream into an array of bytes.
47
- * @internal
48
- */
33
+
49
34
  streamCollector?: __StreamCollector;
50
- /**
51
- * The function that will be used to convert a base64-encoded string to a byte array.
52
- * @internal
53
- */
35
+
54
36
  base64Decoder?: __Decoder;
55
- /**
56
- * The function that will be used to convert binary data to a base64-encoded string.
57
- * @internal
58
- */
37
+
59
38
  base64Encoder?: __Encoder;
60
- /**
61
- * The function that will be used to convert a UTF8-encoded string to a byte array.
62
- * @internal
63
- */
39
+
64
40
  utf8Decoder?: __Decoder;
65
- /**
66
- * The function that will be used to convert binary data to a UTF-8 encoded string.
67
- * @internal
68
- */
41
+
69
42
  utf8Encoder?: __Encoder;
70
- /**
71
- * The runtime environment.
72
- * @internal
73
- */
43
+
74
44
  runtime?: string;
75
- /**
76
- * Disable dyanamically changing the endpoint of the client based on the hostPrefix
77
- * trait of an operation.
78
- */
45
+
79
46
  disableHostPrefix?: boolean;
80
- /**
81
- * Value for how many times a request will be made at most in case of retry.
82
- */
47
+
83
48
  maxAttempts?: number | __Provider<number>;
84
- /**
85
- * Specifies which retry algorithm to use.
86
- */
49
+
87
50
  retryMode?: string | __Provider<string>;
88
- /**
89
- * Optional logger for logging debug/info/warn/error.
90
- */
51
+
91
52
  logger?: __Logger;
92
- /**
93
- * Unique service identifier.
94
- * @internal
95
- */
53
+
96
54
  serviceId?: string;
97
- /**
98
- * The AWS region to which this client will send requests
99
- */
55
+
100
56
  region?: string | __Provider<string>;
101
- /**
102
- * Default credentials provider; Not available in browser runtime.
103
- * @internal
104
- */
57
+
105
58
  credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
106
- /**
107
- * Fetch related hostname, signing name or signing region with given region.
108
- * @internal
109
- */
59
+
110
60
  regionInfoProvider?: RegionInfoProvider;
111
- /**
112
- * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
113
- * @internal
114
- */
61
+
115
62
  defaultUserAgentProvider?: Provider<__UserAgent>;
116
63
  }
117
64
  declare type HealthClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
118
- /**
119
- * The configuration interface of HealthClient class constructor that set the region, credentials and other options.
120
- */
65
+
121
66
  export interface HealthClientConfig extends HealthClientConfigType {
122
67
  }
123
68
  declare type HealthClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointsResolvedConfig & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig;
124
- /**
125
- * The resolved configuration interface of HealthClient class. This is resolved and normalized from the {@link HealthClientConfig | constructor configuration interface}.
126
- */
69
+
127
70
  export interface HealthClientResolvedConfig extends HealthClientResolvedConfigType {
128
71
  }
129
- /**
130
- * <fullname>AWS Health</fullname>
131
- *
132
- * <p>The AWS Health API provides programmatic access to the AWS Health information that
133
- * appears in the <a href="https://phd.aws.amazon.com/phd/home#/">AWS Personal Health Dashboard</a>. You
134
- * can use the API operations to get information about AWS Health events that affect your
135
- * AWS services and resources.</p>
136
- * <note>
137
- * <ul>
138
- * <li>
139
- * <p>You must have a Business or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">AWS Support</a> to use the
140
- * AWS Health API. If you call the AWS Health API from an AWS account that
141
- * doesn't have a Business or Enterprise Support plan, you receive a
142
- * <code>SubscriptionRequiredException</code> error.</p>
143
- * </li>
144
- * <li>
145
- * <p>You can use the AWS Health endpoint health.us-east-1.amazonaws.com (HTTPS) to
146
- * call the AWS Health API operations. AWS Health supports a multi-Region
147
- * application architecture and has two regional endpoints in an active-passive
148
- * configuration. You can use the high availability endpoint example to determine
149
- * which AWS Region is active, so that you can get the latest information from the
150
- * 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
151
- * <i>AWS Health User Guide</i>.</p>
152
- * </li>
153
- * </ul>
154
- * </note>
155
- * <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
156
- * Process</a>.</p>
157
- * <p>If your AWS account is part of AWS Organizations, you can use the AWS Health organizational
158
- * view feature. This feature provides a centralized view of AWS Health events across all
159
- * accounts in your organization. You can aggregate AWS Health events in real time to
160
- * identify accounts in your organization that are affected by an operational event or get
161
- * notified of security vulnerabilities. Use the organizational view API operations to enable
162
- * 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
- * AWS Health events</a> in the <i>AWS Health User Guide</i>.</p>
164
- * <note>
165
- * <p>When you use the AWS Health API operations to return AWS Health events, see the
166
- * following recommendations:</p>
167
- * <ul>
168
- * <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 AWS Health
170
- * events that are public or account-specific.</p>
171
- * </li>
172
- * <li>
173
- * <p>Use pagination to view all events from the response. For example, if you call
174
- * the <code>DescribeEventsForOrganization</code> operation to get all events in your
175
- * organization, you might receive several page results. Specify the
176
- * <code>nextToken</code> in the next request to return more results.</p>
177
- * </li>
178
- * </ul>
179
- * </note>
180
- */
72
+
181
73
  export declare class HealthClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, HealthClientResolvedConfig> {
182
- /**
183
- * The resolved configuration of HealthClient class. This is resolved and normalized from the {@link HealthClientConfig | constructor configuration interface}.
184
- */
74
+
185
75
  readonly config: HealthClientResolvedConfig;
186
76
  constructor(configuration: HealthClientConfig);
187
- /**
188
- * Destroy underlying resources, like sockets. It's usually not necessary to do this.
189
- * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
190
- * Otherwise, sockets might stay open for quite a long time before the server terminates them.
191
- */
77
+
192
78
  destroy(): void;
193
79
  }
194
80
  export {};
@@ -6,37 +6,11 @@ export interface DescribeAffectedAccountsForOrganizationCommandInput extends Des
6
6
  }
7
7
  export interface DescribeAffectedAccountsForOrganizationCommandOutput extends DescribeAffectedAccountsForOrganizationResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Returns a list of accounts in the organization from AWS Organizations that are affected by the
11
- * provided event. For more information about the different types of AWS Health events, see
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 AWS Health to work with
14
- * 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
15
- * management account.</p>
16
- * <note>
17
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
18
- * </note>
19
- * @example
20
- * Use a bare-bones client and the command you need to make an API call.
21
- * ```javascript
22
- * import { HealthClient, DescribeAffectedAccountsForOrganizationCommand } from "@aws-sdk/client-health"; // ES Modules import
23
- * // const { HealthClient, DescribeAffectedAccountsForOrganizationCommand } = require("@aws-sdk/client-health"); // CommonJS import
24
- * const client = new HealthClient(config);
25
- * const command = new DescribeAffectedAccountsForOrganizationCommand(input);
26
- * const response = await client.send(command);
27
- * ```
28
- *
29
- * @see {@link DescribeAffectedAccountsForOrganizationCommandInput} for command's `input` shape.
30
- * @see {@link DescribeAffectedAccountsForOrganizationCommandOutput} for command's `response` shape.
31
- * @see {@link HealthClientResolvedConfig | config} for command's `input` shape.
32
- *
33
- */
9
+
34
10
  export declare class DescribeAffectedAccountsForOrganizationCommand extends $Command<DescribeAffectedAccountsForOrganizationCommandInput, DescribeAffectedAccountsForOrganizationCommandOutput, HealthClientResolvedConfig> {
35
11
  readonly input: DescribeAffectedAccountsForOrganizationCommandInput;
36
12
  constructor(input: DescribeAffectedAccountsForOrganizationCommandInput);
37
- /**
38
- * @internal
39
- */
13
+
40
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAffectedAccountsForOrganizationCommandInput, DescribeAffectedAccountsForOrganizationCommandOutput>;
41
15
  private serialize;
42
16
  private deserialize;
@@ -6,47 +6,11 @@ export interface DescribeAffectedEntitiesCommandInput extends DescribeAffectedEn
6
6
  }
7
7
  export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedEntitiesResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Returns a list of entities that have been affected by the specified events, based on the
11
- * specified filter criteria. Entities can refer to individual customer resources, groups of
12
- * customer resources, or any other construct, depending on the AWS service. Events that
13
- * have impact beyond that of the affected entities, or where the extent of impact is unknown,
14
- * include at least one entity indicating this.</p>
15
- * <p>At least one event ARN is required. Results are sorted by the
16
- * <code>lastUpdatedTime</code> of the entity, starting with the most recent.</p>
17
- *
18
- * <note>
19
- * <ul>
20
- * <li>
21
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
22
- * </li>
23
- * <li>
24
- * <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific AWS 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>AWS Health User Guide</i>.</p>
26
- * </li>
27
- * </ul>
28
- * </note>
29
- * @example
30
- * Use a bare-bones client and the command you need to make an API call.
31
- * ```javascript
32
- * import { HealthClient, DescribeAffectedEntitiesCommand } from "@aws-sdk/client-health"; // ES Modules import
33
- * // const { HealthClient, DescribeAffectedEntitiesCommand } = require("@aws-sdk/client-health"); // CommonJS import
34
- * const client = new HealthClient(config);
35
- * const command = new DescribeAffectedEntitiesCommand(input);
36
- * const response = await client.send(command);
37
- * ```
38
- *
39
- * @see {@link DescribeAffectedEntitiesCommandInput} for command's `input` shape.
40
- * @see {@link DescribeAffectedEntitiesCommandOutput} for command's `response` shape.
41
- * @see {@link HealthClientResolvedConfig | config} for command's `input` shape.
42
- *
43
- */
9
+
44
10
  export declare class DescribeAffectedEntitiesCommand extends $Command<DescribeAffectedEntitiesCommandInput, DescribeAffectedEntitiesCommandOutput, HealthClientResolvedConfig> {
45
11
  readonly input: DescribeAffectedEntitiesCommandInput;
46
12
  constructor(input: DescribeAffectedEntitiesCommandInput);
47
- /**
48
- * @internal
49
- */
13
+
50
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAffectedEntitiesCommandInput, DescribeAffectedEntitiesCommandOutput>;
51
15
  private serialize;
52
16
  private deserialize;
@@ -6,50 +6,11 @@ export interface DescribeAffectedEntitiesForOrganizationCommandInput extends Des
6
6
  }
7
7
  export interface DescribeAffectedEntitiesForOrganizationCommandOutput extends DescribeAffectedEntitiesForOrganizationResponse, __MetadataBearer {
8
8
  }
9
- /**
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 AWS Organizations, based on the filter criteria. Entities can refer
12
- * to individual customer resources, groups of customer resources, or any other construct,
13
- * depending on the AWS service.</p>
14
- * <p>At least one event Amazon Resource Name (ARN) and account ID are required. Results are
15
- * sorted by the <code>lastUpdatedTime</code> of the entity, starting with the most
16
- * recent.</p>
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>
19
- * operation from your organization's management account.</p>
20
- * <note>
21
- * <ul>
22
- * <li>
23
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
24
- * </li>
25
- * <li>
26
- * <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
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>AWS Health User Guide</i>.</p>
28
- * </li>
29
- * </ul>
30
- *
31
- * </note>
32
- * @example
33
- * Use a bare-bones client and the command you need to make an API call.
34
- * ```javascript
35
- * import { HealthClient, DescribeAffectedEntitiesForOrganizationCommand } from "@aws-sdk/client-health"; // ES Modules import
36
- * // const { HealthClient, DescribeAffectedEntitiesForOrganizationCommand } = require("@aws-sdk/client-health"); // CommonJS import
37
- * const client = new HealthClient(config);
38
- * const command = new DescribeAffectedEntitiesForOrganizationCommand(input);
39
- * const response = await client.send(command);
40
- * ```
41
- *
42
- * @see {@link DescribeAffectedEntitiesForOrganizationCommandInput} for command's `input` shape.
43
- * @see {@link DescribeAffectedEntitiesForOrganizationCommandOutput} for command's `response` shape.
44
- * @see {@link HealthClientResolvedConfig | config} for command's `input` shape.
45
- *
46
- */
9
+
47
10
  export declare class DescribeAffectedEntitiesForOrganizationCommand extends $Command<DescribeAffectedEntitiesForOrganizationCommandInput, DescribeAffectedEntitiesForOrganizationCommandOutput, HealthClientResolvedConfig> {
48
11
  readonly input: DescribeAffectedEntitiesForOrganizationCommandInput;
49
12
  constructor(input: DescribeAffectedEntitiesForOrganizationCommandInput);
50
- /**
51
- * @internal
52
- */
13
+
53
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAffectedEntitiesForOrganizationCommandInput, DescribeAffectedEntitiesForOrganizationCommandOutput>;
54
15
  private serialize;
55
16
  private deserialize;
@@ -6,30 +6,11 @@ export interface DescribeEntityAggregatesCommandInput extends DescribeEntityAggr
6
6
  }
7
7
  export interface DescribeEntityAggregatesCommandOutput extends DescribeEntityAggregatesResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Returns the number of entities that are affected by each of the specified events. If no
11
- * events are specified, the counts of all affected entities are returned.</p>
12
- * @example
13
- * Use a bare-bones client and the command you need to make an API call.
14
- * ```javascript
15
- * import { HealthClient, DescribeEntityAggregatesCommand } from "@aws-sdk/client-health"; // ES Modules import
16
- * // const { HealthClient, DescribeEntityAggregatesCommand } = require("@aws-sdk/client-health"); // CommonJS import
17
- * const client = new HealthClient(config);
18
- * const command = new DescribeEntityAggregatesCommand(input);
19
- * const response = await client.send(command);
20
- * ```
21
- *
22
- * @see {@link DescribeEntityAggregatesCommandInput} for command's `input` shape.
23
- * @see {@link DescribeEntityAggregatesCommandOutput} for command's `response` shape.
24
- * @see {@link HealthClientResolvedConfig | config} for command's `input` shape.
25
- *
26
- */
9
+
27
10
  export declare class DescribeEntityAggregatesCommand extends $Command<DescribeEntityAggregatesCommandInput, DescribeEntityAggregatesCommandOutput, HealthClientResolvedConfig> {
28
11
  readonly input: DescribeEntityAggregatesCommandInput;
29
12
  constructor(input: DescribeEntityAggregatesCommandInput);
30
- /**
31
- * @internal
32
- */
13
+
33
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEntityAggregatesCommandInput, DescribeEntityAggregatesCommandOutput>;
34
15
  private serialize;
35
16
  private deserialize;
@@ -6,34 +6,11 @@ export interface DescribeEventAggregatesCommandInput extends DescribeEventAggreg
6
6
  }
7
7
  export interface DescribeEventAggregatesCommandOutput extends DescribeEventAggregatesResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Returns the number of events of each event type (issue, scheduled change, and account
11
- * notification). If no filter is specified, the counts of all events in each category are
12
- * returned.</p>
13
- * <note>
14
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
15
- * </note>
16
- * @example
17
- * Use a bare-bones client and the command you need to make an API call.
18
- * ```javascript
19
- * import { HealthClient, DescribeEventAggregatesCommand } from "@aws-sdk/client-health"; // ES Modules import
20
- * // const { HealthClient, DescribeEventAggregatesCommand } = require("@aws-sdk/client-health"); // CommonJS import
21
- * const client = new HealthClient(config);
22
- * const command = new DescribeEventAggregatesCommand(input);
23
- * const response = await client.send(command);
24
- * ```
25
- *
26
- * @see {@link DescribeEventAggregatesCommandInput} for command's `input` shape.
27
- * @see {@link DescribeEventAggregatesCommandOutput} for command's `response` shape.
28
- * @see {@link HealthClientResolvedConfig | config} for command's `input` shape.
29
- *
30
- */
9
+
31
10
  export declare class DescribeEventAggregatesCommand extends $Command<DescribeEventAggregatesCommandInput, DescribeEventAggregatesCommandOutput, HealthClientResolvedConfig> {
32
11
  readonly input: DescribeEventAggregatesCommandInput;
33
12
  constructor(input: DescribeEventAggregatesCommandInput);
34
- /**
35
- * @internal
36
- */
13
+
37
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventAggregatesCommandInput, DescribeEventAggregatesCommandOutput>;
38
15
  private serialize;
39
16
  private deserialize;
@@ -6,38 +6,11 @@ export interface DescribeEventDetailsCommandInput extends DescribeEventDetailsRe
6
6
  }
7
7
  export interface DescribeEventDetailsCommandOutput extends DescribeEventDetailsResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Returns detailed information about one or more specified events. Information includes
11
- * 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
12
- * that depends upon the nature of the event. Affected entities are not included. To retrieve
13
- * the entities, use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html">DescribeAffectedEntities</a> operation.</p>
14
- * <p>If a specified event can't be retrieved, an error message is returned for that
15
- * event.</p>
16
- * <note>
17
- * <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific AWS 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>AWS Health User Guide</i>.</p>
19
- * </note>
20
- * @example
21
- * Use a bare-bones client and the command you need to make an API call.
22
- * ```javascript
23
- * import { HealthClient, DescribeEventDetailsCommand } from "@aws-sdk/client-health"; // ES Modules import
24
- * // const { HealthClient, DescribeEventDetailsCommand } = require("@aws-sdk/client-health"); // CommonJS import
25
- * const client = new HealthClient(config);
26
- * const command = new DescribeEventDetailsCommand(input);
27
- * const response = await client.send(command);
28
- * ```
29
- *
30
- * @see {@link DescribeEventDetailsCommandInput} for command's `input` shape.
31
- * @see {@link DescribeEventDetailsCommandOutput} for command's `response` shape.
32
- * @see {@link HealthClientResolvedConfig | config} for command's `input` shape.
33
- *
34
- */
9
+
35
10
  export declare class DescribeEventDetailsCommand extends $Command<DescribeEventDetailsCommandInput, DescribeEventDetailsCommandOutput, HealthClientResolvedConfig> {
36
11
  readonly input: DescribeEventDetailsCommandInput;
37
12
  constructor(input: DescribeEventDetailsCommandInput);
38
- /**
39
- * @internal
40
- */
13
+
41
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventDetailsCommandInput, DescribeEventDetailsCommandOutput>;
42
15
  private serialize;
43
16
  private deserialize;
@@ -6,61 +6,11 @@ export interface DescribeEventDetailsForOrganizationCommandInput extends Describ
6
6
  }
7
7
  export interface DescribeEventDetailsForOrganizationCommandOutput extends DescribeEventDetailsForOrganizationResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Returns detailed information about one or more specified events for one or more AWS
11
- * accounts in your organization. This information includes standard event data (such as the
12
- * AWS Region and service), an event description, and (depending on the event) possible
13
- * metadata. This operation doesn't return affected entities, such as the resources related to
14
- * 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>
15
- * <note>
16
- * <p>Before you can call this operation, you must first enable AWS Health to work with
17
- * 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
18
- * management account.</p>
19
- * </note>
20
- * <p>When you call the <code>DescribeEventDetailsForOrganization</code> operation, specify
21
- * the <code>organizationEventDetailFilters</code> object in the request. Depending on the
22
- * AWS Health event type, note the following differences:</p>
23
- * <ul>
24
- * <li>
25
- * <p>To return event details for a public event, you must specify a null value for the
26
- * <code>awsAccountId</code> parameter. If you specify an account ID for a public
27
- * event, AWS Health returns an error message because public events aren't specific to
28
- * an account.</p>
29
- * </li>
30
- * <li>
31
- * <p>To return event details for an event that is specific to an account in your
32
- * organization, you must specify the <code>awsAccountId</code> parameter in the
33
- * request. If you don't specify an account ID, AWS Health returns an error message
34
- * because the event is specific to an account in your organization. </p>
35
- * </li>
36
- * </ul>
37
- * <p>For more information, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p>
38
- *
39
- * <note>
40
- * <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
41
- * 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>
42
- * </note>
43
- * @example
44
- * Use a bare-bones client and the command you need to make an API call.
45
- * ```javascript
46
- * import { HealthClient, DescribeEventDetailsForOrganizationCommand } from "@aws-sdk/client-health"; // ES Modules import
47
- * // const { HealthClient, DescribeEventDetailsForOrganizationCommand } = require("@aws-sdk/client-health"); // CommonJS import
48
- * const client = new HealthClient(config);
49
- * const command = new DescribeEventDetailsForOrganizationCommand(input);
50
- * const response = await client.send(command);
51
- * ```
52
- *
53
- * @see {@link DescribeEventDetailsForOrganizationCommandInput} for command's `input` shape.
54
- * @see {@link DescribeEventDetailsForOrganizationCommandOutput} for command's `response` shape.
55
- * @see {@link HealthClientResolvedConfig | config} for command's `input` shape.
56
- *
57
- */
9
+
58
10
  export declare class DescribeEventDetailsForOrganizationCommand extends $Command<DescribeEventDetailsForOrganizationCommandInput, DescribeEventDetailsForOrganizationCommandOutput, HealthClientResolvedConfig> {
59
11
  readonly input: DescribeEventDetailsForOrganizationCommandInput;
60
12
  constructor(input: DescribeEventDetailsForOrganizationCommandInput);
61
- /**
62
- * @internal
63
- */
13
+
64
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventDetailsForOrganizationCommandInput, DescribeEventDetailsForOrganizationCommandOutput>;
65
15
  private serialize;
66
16
  private deserialize;
@@ -6,36 +6,11 @@ export interface DescribeEventTypesCommandInput extends DescribeEventTypesReques
6
6
  }
7
7
  export interface DescribeEventTypesCommandOutput extends DescribeEventTypesResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Returns the event types that meet the specified filter criteria. You can use this API
11
- * operation to find information about the AWS Health event, such as the category, AWS
12
- * 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>
13
- * <p>If you don't specify a filter criteria, the API operation returns all event types, in no
14
- * particular order. </p>
15
- * <note>
16
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
17
- * </note>
18
- * @example
19
- * Use a bare-bones client and the command you need to make an API call.
20
- * ```javascript
21
- * import { HealthClient, DescribeEventTypesCommand } from "@aws-sdk/client-health"; // ES Modules import
22
- * // const { HealthClient, DescribeEventTypesCommand } = require("@aws-sdk/client-health"); // CommonJS import
23
- * const client = new HealthClient(config);
24
- * const command = new DescribeEventTypesCommand(input);
25
- * const response = await client.send(command);
26
- * ```
27
- *
28
- * @see {@link DescribeEventTypesCommandInput} for command's `input` shape.
29
- * @see {@link DescribeEventTypesCommandOutput} for command's `response` shape.
30
- * @see {@link HealthClientResolvedConfig | config} for command's `input` shape.
31
- *
32
- */
9
+
33
10
  export declare class DescribeEventTypesCommand extends $Command<DescribeEventTypesCommandInput, DescribeEventTypesCommandOutput, HealthClientResolvedConfig> {
34
11
  readonly input: DescribeEventTypesCommandInput;
35
12
  constructor(input: DescribeEventTypesCommandInput);
36
- /**
37
- * @internal
38
- */
13
+
39
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventTypesCommandInput, DescribeEventTypesCommandOutput>;
40
15
  private serialize;
41
16
  private deserialize;
@@ -6,51 +6,11 @@ export interface DescribeEventsCommandInput extends DescribeEventsRequest {
6
6
  }
7
7
  export interface DescribeEventsCommandOutput extends DescribeEventsResponse, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p> Returns information about events that meet the specified filter criteria. Events are
11
- * returned in a summary form and do not include the detailed description, any additional
12
- * metadata that depends on the event type, or any affected resources. To retrieve that
13
- * 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>
14
- * <p>If no filter criteria are specified, all events are returned. Results are sorted by
15
- * <code>lastModifiedTime</code>, starting with the most recent event.</p>
16
- * <note>
17
- * <ul>
18
- * <li>
19
- * <p>When you call the <code>DescribeEvents</code> operation and specify an entity
20
- * for the <code>entityValues</code> parameter, AWS Health might return public
21
- * events that aren't specific to that resource. For example, if you call
22
- * <code>DescribeEvents</code> and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2)
23
- * instance, AWS Health might return events that aren't specific to that resource or
24
- * service. To get events that are specific to a service, use the
25
- * <code>services</code> parameter in the <code>filter</code> object. For more
26
- * information, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p>
27
- * </li>
28
- * <li>
29
- * <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
30
- * </li>
31
- * </ul>
32
- * </note>
33
- * @example
34
- * Use a bare-bones client and the command you need to make an API call.
35
- * ```javascript
36
- * import { HealthClient, DescribeEventsCommand } from "@aws-sdk/client-health"; // ES Modules import
37
- * // const { HealthClient, DescribeEventsCommand } = require("@aws-sdk/client-health"); // CommonJS import
38
- * const client = new HealthClient(config);
39
- * const command = new DescribeEventsCommand(input);
40
- * const response = await client.send(command);
41
- * ```
42
- *
43
- * @see {@link DescribeEventsCommandInput} for command's `input` shape.
44
- * @see {@link DescribeEventsCommandOutput} for command's `response` shape.
45
- * @see {@link HealthClientResolvedConfig | config} for command's `input` shape.
46
- *
47
- */
9
+
48
10
  export declare class DescribeEventsCommand extends $Command<DescribeEventsCommandInput, DescribeEventsCommandOutput, HealthClientResolvedConfig> {
49
11
  readonly input: DescribeEventsCommandInput;
50
12
  constructor(input: DescribeEventsCommandInput);
51
- /**
52
- * @internal
53
- */
13
+
54
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventsCommandInput, DescribeEventsCommandOutput>;
55
15
  private serialize;
56
16
  private deserialize;