@aws-sdk/client-health 3.296.0 → 3.297.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 (26) hide show
  1. package/dist-types/Health.d.ts +14 -0
  2. package/dist-types/HealthClient.d.ts +24 -4
  3. package/dist-types/commands/DescribeAffectedAccountsForOrganizationCommand.d.ts +16 -0
  4. package/dist-types/commands/DescribeAffectedEntitiesCommand.d.ts +16 -0
  5. package/dist-types/commands/DescribeAffectedEntitiesForOrganizationCommand.d.ts +16 -0
  6. package/dist-types/commands/DescribeEntityAggregatesCommand.d.ts +16 -0
  7. package/dist-types/commands/DescribeEventAggregatesCommand.d.ts +16 -0
  8. package/dist-types/commands/DescribeEventDetailsCommand.d.ts +16 -0
  9. package/dist-types/commands/DescribeEventDetailsForOrganizationCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeEventTypesCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeEventsCommand.d.ts +16 -0
  12. package/dist-types/commands/DescribeEventsForOrganizationCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeHealthServiceStatusForOrganizationCommand.d.ts +16 -0
  14. package/dist-types/commands/DisableHealthServiceAccessForOrganizationCommand.d.ts +16 -0
  15. package/dist-types/commands/EnableHealthServiceAccessForOrganizationCommand.d.ts +16 -0
  16. package/dist-types/models/HealthServiceException.d.ts +2 -0
  17. package/dist-types/models/models_0.d.ts +99 -0
  18. package/dist-types/pagination/DescribeAffectedAccountsForOrganizationPaginator.d.ts +3 -0
  19. package/dist-types/pagination/DescribeAffectedEntitiesForOrganizationPaginator.d.ts +3 -0
  20. package/dist-types/pagination/DescribeAffectedEntitiesPaginator.d.ts +3 -0
  21. package/dist-types/pagination/DescribeEventAggregatesPaginator.d.ts +3 -0
  22. package/dist-types/pagination/DescribeEventTypesPaginator.d.ts +3 -0
  23. package/dist-types/pagination/DescribeEventsForOrganizationPaginator.d.ts +3 -0
  24. package/dist-types/pagination/DescribeEventsPaginator.d.ts +3 -0
  25. package/dist-types/pagination/Interfaces.d.ts +3 -0
  26. package/package.json +3 -3
