1 | import {Request} from '../lib/request';
|
2 | import {Response} from '../lib/response';
|
3 | import {AWSError} from '../lib/error';
|
4 | import {Service} from '../lib/service';
|
5 | import {ServiceConfigurationOptions} from '../lib/service';
|
6 | import {ConfigBase as Config} from '../lib/config';
|
7 | interface Blob {}
|
8 | declare class Health extends Service {
|
9 | |
10 |
|
11 |
|
12 | constructor(options?: Health.Types.ClientConfiguration)
|
13 | config: Config & Health.Types.ClientConfiguration;
|
14 | /**
|
15 | * Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this. At least one event ARN is required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.
|
16 | */
|
17 | describeAffectedEntities(params: Health.Types.DescribeAffectedEntitiesRequest, callback?: (err: AWSError, data: Health.Types.DescribeAffectedEntitiesResponse) => void): Request<Health.Types.DescribeAffectedEntitiesResponse, AWSError>;
|
18 | /**
|
19 | * Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this. At least one event ARN is required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.
|
20 | */
|
21 | describeAffectedEntities(callback?: (err: AWSError, data: Health.Types.DescribeAffectedEntitiesResponse) => void): Request<Health.Types.DescribeAffectedEntitiesResponse, AWSError>;
|
22 | /**
|
23 | * Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned.
|
24 | */
|
25 | describeEntityAggregates(params: Health.Types.DescribeEntityAggregatesRequest, callback?: (err: AWSError, data: Health.Types.DescribeEntityAggregatesResponse) => void): Request<Health.Types.DescribeEntityAggregatesResponse, AWSError>;
|
26 | /**
|
27 | * Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned.
|
28 | */
|
29 | describeEntityAggregates(callback?: (err: AWSError, data: Health.Types.DescribeEntityAggregatesResponse) => void): Request<Health.Types.DescribeEntityAggregatesResponse, AWSError>;
|
30 | /**
|
31 | * Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned.
|
32 | */
|
33 | describeEventAggregates(params: Health.Types.DescribeEventAggregatesRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventAggregatesResponse) => void): Request<Health.Types.DescribeEventAggregatesResponse, AWSError>;
|
34 | /**
|
35 | * Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned.
|
36 | */
|
37 | describeEventAggregates(callback?: (err: AWSError, data: Health.Types.DescribeEventAggregatesResponse) => void): Request<Health.Types.DescribeEventAggregatesResponse, AWSError>;
|
38 | /**
|
39 | * Returns detailed information about one or more specified events. Information includes standard event data (region, service, etc., as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the DescribeAffectedEntities operation. If a specified event cannot be retrieved, an error message is returned for that event.
|
40 | */
|
41 | describeEventDetails(params: Health.Types.DescribeEventDetailsRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventDetailsResponse) => void): Request<Health.Types.DescribeEventDetailsResponse, AWSError>;
|
42 | /**
|
43 | * Returns detailed information about one or more specified events. Information includes standard event data (region, service, etc., as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the DescribeAffectedEntities operation. If a specified event cannot be retrieved, an error message is returned for that event.
|
44 | */
|
45 | describeEventDetails(callback?: (err: AWSError, data: Health.Types.DescribeEventDetailsResponse) => void): Request<Health.Types.DescribeEventDetailsResponse, AWSError>;
|
46 | /**
|
47 | * Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.
|
48 | */
|
49 | describeEventTypes(params: Health.Types.DescribeEventTypesRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventTypesResponse) => void): Request<Health.Types.DescribeEventTypesResponse, AWSError>;
|
50 | /**
|
51 | * Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.
|
52 | */
|
53 | describeEventTypes(callback?: (err: AWSError, data: Health.Types.DescribeEventTypesResponse) => void): Request<Health.Types.DescribeEventTypesResponse, AWSError>;
|
54 | /**
|
55 | * Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations. If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent.
|
56 | */
|
57 | describeEvents(params: Health.Types.DescribeEventsRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventsResponse) => void): Request<Health.Types.DescribeEventsResponse, AWSError>;
|
58 | /**
|
59 | * Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations. If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent.
|
60 | */
|
61 | describeEvents(callback?: (err: AWSError, data: Health.Types.DescribeEventsResponse) => void): Request<Health.Types.DescribeEventsResponse, AWSError>;
|
62 | }
|
63 | declare namespace Health {
|
64 | export interface AffectedEntity {
|
65 | |
66 |
|
67 |
|
68 | entityArn?: entityArn;
|
69 | |
70 |
|
71 |
|
72 | eventArn?: eventArn;
|
73 | |
74 |
|
75 |
|
76 | entityValue?: entityValue;
|
77 | entityUrl?: entityUrl;
|
78 | |
79 |
|
80 |
|
81 | awsAccountId?: accountId;
|
82 | |
83 |
|
84 |
|
85 | lastUpdatedTime?: timestamp;
|
86 | |
87 |
|
88 |
|
89 | statusCode?: entityStatusCode;
|
90 | |
91 |
|
92 |
|
93 | tags?: tagSet;
|
94 | }
|
95 | export interface DateTimeRange {
|
96 | |
97 |
|
98 |
|
99 | from?: timestamp;
|
100 | |
101 |
|
102 |
|
103 | to?: timestamp;
|
104 | }
|
105 | export interface DescribeAffectedEntitiesRequest {
|
106 | |
107 |
|
108 |
|
109 | filter: EntityFilter;
|
110 | |
111 |
|
112 |
|
113 | locale?: locale;
|
114 | |
115 |
|
116 |
|
117 | nextToken?: nextToken;
|
118 | |
119 |
|
120 |
|
121 | maxResults?: maxResults;
|
122 | }
|
123 | export interface DescribeAffectedEntitiesResponse {
|
124 | |
125 |
|
126 |
|
127 | entities?: EntityList;
|
128 | |
129 |
|
130 |
|
131 | nextToken?: nextToken;
|
132 | }
|
133 | export interface DescribeEntityAggregatesRequest {
|
134 | |
135 |
|
136 |
|
137 | eventArns?: EventArnsList;
|
138 | }
|
139 | export interface DescribeEntityAggregatesResponse {
|
140 | |
141 |
|
142 |
|
143 | entityAggregates?: EntityAggregateList;
|
144 | }
|
145 | export interface DescribeEventAggregatesRequest {
|
146 | |
147 |
|
148 |
|
149 | filter?: EventFilter;
|
150 | |
151 |
|
152 |
|
153 | aggregateField: eventAggregateField;
|
154 | |
155 |
|
156 |
|
157 | maxResults?: maxResults;
|
158 | |
159 |
|
160 |
|
161 | nextToken?: nextToken;
|
162 | }
|
163 | export interface DescribeEventAggregatesResponse {
|
164 | |
165 |
|
166 |
|
167 | eventAggregates?: EventAggregateList;
|
168 | |
169 |
|
170 |
|
171 | nextToken?: nextToken;
|
172 | }
|
173 | export type DescribeEventDetailsFailedSet = EventDetailsErrorItem[];
|
174 | export interface DescribeEventDetailsRequest {
|
175 | |
176 |
|
177 |
|
178 | eventArns: eventArnList;
|
179 | |
180 |
|
181 |
|
182 | locale?: locale;
|
183 | }
|
184 | export interface DescribeEventDetailsResponse {
|
185 | |
186 |
|
187 |
|
188 | successfulSet?: DescribeEventDetailsSuccessfulSet;
|
189 | |
190 |
|
191 |
|
192 | failedSet?: DescribeEventDetailsFailedSet;
|
193 | }
|
194 | export type DescribeEventDetailsSuccessfulSet = EventDetails[];
|
195 | export interface DescribeEventTypesRequest {
|
196 | |
197 |
|
198 |
|
199 | filter?: EventTypeFilter;
|
200 | |
201 |
|
202 |
|
203 | locale?: locale;
|
204 | |
205 |
|
206 |
|
207 | nextToken?: nextToken;
|
208 | |
209 |
|
210 |
|
211 | maxResults?: maxResults;
|
212 | }
|
213 | export interface DescribeEventTypesResponse {
|
214 | |
215 |
|
216 |
|
217 | eventTypes?: EventTypeList;
|
218 | |
219 |
|
220 |
|
221 | nextToken?: nextToken;
|
222 | }
|
223 | export interface DescribeEventsRequest {
|
224 | |
225 |
|
226 |
|
227 | filter?: EventFilter;
|
228 | |
229 |
|
230 |
|
231 | nextToken?: nextToken;
|
232 | |
233 |
|
234 |
|
235 | maxResults?: maxResults;
|
236 | |
237 |
|
238 |
|
239 | locale?: locale;
|
240 | }
|
241 | export interface DescribeEventsResponse {
|
242 | |
243 |
|
244 |
|
245 | events?: EventList;
|
246 | |
247 |
|
248 |
|
249 | nextToken?: nextToken;
|
250 | }
|
251 | export interface EntityAggregate {
|
252 | |
253 |
|
254 |
|
255 | eventArn?: eventArn;
|
256 | |
257 |
|
258 |
|
259 | count?: count;
|
260 | }
|
261 | export type EntityAggregateList = EntityAggregate[];
|
262 | export interface EntityFilter {
|
263 | |
264 |
|
265 |
|
266 | eventArns: eventArnList;
|
267 | |
268 |
|
269 |
|
270 | entityArns?: entityArnList;
|
271 | |
272 |
|
273 |
|
274 | entityValues?: entityValueList;
|
275 | |
276 |
|
277 |
|
278 | lastUpdatedTimes?: dateTimeRangeList;
|
279 | |
280 |
|
281 |
|
282 | tags?: tagFilter;
|
283 | |
284 |
|
285 |
|
286 | statusCodes?: entityStatusCodeList;
|
287 | }
|
288 | export type EntityList = AffectedEntity[];
|
289 | export interface Event {
|
290 | |
291 |
|
292 |
|
293 | arn?: eventArn;
|
294 | |
295 |
|
296 |
|
297 | service?: service;
|
298 | |
299 |
|
300 |
|
301 | eventTypeCode?: eventTypeCode;
|
302 | |
303 |
|
304 |
|
305 | eventTypeCategory?: eventTypeCategory;
|
306 | |
307 |
|
308 |
|
309 | region?: region;
|
310 | |
311 |
|
312 |
|
313 | availabilityZone?: availabilityZone;
|
314 | |
315 |
|
316 |
|
317 | startTime?: timestamp;
|
318 | |
319 |
|
320 |
|
321 | endTime?: timestamp;
|
322 | |
323 |
|
324 |
|
325 | lastUpdatedTime?: timestamp;
|
326 | |
327 |
|
328 |
|
329 | statusCode?: eventStatusCode;
|
330 | }
|
331 | export interface EventAggregate {
|
332 | |
333 |
|
334 |
|
335 | aggregateValue?: aggregateValue;
|
336 | |
337 |
|
338 |
|
339 | count?: count;
|
340 | }
|
341 | export type EventAggregateList = EventAggregate[];
|
342 | export type EventArnsList = eventArn[];
|
343 | export interface EventDescription {
|
344 | |
345 |
|
346 |
|
347 | latestDescription?: eventDescription;
|
348 | }
|
349 | export interface EventDetails {
|
350 | |
351 |
|
352 |
|
353 | event?: Event;
|
354 | |
355 |
|
356 |
|
357 | eventDescription?: EventDescription;
|
358 | |
359 |
|
360 |
|
361 | eventMetadata?: eventMetadata;
|
362 | }
|
363 | export interface EventDetailsErrorItem {
|
364 | |
365 |
|
366 |
|
367 | eventArn?: eventArn;
|
368 | |
369 |
|
370 |
|
371 | errorName?: string;
|
372 | |
373 |
|
374 |
|
375 | errorMessage?: string;
|
376 | }
|
377 | export interface EventFilter {
|
378 | |
379 |
|
380 |
|
381 | eventArns?: eventArnList;
|
382 | |
383 |
|
384 |
|
385 | eventTypeCodes?: eventTypeList;
|
386 | |
387 |
|
388 |
|
389 | services?: serviceList;
|
390 | |
391 |
|
392 |
|
393 | regions?: regionList;
|
394 | |
395 |
|
396 |
|
397 | availabilityZones?: availabilityZones;
|
398 | |
399 |
|
400 |
|
401 | startTimes?: dateTimeRangeList;
|
402 | |
403 |
|
404 |
|
405 | endTimes?: dateTimeRangeList;
|
406 | |
407 |
|
408 |
|
409 | lastUpdatedTimes?: dateTimeRangeList;
|
410 | |
411 |
|
412 |
|
413 | entityArns?: entityArnList;
|
414 | |
415 |
|
416 |
|
417 | entityValues?: entityValueList;
|
418 | |
419 |
|
420 |
|
421 | eventTypeCategories?: eventTypeCategoryList;
|
422 | |
423 |
|
424 |
|
425 | tags?: tagFilter;
|
426 | |
427 |
|
428 |
|
429 | eventStatusCodes?: eventStatusCodeList;
|
430 | }
|
431 | export type EventList = Event[];
|
432 | export interface EventType {
|
433 | |
434 |
|
435 |
|
436 | service?: service;
|
437 | |
438 |
|
439 |
|
440 | code?: eventTypeCode;
|
441 | |
442 |
|
443 |
|
444 | category?: eventTypeCategory;
|
445 | }
|
446 | export type EventTypeCategoryList = eventTypeCategory[];
|
447 | export type EventTypeCodeList = eventTypeCode[];
|
448 | export interface EventTypeFilter {
|
449 | |
450 |
|
451 |
|
452 | eventTypeCodes?: EventTypeCodeList;
|
453 | |
454 |
|
455 |
|
456 | services?: serviceList;
|
457 | |
458 |
|
459 |
|
460 | eventTypeCategories?: EventTypeCategoryList;
|
461 | }
|
462 | export type EventTypeList = EventType[];
|
463 | export type accountId = string;
|
464 | export type aggregateValue = string;
|
465 | export type availabilityZone = string;
|
466 | export type availabilityZones = availabilityZone[];
|
467 | export type count = number;
|
468 | export type dateTimeRangeList = DateTimeRange[];
|
469 | export type entityArn = string;
|
470 | export type entityArnList = entityArn[];
|
471 | export type entityStatusCode = "IMPAIRED"|"UNIMPAIRED"|"UNKNOWN"|string;
|
472 | export type entityStatusCodeList = entityStatusCode[];
|
473 | export type entityUrl = string;
|
474 | export type entityValue = string;
|
475 | export type entityValueList = entityValue[];
|
476 | export type eventAggregateField = "eventTypeCategory"|string;
|
477 | export type eventArn = string;
|
478 | export type eventArnList = eventArn[];
|
479 | export type eventDescription = string;
|
480 | export type eventMetadata = {[key: string]: metadataValue};
|
481 | export type eventStatusCode = "open"|"closed"|"upcoming"|string;
|
482 | export type eventStatusCodeList = eventStatusCode[];
|
483 | export type eventType = string;
|
484 | export type eventTypeCategory = "issue"|"accountNotification"|"scheduledChange"|"investigation"|string;
|
485 | export type eventTypeCategoryList = eventTypeCategory[];
|
486 | export type eventTypeCode = string;
|
487 | export type eventTypeList = eventType[];
|
488 | export type locale = string;
|
489 | export type maxResults = number;
|
490 | export type metadataKey = string;
|
491 | export type metadataValue = string;
|
492 | export type nextToken = string;
|
493 | export type region = string;
|
494 | export type regionList = region[];
|
495 | export type service = string;
|
496 | export type serviceList = service[];
|
497 | export type tagFilter = tagSet[];
|
498 | export type tagKey = string;
|
499 | export type tagSet = {[key: string]: tagValue};
|
500 | export type tagValue = string;
|
501 | export type timestamp = Date;
|
502 | |
503 |
|
504 |
|
505 | export type apiVersion = "2016-08-04"|"latest"|string;
|
506 | export interface ClientApiVersions {
|
507 | |
508 |
|
509 |
|
510 | apiVersion?: apiVersion;
|
511 | }
|
512 | export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
|
513 | |
514 |
|
515 |
|
516 | export import Types = Health;
|
517 | }
|
518 | export = Health;
|