@@ -14,6 +14,7 @@ import { DisableHealthServiceAccessForOrganizationCommandInput, DisableHealthSer
14
14
  import { EnableHealthServiceAccessForOrganizationCommandInput, EnableHealthServiceAccessForOrganizationCommandOutput } from "./commands/EnableHealthServiceAccessForOrganizationCommand";
15
15
  import { HealthClient } from "./HealthClient";
16
16
  /**
17
+ * @public
17
18
  * <fullname>Health</fullname>
18
19
  *
19
20
  * <p>The Health API provides programmatic access to the Health information that
@@ -66,6 +67,7 @@ import { HealthClient } from "./HealthClient";
66
67
  */
67
68
  export declare class Health extends HealthClient {
68
69
  /**
70
+ * @public
69
71
  * <p>Returns a list of accounts in the organization from Organizations that are affected by the
70
72
  * provided event. For more information about the different types of Health events, see
71
73
  * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>. </p>
@@ -80,6 +82,7 @@ export declare class Health extends HealthClient {
80
82
  describeAffectedAccountsForOrganization(args: DescribeAffectedAccountsForOrganizationCommandInput, cb: (err: any, data?: DescribeAffectedAccountsForOrganizationCommandOutput) => void): void;
81
83
  describeAffectedAccountsForOrganization(args: DescribeAffectedAccountsForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAffectedAccountsForOrganizationCommandOutput) => void): void;
82
84
  /**
85
+ * @public
83
86
  * <p>Returns a list of entities that have been affected by the specified events, based on the
84
87
  * specified filter criteria. Entities can refer to individual customer resources, groups of
85
88
  * customer resources, or any other construct, depending on the Amazon Web Services service. Events that
@@ -103,6 +106,7 @@ export declare class Health extends HealthClient {
103
106
  describeAffectedEntities(args: DescribeAffectedEntitiesCommandInput, cb: (err: any, data?: DescribeAffectedEntitiesCommandOutput) => void): void;
104
107
  describeAffectedEntities(args: DescribeAffectedEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAffectedEntitiesCommandOutput) => void): void;
105
108
  /**
109
+ * @public
106
110
  * <p>Returns a list of entities that have been affected by one or more events for one or more
107
111
  * accounts in your organization in Organizations, based on the filter criteria. Entities can refer
108
112
  * to individual customer resources, groups of customer resources, or any other construct,
@@ -128,12 +132,14 @@ export declare class Health extends HealthClient {
128
132
  describeAffectedEntitiesForOrganization(args: DescribeAffectedEntitiesForOrganizationCommandInput, cb: (err: any, data?: DescribeAffectedEntitiesForOrganizationCommandOutput) => void): void;
129
133
  describeAffectedEntitiesForOrganization(args: DescribeAffectedEntitiesForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAffectedEntitiesForOrganizationCommandOutput) => void): void;
130
134
  /**
135
+ * @public
131
136
  * <p>Returns the number of entities that are affected by each of the specified events.</p>
132
137
  */
133
138
  describeEntityAggregates(args: DescribeEntityAggregatesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEntityAggregatesCommandOutput>;
134
139
  describeEntityAggregates(args: DescribeEntityAggregatesCommandInput, cb: (err: any, data?: DescribeEntityAggregatesCommandOutput) => void): void;
135
140
  describeEntityAggregates(args: DescribeEntityAggregatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEntityAggregatesCommandOutput) => void): void;
136
141
  /**
142
+ * @public
137
143
  * <p>Returns the number of events of each event type (issue, scheduled change, and account
138
144
  * notification). If no filter is specified, the counts of all events in each category are
139
145
  * returned.</p>
@@ -145,6 +151,7 @@ export declare class Health extends HealthClient {
145
151
  describeEventAggregates(args: DescribeEventAggregatesCommandInput, cb: (err: any, data?: DescribeEventAggregatesCommandOutput) => void): void;
146
152
  describeEventAggregates(args: DescribeEventAggregatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventAggregatesCommandOutput) => void): void;
147
153
  /**
154
+ * @public
148
155
  * <p>Returns detailed information about one or more specified events. Information includes
149
156
  * standard event data (Amazon Web Services Region, service, and so on, as returned by <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html">DescribeEvents</a>), a detailed event description, and possible additional metadata
150
157
  * that depends upon the nature of the event. Affected entities are not included. To retrieve
@@ -160,6 +167,7 @@ export declare class Health extends HealthClient {
160
167
  describeEventDetails(args: DescribeEventDetailsCommandInput, cb: (err: any, data?: DescribeEventDetailsCommandOutput) => void): void;
161
168
  describeEventDetails(args: DescribeEventDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventDetailsCommandOutput) => void): void;
162
169
  /**
170
+ * @public
163
171
  * <p>Returns detailed information about one or more specified events for one or more
164
172
  * Amazon Web Services accounts in your organization. This information includes standard event data (such as
165
173
  * the Amazon Web Services Region and service), an event description, and (depending on the event) possible
@@ -198,6 +206,7 @@ export declare class Health extends HealthClient {
198
206
  describeEventDetailsForOrganization(args: DescribeEventDetailsForOrganizationCommandInput, cb: (err: any, data?: DescribeEventDetailsForOrganizationCommandOutput) => void): void;
199
207
  describeEventDetailsForOrganization(args: DescribeEventDetailsForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventDetailsForOrganizationCommandOutput) => void): void;
200
208
  /**
209
+ * @public
201
210
  * <p> Returns information about events that meet the specified filter criteria. Events are
202
211
  * returned in a summary form and do not include the detailed description, any additional
203
212
  * metadata that depends on the event type, or any affected resources. To retrieve that
@@ -226,6 +235,7 @@ export declare class Health extends HealthClient {
226
235
  describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void;
227
236
  describeEvents(args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void;
228
237
  /**
238
+ * @public
229
239
  * <p>Returns information about events across your organization in Organizations. You can use
230
240
  * the<code>filters</code> parameter to specify the events that you want to return. Events
231
241
  * are returned in a summary form and don't include the affected accounts, detailed
@@ -263,6 +273,7 @@ export declare class Health extends HealthClient {
263
273
  describeEventsForOrganization(args: DescribeEventsForOrganizationCommandInput, cb: (err: any, data?: DescribeEventsForOrganizationCommandOutput) => void): void;
264
274
  describeEventsForOrganization(args: DescribeEventsForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsForOrganizationCommandOutput) => void): void;
265
275
  /**
276
+ * @public
266
277
  * <p>Returns the event types that meet the specified filter criteria. You can use this API
267
278
  * operation to find information about the Health event, such as the category, Amazon Web Services
268
279
  * service, and event code. The metadata for each event appears in the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EventType.html">EventType</a> object. </p>
@@ -276,6 +287,7 @@ export declare class Health extends HealthClient {
276
287
  describeEventTypes(args: DescribeEventTypesCommandInput, cb: (err: any, data?: DescribeEventTypesCommandOutput) => void): void;
277
288
  describeEventTypes(args: DescribeEventTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventTypesCommandOutput) => void): void;
278
289
  /**
290
+ * @public
279
291
  * <p>This operation provides status information on enabling or disabling Health to work
280
292
  * with your organization. To call this operation, you must sign in as an IAM user, assume
281
293
  * an IAM role, or sign in as the root user (not recommended) in the organization's
@@ -285,6 +297,7 @@ export declare class Health extends HealthClient {
285
297
  describeHealthServiceStatusForOrganization(args: DescribeHealthServiceStatusForOrganizationCommandInput, cb: (err: any, data?: DescribeHealthServiceStatusForOrganizationCommandOutput) => void): void;
286
298
  describeHealthServiceStatusForOrganization(args: DescribeHealthServiceStatusForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeHealthServiceStatusForOrganizationCommandOutput) => void): void;
287
299
  /**
300
+ * @public
288
301
  * <p>Disables Health from working with Organizations. To call this operation, you must sign
289
302
  * in as an Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not
290
303
  * recommended) in the organization's management account. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html">Aggregating
@@ -305,6 +318,7 @@ export declare class Health extends HealthClient {
305
318
  disableHealthServiceAccessForOrganization(args: DisableHealthServiceAccessForOrganizationCommandInput, cb: (err: any, data?: DisableHealthServiceAccessForOrganizationCommandOutput) => void): void;
306
319
  disableHealthServiceAccessForOrganization(args: DisableHealthServiceAccessForOrganizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableHealthServiceAccessForOrganizationCommandOutput) => void): void;
307
320
  /**
321
+ * @public
308
322
  * <p>Enables Health to work with Organizations. You can use the organizational view feature
309
323
  * to aggregate events from all Amazon Web Services accounts in your organization in a centralized location. </p>
310
324
  * <p>This operation also creates a service-linked role for the management account in the
@@ -21,15 +21,24 @@ import { DescribeHealthServiceStatusForOrganizationCommandInput, DescribeHealthS
21
21
  import { DisableHealthServiceAccessForOrganizationCommandInput, DisableHealthServiceAccessForOrganizationCommandOutput } from "./commands/DisableHealthServiceAccessForOrganizationCommand";
22
22
  import { EnableHealthServiceAccessForOrganizationCommandInput, EnableHealthServiceAccessForOrganizationCommandOutput } from "./commands/EnableHealthServiceAccessForOrganizationCommand";
23
23
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
24
+ /**
25
+ * @public
26
+ */
24
27
  export type ServiceInputTypes = DescribeAffectedAccountsForOrganizationCommandInput | DescribeAffectedEntitiesCommandInput | DescribeAffectedEntitiesForOrganizationCommandInput | DescribeEntityAggregatesCommandInput | DescribeEventAggregatesCommandInput | DescribeEventDetailsCommandInput | DescribeEventDetailsForOrganizationCommandInput | DescribeEventTypesCommandInput | DescribeEventsCommandInput | DescribeEventsForOrganizationCommandInput | DescribeHealthServiceStatusForOrganizationCommandInput | DisableHealthServiceAccessForOrganizationCommandInput | EnableHealthServiceAccessForOrganizationCommandInput;
28
+ /**
29
+ * @public
30
+ */
25
31
  export type ServiceOutputTypes = DescribeAffectedAccountsForOrganizationCommandOutput | DescribeAffectedEntitiesCommandOutput | DescribeAffectedEntitiesForOrganizationCommandOutput | DescribeEntityAggregatesCommandOutput | DescribeEventAggregatesCommandOutput | DescribeEventDetailsCommandOutput | DescribeEventDetailsForOrganizationCommandOutput | DescribeEventTypesCommandOutput | DescribeEventsCommandOutput | DescribeEventsForOrganizationCommandOutput | DescribeHealthServiceStatusForOrganizationCommandOutput | DisableHealthServiceAccessForOrganizationCommandOutput | EnableHealthServiceAccessForOrganizationCommandOutput;
32
+ /**
33
+ * @public
34
+ */
26
35
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
27
36
  /**
28
37
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
29
38
  */
30
39
  requestHandler?: __HttpHandler;
31
40
  /**
32
- * A constructor for a class implementing the {@link __Checksum} interface
41
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
33
42
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
34
43
  * @internal
35
44
  */
@@ -119,23 +128,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
119
128
  */
120
129
  logger?: __Logger;
121
130
  /**
122
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
131
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
123
132
  */
124
133
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
125
134
  }
135
+ /**
136
+ * @public
137
+ */
126
138
  type HealthClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
127
139
  /**
128
- * The configuration interface of HealthClient class constructor that set the region, credentials and other options.
140
+ * @public
141
+ *
142
+ * The configuration interface of HealthClient class constructor that set the region, credentials and other options.
129
143
  */
130
144
  export interface HealthClientConfig extends HealthClientConfigType {
131
145
  }
146
+ /**
147
+ * @public
148
+ */
132
149
  type HealthClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
133
150
  /**
134
- * The resolved configuration interface of HealthClient class. This is resolved and normalized from the {@link HealthClientConfig | constructor configuration interface}.
151
+ * @public
152
+ *
153
+ * The resolved configuration interface of HealthClient class. This is resolved and normalized from the {@link HealthClientConfig | constructor configuration interface}.
135
154
  */
136
155
  export interface HealthClientResolvedConfig extends HealthClientResolvedConfigType {
137
156
  }
138
157
  /**
158
+ * @public
139
159
  * <fullname>Health</fullname>
140
160
  *
141
161
  * <p>The Health API provides programmatic access to the Health information that
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
5
5
  import { DescribeAffectedAccountsForOrganizationRequest, DescribeAffectedAccountsForOrganizationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAffectedAccountsForOrganizationCommand}.
8
10
  */
9
11
  export interface DescribeAffectedAccountsForOrganizationCommandInput extends DescribeAffectedAccountsForOrganizationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAffectedAccountsForOrganizationCommand}.
13
17
  */
14
18
  export interface DescribeAffectedAccountsForOrganizationCommandOutput extends DescribeAffectedAccountsForOrganizationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of accounts in the organization from Organizations that are affected by the
18
23
  * provided event. For more information about the different types of Health events, see
19
24
  * <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>. </p>
@@ -33,6 +38,8 @@ export interface DescribeAffectedAccountsForOrganizationCommandOutput extends De
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param DescribeAffectedAccountsForOrganizationCommandInput - {@link DescribeAffectedAccountsForOrganizationCommandInput}
42
+ * @returns {@link DescribeAffectedAccountsForOrganizationCommandOutput}
36
43
  * @see {@link DescribeAffectedAccountsForOrganizationCommandInput} for command's `input` shape.
37
44
  * @see {@link DescribeAffectedAccountsForOrganizationCommandOutput} for command's `response` shape.
38
45
  * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
@@ -45,11 +52,20 @@ export interface DescribeAffectedAccountsForOrganizationCommandOutput extends De
45
52
  export declare class DescribeAffectedAccountsForOrganizationCommand extends $Command<DescribeAffectedAccountsForOrganizationCommandInput, DescribeAffectedAccountsForOrganizationCommandOutput, HealthClientResolvedConfig> {
46
53
  readonly input: DescribeAffectedAccountsForOrganizationCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: DescribeAffectedAccountsForOrganizationCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAffectedAccountsForOrganizationCommandInput, DescribeAffectedAccountsForOrganizationCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
5
5
  import { DescribeAffectedEntitiesRequest, DescribeAffectedEntitiesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAffectedEntitiesCommand}.
8
10
  */
9
11
  export interface DescribeAffectedEntitiesCommandInput extends DescribeAffectedEntitiesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAffectedEntitiesCommand}.
13
17
  */
14
18
  export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedEntitiesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of entities that have been affected by the specified events, based on the
18
23
  * specified filter criteria. Entities can refer to individual customer resources, groups of
19
24
  * customer resources, or any other construct, depending on the Amazon Web Services service. Events that
@@ -42,6 +47,8 @@ export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedE
42
47
  * const response = await client.send(command);
43
48
  * ```
44
49
  *
50
+ * @param DescribeAffectedEntitiesCommandInput - {@link DescribeAffectedEntitiesCommandInput}
51
+ * @returns {@link DescribeAffectedEntitiesCommandOutput}
45
52
  * @see {@link DescribeAffectedEntitiesCommandInput} for command's `input` shape.
46
53
  * @see {@link DescribeAffectedEntitiesCommandOutput} for command's `response` shape.
47
54
  * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
@@ -57,11 +64,20 @@ export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedE
57
64
  export declare class DescribeAffectedEntitiesCommand extends $Command<DescribeAffectedEntitiesCommandInput, DescribeAffectedEntitiesCommandOutput, HealthClientResolvedConfig> {
58
65
  readonly input: DescribeAffectedEntitiesCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: DescribeAffectedEntitiesCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAffectedEntitiesCommandInput, DescribeAffectedEntitiesCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
5
5
  import { DescribeAffectedEntitiesForOrganizationRequest, DescribeAffectedEntitiesForOrganizationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAffectedEntitiesForOrganizationCommand}.
8
10
  */
9
11
  export interface DescribeAffectedEntitiesForOrganizationCommandInput extends DescribeAffectedEntitiesForOrganizationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAffectedEntitiesForOrganizationCommand}.
13
17
  */
14
18
  export interface DescribeAffectedEntitiesForOrganizationCommandOutput extends DescribeAffectedEntitiesForOrganizationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of entities that have been affected by one or more events for one or more
18
23
  * accounts in your organization in Organizations, based on the filter criteria. Entities can refer
19
24
  * to individual customer resources, groups of customer resources, or any other construct,
@@ -44,6 +49,8 @@ export interface DescribeAffectedEntitiesForOrganizationCommandOutput extends De
44
49
  * const response = await client.send(command);
45
50
  * ```
46
51
  *
52
+ * @param DescribeAffectedEntitiesForOrganizationCommandInput - {@link DescribeAffectedEntitiesForOrganizationCommandInput}
53
+ * @returns {@link DescribeAffectedEntitiesForOrganizationCommandOutput}
47
54
  * @see {@link DescribeAffectedEntitiesForOrganizationCommandInput} for command's `input` shape.
48
55
  * @see {@link DescribeAffectedEntitiesForOrganizationCommandOutput} for command's `response` shape.
49
56
  * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
@@ -59,11 +66,20 @@ export interface DescribeAffectedEntitiesForOrganizationCommandOutput extends De
59
66
  export declare class DescribeAffectedEntitiesForOrganizationCommand extends $Command<DescribeAffectedEntitiesForOrganizationCommandInput, DescribeAffectedEntitiesForOrganizationCommandOutput, HealthClientResolvedConfig> {
60
67
  readonly input: DescribeAffectedEntitiesForOrganizationCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: DescribeAffectedEntitiesForOrganizationCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAffectedEntitiesForOrganizationCommandInput, DescribeAffectedEntitiesForOrganizationCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
5
5
  import { DescribeEntityAggregatesRequest, DescribeEntityAggregatesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeEntityAggregatesCommand}.
8
10
  */
9
11
  export interface DescribeEntityAggregatesCommandInput extends DescribeEntityAggregatesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeEntityAggregatesCommand}.
13
17
  */
14
18
  export interface DescribeEntityAggregatesCommandOutput extends DescribeEntityAggregatesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the number of entities that are affected by each of the specified events.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeEntityAggregatesCommandOutput extends DescribeEntityAgg
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeEntityAggregatesCommandInput - {@link DescribeEntityAggregatesCommandInput}
34
+ * @returns {@link DescribeEntityAggregatesCommandOutput}
28
35
  * @see {@link DescribeEntityAggregatesCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeEntityAggregatesCommandOutput} for command's `response` shape.
30
37
  * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
@@ -34,11 +41,20 @@ export interface DescribeEntityAggregatesCommandOutput extends DescribeEntityAgg
34
41
  export declare class DescribeEntityAggregatesCommand extends $Command<DescribeEntityAggregatesCommandInput, DescribeEntityAggregatesCommandOutput, HealthClientResolvedConfig> {
35
42
  readonly input: DescribeEntityAggregatesCommandInput;
36
43
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
44
+ /**
45
+ * @public
46
+ */
37
47
  constructor(input: DescribeEntityAggregatesCommandInput);
38
48
  /**
39
49
  * @internal
40
50
  */
41
51
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEntityAggregatesCommandInput, DescribeEntityAggregatesCommandOutput>;
52
+ /**
53
+ * @internal
54
+ */
42
55
  private serialize;
56
+ /**
57
+ * @internal
58
+ */
43
59
  private deserialize;
44
60
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
5
5
  import { DescribeEventAggregatesRequest, DescribeEventAggregatesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeEventAggregatesCommand}.
8
10
  */
9
11
  export interface DescribeEventAggregatesCommandInput extends DescribeEventAggregatesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeEventAggregatesCommand}.
13
17
  */
14
18
  export interface DescribeEventAggregatesCommandOutput extends DescribeEventAggregatesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the number of events of each event type (issue, scheduled change, and account
18
23
  * notification). If no filter is specified, the counts of all events in each category are
19
24
  * returned.</p>
@@ -30,6 +35,8 @@ export interface DescribeEventAggregatesCommandOutput extends DescribeEventAggre
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DescribeEventAggregatesCommandInput - {@link DescribeEventAggregatesCommandInput}
39
+ * @returns {@link DescribeEventAggregatesCommandOutput}
33
40
  * @see {@link DescribeEventAggregatesCommandInput} for command's `input` shape.
34
41
  * @see {@link DescribeEventAggregatesCommandOutput} for command's `response` shape.
35
42
  * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
@@ -42,11 +49,20 @@ export interface DescribeEventAggregatesCommandOutput extends DescribeEventAggre
42
49
  export declare class DescribeEventAggregatesCommand extends $Command<DescribeEventAggregatesCommandInput, DescribeEventAggregatesCommandOutput, HealthClientResolvedConfig> {
43
50
  readonly input: DescribeEventAggregatesCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: DescribeEventAggregatesCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventAggregatesCommandInput, DescribeEventAggregatesCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
5
5
  import { DescribeEventDetailsRequest, DescribeEventDetailsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeEventDetailsCommand}.
8
10
  */
9
11
  export interface DescribeEventDetailsCommandInput extends DescribeEventDetailsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeEventDetailsCommand}.
13
17
  */
14
18
  export interface DescribeEventDetailsCommandOutput extends DescribeEventDetailsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns detailed information about one or more specified events. Information includes
18
23
  * 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
19
24
  * that depends upon the nature of the event. Affected entities are not included. To retrieve
@@ -34,6 +39,8 @@ export interface DescribeEventDetailsCommandOutput extends DescribeEventDetailsR
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param DescribeEventDetailsCommandInput - {@link DescribeEventDetailsCommandInput}
43
+ * @returns {@link DescribeEventDetailsCommandOutput}
37
44
  * @see {@link DescribeEventDetailsCommandInput} for command's `input` shape.
38
45
  * @see {@link DescribeEventDetailsCommandOutput} for command's `response` shape.
39
46
  * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DescribeEventDetailsCommandOutput extends DescribeEventDetailsR
46
53
  export declare class DescribeEventDetailsCommand extends $Command<DescribeEventDetailsCommandInput, DescribeEventDetailsCommandOutput, HealthClientResolvedConfig> {
47
54
  readonly input: DescribeEventDetailsCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DescribeEventDetailsCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventDetailsCommandInput, DescribeEventDetailsCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
5
5
  import { DescribeEventDetailsForOrganizationRequest, DescribeEventDetailsForOrganizationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeEventDetailsForOrganizationCommand}.
8
10
  */
9
11
  export interface DescribeEventDetailsForOrganizationCommandInput extends DescribeEventDetailsForOrganizationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeEventDetailsForOrganizationCommand}.
13
17
  */
14
18
  export interface DescribeEventDetailsForOrganizationCommandOutput extends DescribeEventDetailsForOrganizationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns detailed information about one or more specified events for one or more
18
23
  * Amazon Web Services accounts in your organization. This information includes standard event data (such as
19
24
  * the Amazon Web Services Region and service), an event description, and (depending on the event) possible
@@ -57,6 +62,8 @@ export interface DescribeEventDetailsForOrganizationCommandOutput extends Descri
57
62
  * const response = await client.send(command);
58
63
  * ```
59
64
  *
65
+ * @param DescribeEventDetailsForOrganizationCommandInput - {@link DescribeEventDetailsForOrganizationCommandInput}
66
+ * @returns {@link DescribeEventDetailsForOrganizationCommandOutput}
60
67
  * @see {@link DescribeEventDetailsForOrganizationCommandInput} for command's `input` shape.
61
68
  * @see {@link DescribeEventDetailsForOrganizationCommandOutput} for command's `response` shape.
62
69
  * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
@@ -69,11 +76,20 @@ export interface DescribeEventDetailsForOrganizationCommandOutput extends Descri
69
76
  export declare class DescribeEventDetailsForOrganizationCommand extends $Command<DescribeEventDetailsForOrganizationCommandInput, DescribeEventDetailsForOrganizationCommandOutput, HealthClientResolvedConfig> {
70
77
  readonly input: DescribeEventDetailsForOrganizationCommandInput;
71
78
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
79
+ /**
80
+ * @public
81
+ */
72
82
  constructor(input: DescribeEventDetailsForOrganizationCommandInput);
73
83
  /**
74
84
  * @internal
75
85
  */
76
86
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventDetailsForOrganizationCommandInput, DescribeEventDetailsForOrganizationCommandOutput>;
87
+ /**
88
+ * @internal
89
+ */
77
90
  private serialize;
91
+ /**
92
+ * @internal
93
+ */
78
94
  private deserialize;
79
95
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
5
5
  import { DescribeEventTypesRequest, DescribeEventTypesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeEventTypesCommand}.
8
10
  */
9
11
  export interface DescribeEventTypesCommandInput extends DescribeEventTypesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeEventTypesCommand}.
13
17
  */
14
18
  export interface DescribeEventTypesCommandOutput extends DescribeEventTypesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the event types that meet the specified filter criteria. You can use this API
18
23
  * operation to find information about the Health event, such as the category, Amazon Web Services
19
24
  * 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>
@@ -32,6 +37,8 @@ export interface DescribeEventTypesCommandOutput extends DescribeEventTypesRespo
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param DescribeEventTypesCommandInput - {@link DescribeEventTypesCommandInput}
41
+ * @returns {@link DescribeEventTypesCommandOutput}
35
42
  * @see {@link DescribeEventTypesCommandInput} for command's `input` shape.
36
43
  * @see {@link DescribeEventTypesCommandOutput} for command's `response` shape.
37
44
  * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DescribeEventTypesCommandOutput extends DescribeEventTypesRespo
47
54
  export declare class DescribeEventTypesCommand extends $Command<DescribeEventTypesCommandInput, DescribeEventTypesCommandOutput, HealthClientResolvedConfig> {
48
55
  readonly input: DescribeEventTypesCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DescribeEventTypesCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventTypesCommandInput, DescribeEventTypesCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
5
5
  import { DescribeEventsRequest, DescribeEventsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeEventsCommand}.
8
10
  */
9
11
  export interface DescribeEventsCommandInput extends DescribeEventsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeEventsCommand}.
13
17
  */
14
18
  export interface DescribeEventsCommandOutput extends DescribeEventsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Returns information about events that meet the specified filter criteria. Events are
18
23
  * returned in a summary form and do not include the detailed description, any additional
19
24
  * metadata that depends on the event type, or any affected resources. To retrieve that
@@ -47,6 +52,8 @@ export interface DescribeEventsCommandOutput extends DescribeEventsResponse, __M
47
52
  * const response = await client.send(command);
48
53
  * ```
49
54
  *
55
+ * @param DescribeEventsCommandInput - {@link DescribeEventsCommandInput}
56
+ * @returns {@link DescribeEventsCommandOutput}
50
57
  * @see {@link DescribeEventsCommandInput} for command's `input` shape.
51
58
  * @see {@link DescribeEventsCommandOutput} for command's `response` shape.
52
59
  * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
@@ -62,11 +69,20 @@ export interface DescribeEventsCommandOutput extends DescribeEventsResponse, __M
62
69
  export declare class DescribeEventsCommand extends $Command<DescribeEventsCommandInput, DescribeEventsCommandOutput, HealthClientResolvedConfig> {
63
70
  readonly input: DescribeEventsCommandInput;
64
71
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
65
75
  constructor(input: DescribeEventsCommandInput);
66
76
  /**
67
77
  * @internal
68
78
  */
69
79
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventsCommandInput, DescribeEventsCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
70
83
  private serialize;
84
+ /**
85
+ * @internal
86
+ */
71
87
  private deserialize;
72
88
  }