@aws-sdk/client-internetmonitor 3.379.1 → 3.385.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.
- package/README.md +3 -3
- package/dist-cjs/endpoint/ruleset.js +1 -1
- package/dist-cjs/models/models_0.js +7 -1
- package/dist-cjs/protocols/Aws_restJson1.js +18 -0
- package/dist-es/endpoint/ruleset.js +1 -1
- package/dist-es/models/models_0.js +6 -0
- package/dist-es/protocols/Aws_restJson1.js +18 -0
- package/dist-types/InternetMonitor.d.ts +3 -3
- package/dist-types/InternetMonitorClient.d.ts +3 -3
- package/dist-types/commands/CreateMonitorCommand.d.ts +19 -7
- package/dist-types/commands/GetHealthEventCommand.d.ts +3 -3
- package/dist-types/commands/GetMonitorCommand.d.ts +10 -0
- package/dist-types/commands/ListHealthEventsCommand.d.ts +2 -2
- package/dist-types/commands/UpdateMonitorCommand.d.ts +12 -3
- package/dist-types/index.d.ts +3 -3
- package/dist-types/models/models_0.d.ts +252 -39
- package/dist-types/ts3.4/models/models_0.d.ts +15 -0
- package/package.json +5 -5
|
@@ -14,7 +14,8 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
16
|
* @public
|
|
17
|
-
* <p>
|
|
17
|
+
* <p>Amazon CloudWatch Internet Monitor calculates measurements about the availability for your application's internet traffic between client locations and Amazon Web Services.
|
|
18
|
+
* Amazon Web Services has substantial historical data about internet
|
|
18
19
|
* performance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor
|
|
19
20
|
* can detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it
|
|
20
21
|
* easier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.</p>
|
|
@@ -25,6 +26,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
25
26
|
*/
|
|
26
27
|
export interface AvailabilityMeasurement {
|
|
27
28
|
/**
|
|
29
|
+
* @public
|
|
28
30
|
* <p>Experience scores, or health scores are calculated for different geographic and network provider combinations (that is, different granularities) and
|
|
29
31
|
* also summed into global scores. If you view performance or availability scores without filtering for any specific geography or service provider, Amazon CloudWatch Internet Monitor
|
|
30
32
|
* provides global health scores.</p>
|
|
@@ -34,12 +36,16 @@ export interface AvailabilityMeasurement {
|
|
|
34
36
|
*/
|
|
35
37
|
ExperienceScore?: number;
|
|
36
38
|
/**
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
+
* @public
|
|
40
|
+
* <p>The impact on total traffic that a health event has, in increased latency or reduced availability. This is the
|
|
41
|
+
* percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this
|
|
42
|
+
* client location to the Amazon Web Services location using this client network.</p>
|
|
43
|
+
* <p>For information about how Internet Monitor calculates impact, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html">How Internet Monitor works</a> in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User
|
|
39
44
|
* Guide.</p>
|
|
40
45
|
*/
|
|
41
46
|
PercentOfTotalTrafficImpacted?: number;
|
|
42
47
|
/**
|
|
48
|
+
* @public
|
|
43
49
|
* <p>The percentage of impact caused by a health event for client location traffic globally.</p>
|
|
44
50
|
* <p>For information about how Internet Monitor calculates impact, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html">Inside Internet Monitor</a> in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User
|
|
45
51
|
* Guide.</p>
|
|
@@ -72,19 +78,81 @@ export declare class ConflictException extends __BaseException {
|
|
|
72
78
|
}
|
|
73
79
|
/**
|
|
74
80
|
* @public
|
|
75
|
-
*
|
|
76
|
-
|
|
77
|
-
|
|
81
|
+
* @enum
|
|
82
|
+
*/
|
|
83
|
+
export declare const LocalHealthEventsConfigStatus: {
|
|
84
|
+
readonly DISABLED: "DISABLED";
|
|
85
|
+
readonly ENABLED: "ENABLED";
|
|
86
|
+
};
|
|
87
|
+
/**
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
export type LocalHealthEventsConfigStatus = (typeof LocalHealthEventsConfigStatus)[keyof typeof LocalHealthEventsConfigStatus];
|
|
91
|
+
/**
|
|
92
|
+
* @public
|
|
93
|
+
* <p>A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event
|
|
94
|
+
* for a local performance or availability issue, when scores cross a threshold for one or more city-networks.</p>
|
|
95
|
+
* <p>Defines the percentages, for performance scores or availability scores, that are the local thresholds
|
|
96
|
+
* for when Amazon CloudWatch Internet Monitor creates a health event. Also defines whether a local threshold is enabled or disabled, and the minimum percentage
|
|
97
|
+
* of overall traffic that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.</p>
|
|
98
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview">
|
|
99
|
+
* Change health event thresholds</a> in the Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
100
|
+
*/
|
|
101
|
+
export interface LocalHealthEventsConfig {
|
|
102
|
+
/**
|
|
103
|
+
* @public
|
|
104
|
+
* <p>The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be <code>ENABLED</code>
|
|
105
|
+
* or <code>DISABLED</code>.</p>
|
|
106
|
+
*/
|
|
107
|
+
Status?: LocalHealthEventsConfigStatus | string;
|
|
108
|
+
/**
|
|
109
|
+
* @public
|
|
110
|
+
* <p>The health event threshold percentage set for a local health score.</p>
|
|
111
|
+
*/
|
|
112
|
+
HealthScoreThreshold?: number;
|
|
113
|
+
/**
|
|
114
|
+
* @public
|
|
115
|
+
* <p>The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a
|
|
116
|
+
* threshold is crossed for a local health score.</p>
|
|
117
|
+
*/
|
|
118
|
+
MinTrafficImpact?: number;
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* @public
|
|
122
|
+
* <p>A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event
|
|
123
|
+
* for an overall performance or availability issue, across an application's geographies.</p>
|
|
124
|
+
* <p>Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds
|
|
125
|
+
* for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores,
|
|
126
|
+
* or both.</p>
|
|
127
|
+
* <p>You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks,
|
|
128
|
+
* in addition to creating an event when an overall score crosses a threshold.</p>
|
|
129
|
+
* <p>If you don't set a health event threshold, the default value is 95%.</p>
|
|
130
|
+
* <p>For local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event.
|
|
131
|
+
* In addition, you can disable local thresholds, for performance scores, availability scores, or both.</p>
|
|
132
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview">
|
|
133
|
+
* Change health event thresholds</a> in the Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
78
134
|
*/
|
|
79
135
|
export interface HealthEventsConfig {
|
|
80
136
|
/**
|
|
137
|
+
* @public
|
|
81
138
|
* <p>The health event threshold percentage set for availability scores.</p>
|
|
82
139
|
*/
|
|
83
140
|
AvailabilityScoreThreshold?: number;
|
|
84
141
|
/**
|
|
142
|
+
* @public
|
|
85
143
|
* <p>The health event threshold percentage set for performance scores.</p>
|
|
86
144
|
*/
|
|
87
145
|
PerformanceScoreThreshold?: number;
|
|
146
|
+
/**
|
|
147
|
+
* @public
|
|
148
|
+
* <p>The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.</p>
|
|
149
|
+
*/
|
|
150
|
+
AvailabilityLocalHealthEventsConfig?: LocalHealthEventsConfig;
|
|
151
|
+
/**
|
|
152
|
+
* @public
|
|
153
|
+
* <p>The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.</p>
|
|
154
|
+
*/
|
|
155
|
+
PerformanceLocalHealthEventsConfig?: LocalHealthEventsConfig;
|
|
88
156
|
}
|
|
89
157
|
/**
|
|
90
158
|
* @public
|
|
@@ -106,14 +174,17 @@ export type LogDeliveryStatus = (typeof LogDeliveryStatus)[keyof typeof LogDeliv
|
|
|
106
174
|
*/
|
|
107
175
|
export interface S3Config {
|
|
108
176
|
/**
|
|
177
|
+
* @public
|
|
109
178
|
* <p>The Amazon S3 bucket name.</p>
|
|
110
179
|
*/
|
|
111
180
|
BucketName?: string;
|
|
112
181
|
/**
|
|
182
|
+
* @public
|
|
113
183
|
* <p>The Amazon S3 bucket prefix.</p>
|
|
114
184
|
*/
|
|
115
185
|
BucketPrefix?: string;
|
|
116
186
|
/**
|
|
187
|
+
* @public
|
|
117
188
|
* <p>The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket.</p>
|
|
118
189
|
*/
|
|
119
190
|
LogDeliveryStatus?: LogDeliveryStatus | string;
|
|
@@ -124,6 +195,7 @@ export interface S3Config {
|
|
|
124
195
|
*/
|
|
125
196
|
export interface InternetMeasurementsLogDelivery {
|
|
126
197
|
/**
|
|
198
|
+
* @public
|
|
127
199
|
* <p>The configuration information for publishing Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) prefix
|
|
128
200
|
* for the S3 bucket to store the measurements, and the delivery status. The delivery status is <code>ENABLED</code> or <code>DISABLED</code>, depending on
|
|
129
201
|
* whether you choose to deliver internet measurements to S3 logs.</p>
|
|
@@ -135,46 +207,63 @@ export interface InternetMeasurementsLogDelivery {
|
|
|
135
207
|
*/
|
|
136
208
|
export interface CreateMonitorInput {
|
|
137
209
|
/**
|
|
210
|
+
* @public
|
|
138
211
|
* <p>The name of the monitor. </p>
|
|
139
212
|
*/
|
|
140
213
|
MonitorName: string | undefined;
|
|
141
214
|
/**
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
*
|
|
215
|
+
* @public
|
|
216
|
+
* <p>The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs,
|
|
217
|
+
* Amazon CloudFront distributions, or Amazon WorkSpaces directories.</p>
|
|
218
|
+
* <p>You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add
|
|
219
|
+
* NLBs or WorkSpaces directories together with any other resources.</p>
|
|
145
220
|
* <note>
|
|
146
|
-
* <p>If you add only VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has
|
|
221
|
+
* <p>If you add only Amazon VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has
|
|
222
|
+
* internet connectivity.</p>
|
|
147
223
|
* </note>
|
|
148
224
|
*/
|
|
149
225
|
Resources?: string[];
|
|
150
226
|
/**
|
|
227
|
+
* @public
|
|
151
228
|
* <p>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for
|
|
152
229
|
* other API requests.</p>
|
|
153
230
|
*/
|
|
154
231
|
ClientToken?: string;
|
|
155
232
|
/**
|
|
233
|
+
* @public
|
|
156
234
|
* <p>The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.</p>
|
|
157
235
|
*/
|
|
158
236
|
Tags?: Record<string, string>;
|
|
159
237
|
/**
|
|
160
|
-
*
|
|
161
|
-
*
|
|
238
|
+
* @public
|
|
239
|
+
* <p>The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your
|
|
240
|
+
* application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources
|
|
241
|
+
* through. Setting this limit can help control billing costs.</p>
|
|
162
242
|
* <p>To learn more, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html">Choosing a city-network maximum value
|
|
163
243
|
* </a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
164
244
|
*/
|
|
165
245
|
MaxCityNetworksToMonitor?: number;
|
|
166
246
|
/**
|
|
247
|
+
* @public
|
|
167
248
|
* <p>Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs.</p>
|
|
168
249
|
*/
|
|
169
250
|
InternetMeasurementsLogDelivery?: InternetMeasurementsLogDelivery;
|
|
170
251
|
/**
|
|
171
|
-
*
|
|
252
|
+
* @public
|
|
253
|
+
* <p>The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks
|
|
254
|
+
* maximum, that limit overrides the traffic percentage that you set.</p>
|
|
255
|
+
* <p>To learn more, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html">Choosing an application traffic percentage to monitor
|
|
256
|
+
* </a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
172
257
|
*/
|
|
173
258
|
TrafficPercentageToMonitor?: number;
|
|
174
259
|
/**
|
|
175
|
-
*
|
|
176
|
-
*
|
|
177
|
-
*
|
|
260
|
+
* @public
|
|
261
|
+
* <p>Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event. Internet Monitor creates a
|
|
262
|
+
* health event when an internet issue that affects your application end users has a health score percentage that is at or below a
|
|
263
|
+
* specific threshold, and, sometimes, when other criteria are met.</p>
|
|
264
|
+
* <p>If you don't set a health event threshold, the default value is 95%.</p>
|
|
265
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview">
|
|
266
|
+
* Change health event thresholds</a> in the Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
178
267
|
*/
|
|
179
268
|
HealthEventsConfig?: HealthEventsConfig;
|
|
180
269
|
}
|
|
@@ -197,10 +286,12 @@ export type MonitorConfigState = (typeof MonitorConfigState)[keyof typeof Monito
|
|
|
197
286
|
*/
|
|
198
287
|
export interface CreateMonitorOutput {
|
|
199
288
|
/**
|
|
289
|
+
* @public
|
|
200
290
|
* <p>The Amazon Resource Name (ARN) of the monitor.</p>
|
|
201
291
|
*/
|
|
202
292
|
Arn: string | undefined;
|
|
203
293
|
/**
|
|
294
|
+
* @public
|
|
204
295
|
* <p>The status of a monitor.</p>
|
|
205
296
|
*/
|
|
206
297
|
Status: MonitorConfigState | string | undefined;
|
|
@@ -262,6 +353,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
262
353
|
*/
|
|
263
354
|
export interface DeleteMonitorInput {
|
|
264
355
|
/**
|
|
356
|
+
* @public
|
|
265
357
|
* <p>The name of the monitor to delete.</p>
|
|
266
358
|
*/
|
|
267
359
|
MonitorName: string | undefined;
|
|
@@ -276,10 +368,12 @@ export interface DeleteMonitorOutput {
|
|
|
276
368
|
*/
|
|
277
369
|
export interface GetHealthEventInput {
|
|
278
370
|
/**
|
|
371
|
+
* @public
|
|
279
372
|
* <p>The name of the monitor.</p>
|
|
280
373
|
*/
|
|
281
374
|
MonitorName: string | undefined;
|
|
282
375
|
/**
|
|
376
|
+
* @public
|
|
283
377
|
* <p>The internally generated identifier of a health event. Because <code>EventID</code> contains the forward slash (“/”) character, you must
|
|
284
378
|
* URL-encode the <code>EventID</code> field in the request URL.</p>
|
|
285
379
|
*/
|
|
@@ -291,10 +385,12 @@ export interface GetHealthEventInput {
|
|
|
291
385
|
*/
|
|
292
386
|
export interface Network {
|
|
293
387
|
/**
|
|
388
|
+
* @public
|
|
294
389
|
* <p>The internet provider name or network name.</p>
|
|
295
390
|
*/
|
|
296
391
|
ASName: string | undefined;
|
|
297
392
|
/**
|
|
393
|
+
* @public
|
|
298
394
|
* <p>The Autonomous System Number (ASN) of the internet provider or network.</p>
|
|
299
395
|
*/
|
|
300
396
|
ASNumber: number | undefined;
|
|
@@ -317,14 +413,17 @@ export type TriangulationEventType = (typeof TriangulationEventType)[keyof typeo
|
|
|
317
413
|
*/
|
|
318
414
|
export interface NetworkImpairment {
|
|
319
415
|
/**
|
|
416
|
+
* @public
|
|
320
417
|
* <p>The networks that could be impacted by a network impairment event.</p>
|
|
321
418
|
*/
|
|
322
419
|
Networks: Network[] | undefined;
|
|
323
420
|
/**
|
|
421
|
+
* @public
|
|
324
422
|
* <p>The combination of the Autonomous System Number (ASN) of the network and the name of the network.</p>
|
|
325
423
|
*/
|
|
326
424
|
AsPath: Network[] | undefined;
|
|
327
425
|
/**
|
|
426
|
+
* @public
|
|
328
427
|
* <p>Type of network impairment.</p>
|
|
329
428
|
*/
|
|
330
429
|
NetworkEventType: TriangulationEventType | string | undefined;
|
|
@@ -336,21 +435,25 @@ export interface NetworkImpairment {
|
|
|
336
435
|
*/
|
|
337
436
|
export interface RoundTripTime {
|
|
338
437
|
/**
|
|
438
|
+
* @public
|
|
339
439
|
* <p>RTT at the 50th percentile (p50).</p>
|
|
340
440
|
*/
|
|
341
441
|
P50?: number;
|
|
342
442
|
/**
|
|
443
|
+
* @public
|
|
343
444
|
* <p>RTT at the 90th percentile (p90). </p>
|
|
344
445
|
*/
|
|
345
446
|
P90?: number;
|
|
346
447
|
/**
|
|
448
|
+
* @public
|
|
347
449
|
* <p>RTT at the 95th percentile (p95). </p>
|
|
348
450
|
*/
|
|
349
451
|
P95?: number;
|
|
350
452
|
}
|
|
351
453
|
/**
|
|
352
454
|
* @public
|
|
353
|
-
* <p>
|
|
455
|
+
* <p>Amazon CloudWatch Internet Monitor calculates measurements about the performance for your application's internet traffic between client locations and Amazon Web Services.
|
|
456
|
+
* Amazon Web Services has substantial historical data about internet
|
|
354
457
|
* performance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor
|
|
355
458
|
* can detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it
|
|
356
459
|
* easier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.</p>
|
|
@@ -361,6 +464,7 @@ export interface RoundTripTime {
|
|
|
361
464
|
*/
|
|
362
465
|
export interface PerformanceMeasurement {
|
|
363
466
|
/**
|
|
467
|
+
* @public
|
|
364
468
|
* <p>Experience scores, or health scores, are calculated for different geographic and network provider combinations (that is, different granularities) and
|
|
365
469
|
* also totaled into global scores. If you view performance or availability scores without filtering for any specific geography or service provider, Amazon CloudWatch Internet Monitor
|
|
366
470
|
* provides global health scores.</p>
|
|
@@ -370,13 +474,16 @@ export interface PerformanceMeasurement {
|
|
|
370
474
|
*/
|
|
371
475
|
ExperienceScore?: number;
|
|
372
476
|
/**
|
|
373
|
-
*
|
|
374
|
-
*
|
|
477
|
+
* @public
|
|
478
|
+
* <p>The impact on total traffic that a health event has, in increased latency or reduced availability. This is the
|
|
479
|
+
* percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this
|
|
480
|
+
* client location to the Amazon Web Services location using this client network.</p>
|
|
375
481
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMHealthEventStartStop">When Amazon Web Services creates and resolves health
|
|
376
482
|
* events</a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
377
483
|
*/
|
|
378
484
|
PercentOfTotalTrafficImpacted?: number;
|
|
379
485
|
/**
|
|
486
|
+
* @public
|
|
380
487
|
* <p>How much performance impact was caused by a health event at a client location. For performance, this is the percentage of how much latency increased
|
|
381
488
|
* during the event compared to typical performance for traffic, from this client location to an Amazon Web Services location, using a specific client network. </p>
|
|
382
489
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMHealthEventStartStop">When Amazon Web Services creates and resolves health
|
|
@@ -384,6 +491,7 @@ export interface PerformanceMeasurement {
|
|
|
384
491
|
*/
|
|
385
492
|
PercentOfClientLocationImpacted?: number;
|
|
386
493
|
/**
|
|
494
|
+
* @public
|
|
387
495
|
* <p>This is the percentage of how much round-trip time increased during the event compared to typical round-trip time for your application for traffic. </p>
|
|
388
496
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMHealthEventStartStop">When Amazon Web Services creates and resolves health
|
|
389
497
|
* events</a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
@@ -395,11 +503,12 @@ export interface PerformanceMeasurement {
|
|
|
395
503
|
* <p>Internet health includes measurements calculated by Amazon CloudWatch Internet Monitor about the performance and availability for your application on the internet. Amazon Web Services has
|
|
396
504
|
* substantial historical data about internet performance and availability between Amazon Web Services services and different network providers and geographies. By
|
|
397
505
|
* applying statistical analysis to the data, Internet Monitor can detect when the performance and availability for your application has dropped, compared to an
|
|
398
|
-
* estimated baseline that's already calculated. To make it easier to see those drops,
|
|
506
|
+
* estimated baseline that's already calculated. To make it easier to see those drops, Internet Monitor reports the information to you in the form of health scores: a
|
|
399
507
|
* performance score and an availability score.</p>
|
|
400
508
|
*/
|
|
401
509
|
export interface InternetHealth {
|
|
402
510
|
/**
|
|
511
|
+
* @public
|
|
403
512
|
* <p>Availability in Internet Monitor represents the estimated percentage of traffic that is not seeing an availability drop. For example, an availability score of 99%
|
|
404
513
|
* for an end user and service location pair is equivalent to 1% of the traffic experiencing an availability drop for that pair.</p>
|
|
405
514
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores">How Internet Monitor calculates performance and availability
|
|
@@ -407,6 +516,7 @@ export interface InternetHealth {
|
|
|
407
516
|
*/
|
|
408
517
|
Availability?: AvailabilityMeasurement;
|
|
409
518
|
/**
|
|
519
|
+
* @public
|
|
410
520
|
* <p>Performance in Internet Monitor represents the estimated percentage of traffic that is not seeing a performance drop. For example, a performance score of 99% for
|
|
411
521
|
* an end user and service location pair is equivalent to 1% of the traffic experiencing a performance drop for that pair.</p>
|
|
412
522
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores">How Internet Monitor calculates performance and availability
|
|
@@ -435,24 +545,29 @@ export type HealthEventStatus = (typeof HealthEventStatus)[keyof typeof HealthEv
|
|
|
435
545
|
*/
|
|
436
546
|
export interface ImpactedLocation {
|
|
437
547
|
/**
|
|
548
|
+
* @public
|
|
438
549
|
* <p>The name of the network at an impacted location.</p>
|
|
439
550
|
*/
|
|
440
551
|
ASName: string | undefined;
|
|
441
552
|
/**
|
|
553
|
+
* @public
|
|
442
554
|
* <p>The Autonomous System Number (ASN) of the network at an impacted location.</p>
|
|
443
555
|
*/
|
|
444
556
|
ASNumber: number | undefined;
|
|
445
557
|
/**
|
|
558
|
+
* @public
|
|
446
559
|
* <p>The name of the country where the health event is located.</p>
|
|
447
560
|
*/
|
|
448
561
|
Country: string | undefined;
|
|
449
562
|
/**
|
|
563
|
+
* @public
|
|
450
564
|
* <p>The subdivision location where the health event is located. The subdivision usually maps to
|
|
451
565
|
* states in most countries (including the United States). For United Kingdom, it maps to a country (England,
|
|
452
566
|
* Scotland, Wales) or province (Northern Ireland).</p>
|
|
453
567
|
*/
|
|
454
568
|
Subdivision?: string;
|
|
455
569
|
/**
|
|
570
|
+
* @public
|
|
456
571
|
* <p>The metro area where the health event is located.</p>
|
|
457
572
|
* <p>Metro indicates a metropolitan region in the United States, such as the region around New York City.
|
|
458
573
|
* In non-US countries, this is a second-level subdivision. For example, in the United Kingdom, it could be
|
|
@@ -460,41 +575,50 @@ export interface ImpactedLocation {
|
|
|
460
575
|
*/
|
|
461
576
|
Metro?: string;
|
|
462
577
|
/**
|
|
578
|
+
* @public
|
|
463
579
|
* <p>The name of the city where the health event is located.</p>
|
|
464
580
|
*/
|
|
465
581
|
City?: string;
|
|
466
582
|
/**
|
|
583
|
+
* @public
|
|
467
584
|
* <p>The latitude where the health event is located.</p>
|
|
468
585
|
*/
|
|
469
586
|
Latitude?: number;
|
|
470
587
|
/**
|
|
588
|
+
* @public
|
|
471
589
|
* <p>The longitude where the health event is located.</p>
|
|
472
590
|
*/
|
|
473
591
|
Longitude?: number;
|
|
474
592
|
/**
|
|
593
|
+
* @public
|
|
475
594
|
* <p>The country code where the health event is located. The ISO 3166-2 codes for the
|
|
476
595
|
* country is provided, when available. </p>
|
|
477
596
|
*/
|
|
478
597
|
CountryCode?: string;
|
|
479
598
|
/**
|
|
599
|
+
* @public
|
|
480
600
|
* <p>The subdivision code where the health event is located. The ISO 3166-2 codes for
|
|
481
601
|
* country subdivisions is provided, when available. </p>
|
|
482
602
|
*/
|
|
483
603
|
SubdivisionCode?: string;
|
|
484
604
|
/**
|
|
605
|
+
* @public
|
|
485
606
|
* <p>The service location where the health event is located.</p>
|
|
486
607
|
*/
|
|
487
608
|
ServiceLocation?: string;
|
|
488
609
|
/**
|
|
610
|
+
* @public
|
|
489
611
|
* <p>The status of the health event at an impacted location.</p>
|
|
490
612
|
*/
|
|
491
613
|
Status: HealthEventStatus | string | undefined;
|
|
492
614
|
/**
|
|
615
|
+
* @public
|
|
493
616
|
* <p>The cause of the impairment. There are two types of network impairments: Amazon Web Services network issues
|
|
494
617
|
* or internet issues. Internet issues are typically a problem with a network provider, like an internet service provider (ISP).</p>
|
|
495
618
|
*/
|
|
496
619
|
CausedBy?: NetworkImpairment;
|
|
497
620
|
/**
|
|
621
|
+
* @public
|
|
498
622
|
* <p>The calculated health at a specific location.</p>
|
|
499
623
|
*/
|
|
500
624
|
InternetHealth?: InternetHealth;
|
|
@@ -505,6 +629,8 @@ export interface ImpactedLocation {
|
|
|
505
629
|
*/
|
|
506
630
|
export declare const HealthEventImpactType: {
|
|
507
631
|
readonly AVAILABILITY: "AVAILABILITY";
|
|
632
|
+
readonly LOCAL_AVAILABILITY: "LOCAL_AVAILABILITY";
|
|
633
|
+
readonly LOCAL_PERFORMANCE: "LOCAL_PERFORMANCE";
|
|
508
634
|
readonly PERFORMANCE: "PERFORMANCE";
|
|
509
635
|
};
|
|
510
636
|
/**
|
|
@@ -516,47 +642,61 @@ export type HealthEventImpactType = (typeof HealthEventImpactType)[keyof typeof
|
|
|
516
642
|
*/
|
|
517
643
|
export interface GetHealthEventOutput {
|
|
518
644
|
/**
|
|
645
|
+
* @public
|
|
519
646
|
* <p>The Amazon Resource Name (ARN) of the event.</p>
|
|
520
647
|
*/
|
|
521
648
|
EventArn: string | undefined;
|
|
522
649
|
/**
|
|
650
|
+
* @public
|
|
523
651
|
* <p>The internally generated identifier of a health event.</p>
|
|
524
652
|
*/
|
|
525
653
|
EventId: string | undefined;
|
|
526
654
|
/**
|
|
655
|
+
* @public
|
|
527
656
|
* <p>The time when a health event started.</p>
|
|
528
657
|
*/
|
|
529
658
|
StartedAt: Date | undefined;
|
|
530
659
|
/**
|
|
660
|
+
* @public
|
|
531
661
|
* <p>The time when a health event was resolved. If the health event is still active, the end time is not set.</p>
|
|
532
662
|
*/
|
|
533
663
|
EndedAt?: Date;
|
|
534
664
|
/**
|
|
665
|
+
* @public
|
|
535
666
|
* <p>The time when a health event was created.</p>
|
|
536
667
|
*/
|
|
537
668
|
CreatedAt?: Date;
|
|
538
669
|
/**
|
|
670
|
+
* @public
|
|
539
671
|
* <p>The time when a health event was last updated or recalculated.</p>
|
|
540
672
|
*/
|
|
541
673
|
LastUpdatedAt: Date | undefined;
|
|
542
674
|
/**
|
|
675
|
+
* @public
|
|
543
676
|
* <p>The locations affected by a health event.</p>
|
|
544
677
|
*/
|
|
545
678
|
ImpactedLocations: ImpactedLocation[] | undefined;
|
|
546
679
|
/**
|
|
680
|
+
* @public
|
|
547
681
|
* <p>The status of a health event.</p>
|
|
548
682
|
*/
|
|
549
683
|
Status: HealthEventStatus | string | undefined;
|
|
550
684
|
/**
|
|
551
|
-
*
|
|
685
|
+
* @public
|
|
686
|
+
* <p>The impact on total traffic that a health event has, in increased latency or reduced availability. This is the
|
|
687
|
+
* percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this
|
|
688
|
+
* client location to the Amazon Web Services location using this client network.</p>
|
|
552
689
|
*/
|
|
553
690
|
PercentOfTotalTrafficImpacted?: number;
|
|
554
691
|
/**
|
|
692
|
+
* @public
|
|
555
693
|
* <p>The type of impairment of a specific health event.</p>
|
|
556
694
|
*/
|
|
557
695
|
ImpactType: HealthEventImpactType | string | undefined;
|
|
558
696
|
/**
|
|
559
|
-
*
|
|
697
|
+
* @public
|
|
698
|
+
* <p>The threshold percentage for a health score that determines, along with other configuration information,
|
|
699
|
+
* when Internet Monitor creates a health event when there's an internet issue that affects your application end users.</p>
|
|
560
700
|
*/
|
|
561
701
|
HealthScoreThreshold?: number;
|
|
562
702
|
}
|
|
@@ -565,6 +705,7 @@ export interface GetHealthEventOutput {
|
|
|
565
705
|
*/
|
|
566
706
|
export interface GetMonitorInput {
|
|
567
707
|
/**
|
|
708
|
+
* @public
|
|
568
709
|
* <p>The name of the monitor.</p>
|
|
569
710
|
*/
|
|
570
711
|
MonitorName: string | undefined;
|
|
@@ -590,59 +731,78 @@ export type MonitorProcessingStatusCode = (typeof MonitorProcessingStatusCode)[k
|
|
|
590
731
|
*/
|
|
591
732
|
export interface GetMonitorOutput {
|
|
592
733
|
/**
|
|
734
|
+
* @public
|
|
593
735
|
* <p>The name of the monitor.</p>
|
|
594
736
|
*/
|
|
595
737
|
MonitorName: string | undefined;
|
|
596
738
|
/**
|
|
739
|
+
* @public
|
|
597
740
|
* <p>The Amazon Resource Name (ARN) of the monitor.</p>
|
|
598
741
|
*/
|
|
599
742
|
MonitorArn: string | undefined;
|
|
600
743
|
/**
|
|
601
|
-
*
|
|
744
|
+
* @public
|
|
745
|
+
* <p>The resources monitored by the monitor. Resources are listed by their Amazon Resource Names (ARNs).</p>
|
|
602
746
|
*/
|
|
603
747
|
Resources: string[] | undefined;
|
|
604
748
|
/**
|
|
749
|
+
* @public
|
|
605
750
|
* <p>The status of the monitor.</p>
|
|
606
751
|
*/
|
|
607
752
|
Status: MonitorConfigState | string | undefined;
|
|
608
753
|
/**
|
|
754
|
+
* @public
|
|
609
755
|
* <p>The time when the monitor was created.</p>
|
|
610
756
|
*/
|
|
611
757
|
CreatedAt: Date | undefined;
|
|
612
758
|
/**
|
|
759
|
+
* @public
|
|
613
760
|
* <p>The last time that the monitor was modified.</p>
|
|
614
761
|
*/
|
|
615
762
|
ModifiedAt: Date | undefined;
|
|
616
763
|
/**
|
|
764
|
+
* @public
|
|
617
765
|
* <p>The health of the data processing for the monitor.</p>
|
|
618
766
|
*/
|
|
619
767
|
ProcessingStatus?: MonitorProcessingStatusCode | string;
|
|
620
768
|
/**
|
|
769
|
+
* @public
|
|
621
770
|
* <p>Additional information about the health of the data processing for the monitor.</p>
|
|
622
771
|
*/
|
|
623
772
|
ProcessingStatusInfo?: string;
|
|
624
773
|
/**
|
|
774
|
+
* @public
|
|
625
775
|
* <p>The tags that have been added to monitor.</p>
|
|
626
776
|
*/
|
|
627
777
|
Tags?: Record<string, string>;
|
|
628
778
|
/**
|
|
629
|
-
*
|
|
630
|
-
*
|
|
779
|
+
* @public
|
|
780
|
+
* <p>The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your
|
|
781
|
+
* application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources
|
|
782
|
+
* through. This limit can help control billing costs.</p>
|
|
631
783
|
* <p>To learn more, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html">Choosing a city-network maximum value
|
|
632
784
|
* </a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
633
785
|
*/
|
|
634
786
|
MaxCityNetworksToMonitor?: number;
|
|
635
787
|
/**
|
|
788
|
+
* @public
|
|
636
789
|
* <p>Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.</p>
|
|
637
790
|
*/
|
|
638
791
|
InternetMeasurementsLogDelivery?: InternetMeasurementsLogDelivery;
|
|
639
792
|
/**
|
|
640
|
-
*
|
|
793
|
+
* @public
|
|
794
|
+
* <p>The percentage of the internet-facing traffic for your application to monitor with this monitor. If you set a city-networks
|
|
795
|
+
* maximum, that limit overrides the traffic percentage that you set.</p>
|
|
796
|
+
* <p>To learn more, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html">Choosing an application traffic percentage to monitor
|
|
797
|
+
* </a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
641
798
|
*/
|
|
642
799
|
TrafficPercentageToMonitor?: number;
|
|
643
800
|
/**
|
|
644
|
-
*
|
|
645
|
-
*
|
|
801
|
+
* @public
|
|
802
|
+
* <p>The list of health event threshold configurations. The threshold percentage for a health score determines, along with other configuration
|
|
803
|
+
* information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.</p>
|
|
804
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview">
|
|
805
|
+
* Change health event thresholds</a> in the Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
646
806
|
*/
|
|
647
807
|
HealthEventsConfig?: HealthEventsConfig;
|
|
648
808
|
}
|
|
@@ -652,46 +812,59 @@ export interface GetMonitorOutput {
|
|
|
652
812
|
*/
|
|
653
813
|
export interface HealthEvent {
|
|
654
814
|
/**
|
|
815
|
+
* @public
|
|
655
816
|
* <p>The Amazon Resource Name (ARN) of the event.</p>
|
|
656
817
|
*/
|
|
657
818
|
EventArn: string | undefined;
|
|
658
819
|
/**
|
|
820
|
+
* @public
|
|
659
821
|
* <p>The internally generated identifier of a specific network traffic impairment health event.</p>
|
|
660
822
|
*/
|
|
661
823
|
EventId: string | undefined;
|
|
662
824
|
/**
|
|
825
|
+
* @public
|
|
663
826
|
* <p>When a health event started.</p>
|
|
664
827
|
*/
|
|
665
828
|
StartedAt: Date | undefined;
|
|
666
829
|
/**
|
|
830
|
+
* @public
|
|
667
831
|
* <p>The time when a health event ended. If the health event is still active, then the end time is not set.</p>
|
|
668
832
|
*/
|
|
669
833
|
EndedAt?: Date;
|
|
670
834
|
/**
|
|
835
|
+
* @public
|
|
671
836
|
* <p>When the health event was created.</p>
|
|
672
837
|
*/
|
|
673
838
|
CreatedAt?: Date;
|
|
674
839
|
/**
|
|
840
|
+
* @public
|
|
675
841
|
* <p>When the health event was last updated.</p>
|
|
676
842
|
*/
|
|
677
843
|
LastUpdatedAt: Date | undefined;
|
|
678
844
|
/**
|
|
845
|
+
* @public
|
|
679
846
|
* <p>The locations impacted by the health event.</p>
|
|
680
847
|
*/
|
|
681
848
|
ImpactedLocations: ImpactedLocation[] | undefined;
|
|
682
849
|
/**
|
|
850
|
+
* @public
|
|
683
851
|
* <p>Health event list member.</p>
|
|
684
852
|
*/
|
|
685
853
|
Status: HealthEventStatus | string | undefined;
|
|
686
854
|
/**
|
|
687
|
-
*
|
|
855
|
+
* @public
|
|
856
|
+
* <p>The impact on total traffic that a health event has, in increased latency or reduced availability. This is the
|
|
857
|
+
* percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this
|
|
858
|
+
* client location to the Amazon Web Services location using this client network.</p>
|
|
688
859
|
*/
|
|
689
860
|
PercentOfTotalTrafficImpacted?: number;
|
|
690
861
|
/**
|
|
862
|
+
* @public
|
|
691
863
|
* <p>The type of impairment for a health event.</p>
|
|
692
864
|
*/
|
|
693
865
|
ImpactType: HealthEventImpactType | string | undefined;
|
|
694
866
|
/**
|
|
867
|
+
* @public
|
|
695
868
|
* <p>The value of the threshold percentage for performance or availability that was configured when Amazon CloudWatch Internet Monitor created the health event.</p>
|
|
696
869
|
*/
|
|
697
870
|
HealthScoreThreshold?: number;
|
|
@@ -701,26 +874,32 @@ export interface HealthEvent {
|
|
|
701
874
|
*/
|
|
702
875
|
export interface ListHealthEventsInput {
|
|
703
876
|
/**
|
|
877
|
+
* @public
|
|
704
878
|
* <p>The name of the monitor.</p>
|
|
705
879
|
*/
|
|
706
880
|
MonitorName: string | undefined;
|
|
707
881
|
/**
|
|
882
|
+
* @public
|
|
708
883
|
* <p>The time when a health event started.</p>
|
|
709
884
|
*/
|
|
710
885
|
StartTime?: Date;
|
|
711
886
|
/**
|
|
887
|
+
* @public
|
|
712
888
|
* <p>The time when a health event ended. If the health event is still ongoing, then the end time is not set.</p>
|
|
713
889
|
*/
|
|
714
890
|
EndTime?: Date;
|
|
715
891
|
/**
|
|
892
|
+
* @public
|
|
716
893
|
* <p>The token for the next set of results. You receive this token from a previous call.</p>
|
|
717
894
|
*/
|
|
718
895
|
NextToken?: string;
|
|
719
896
|
/**
|
|
897
|
+
* @public
|
|
720
898
|
* <p>The number of health event objects that you want to return with this call. </p>
|
|
721
899
|
*/
|
|
722
900
|
MaxResults?: number;
|
|
723
901
|
/**
|
|
902
|
+
* @public
|
|
724
903
|
* <p>The status of a health event.</p>
|
|
725
904
|
*/
|
|
726
905
|
EventStatus?: HealthEventStatus | string;
|
|
@@ -730,10 +909,12 @@ export interface ListHealthEventsInput {
|
|
|
730
909
|
*/
|
|
731
910
|
export interface ListHealthEventsOutput {
|
|
732
911
|
/**
|
|
912
|
+
* @public
|
|
733
913
|
* <p>A list of health events.</p>
|
|
734
914
|
*/
|
|
735
915
|
HealthEvents: HealthEvent[] | undefined;
|
|
736
916
|
/**
|
|
917
|
+
* @public
|
|
737
918
|
* <p>The token for the next set of results. You receive this token from a previous call.</p>
|
|
738
919
|
*/
|
|
739
920
|
NextToken?: string;
|
|
@@ -756,6 +937,7 @@ export declare class InternalServerErrorException extends __BaseException {
|
|
|
756
937
|
*/
|
|
757
938
|
export interface ListTagsForResourceInput {
|
|
758
939
|
/**
|
|
940
|
+
* @public
|
|
759
941
|
* <p>The Amazon Resource Name (ARN) for a resource.</p>
|
|
760
942
|
*/
|
|
761
943
|
ResourceArn: string | undefined;
|
|
@@ -765,6 +947,7 @@ export interface ListTagsForResourceInput {
|
|
|
765
947
|
*/
|
|
766
948
|
export interface ListTagsForResourceOutput {
|
|
767
949
|
/**
|
|
950
|
+
* @public
|
|
768
951
|
* <p>Tags for a resource.</p>
|
|
769
952
|
*/
|
|
770
953
|
Tags?: Record<string, string>;
|
|
@@ -801,14 +984,17 @@ export declare class TooManyRequestsException extends __BaseException {
|
|
|
801
984
|
*/
|
|
802
985
|
export interface ListMonitorsInput {
|
|
803
986
|
/**
|
|
987
|
+
* @public
|
|
804
988
|
* <p>The token for the next set of results. You receive this token from a previous call.</p>
|
|
805
989
|
*/
|
|
806
990
|
NextToken?: string;
|
|
807
991
|
/**
|
|
992
|
+
* @public
|
|
808
993
|
* <p>The number of monitor objects that you want to return with this call.</p>
|
|
809
994
|
*/
|
|
810
995
|
MaxResults?: number;
|
|
811
996
|
/**
|
|
997
|
+
* @public
|
|
812
998
|
* <p>The status of a monitor. This includes the status of the data processing for the monitor and the status of the monitor itself.</p>
|
|
813
999
|
* <p>For information about the statuses for a monitor, see <a href="https://docs.aws.amazon.com/internet-monitor/latest/api/API_Monitor.html">
|
|
814
1000
|
* Monitor</a>.</p>
|
|
@@ -821,18 +1007,22 @@ export interface ListMonitorsInput {
|
|
|
821
1007
|
*/
|
|
822
1008
|
export interface Monitor {
|
|
823
1009
|
/**
|
|
1010
|
+
* @public
|
|
824
1011
|
* <p>The name of the monitor.</p>
|
|
825
1012
|
*/
|
|
826
1013
|
MonitorName: string | undefined;
|
|
827
1014
|
/**
|
|
1015
|
+
* @public
|
|
828
1016
|
* <p>The Amazon Resource Name (ARN) of the monitor.</p>
|
|
829
1017
|
*/
|
|
830
1018
|
MonitorArn: string | undefined;
|
|
831
1019
|
/**
|
|
1020
|
+
* @public
|
|
832
1021
|
* <p>The status of a monitor.</p>
|
|
833
1022
|
*/
|
|
834
1023
|
Status: MonitorConfigState | string | undefined;
|
|
835
1024
|
/**
|
|
1025
|
+
* @public
|
|
836
1026
|
* <p>The health of data processing for the monitor.</p>
|
|
837
1027
|
*/
|
|
838
1028
|
ProcessingStatus?: MonitorProcessingStatusCode | string;
|
|
@@ -842,10 +1032,12 @@ export interface Monitor {
|
|
|
842
1032
|
*/
|
|
843
1033
|
export interface ListMonitorsOutput {
|
|
844
1034
|
/**
|
|
1035
|
+
* @public
|
|
845
1036
|
* <p>A list of monitors.</p>
|
|
846
1037
|
*/
|
|
847
1038
|
Monitors: Monitor[] | undefined;
|
|
848
1039
|
/**
|
|
1040
|
+
* @public
|
|
849
1041
|
* <p>The token for the next set of results. You receive this token from a previous call.</p>
|
|
850
1042
|
*/
|
|
851
1043
|
NextToken?: string;
|
|
@@ -867,50 +1059,65 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
867
1059
|
*/
|
|
868
1060
|
export interface UpdateMonitorInput {
|
|
869
1061
|
/**
|
|
1062
|
+
* @public
|
|
870
1063
|
* <p>The name of the monitor. </p>
|
|
871
1064
|
*/
|
|
872
1065
|
MonitorName: string | undefined;
|
|
873
1066
|
/**
|
|
874
|
-
*
|
|
875
|
-
*
|
|
876
|
-
*
|
|
1067
|
+
* @public
|
|
1068
|
+
* <p>The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs,
|
|
1069
|
+
* Amazon CloudFront distributions, or Amazon WorkSpaces directories.</p>
|
|
1070
|
+
* <p>You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add
|
|
1071
|
+
* NLBs or WorkSpaces directories together with any other resources.</p>
|
|
877
1072
|
* <note>
|
|
878
|
-
* <p>If you add only
|
|
1073
|
+
* <p>If you add only Amazon Virtual Private Clouds resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet
|
|
879
1074
|
* connectivity.</p>
|
|
880
1075
|
* </note>
|
|
881
1076
|
*/
|
|
882
1077
|
ResourcesToAdd?: string[];
|
|
883
1078
|
/**
|
|
1079
|
+
* @public
|
|
884
1080
|
* <p>The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).</p>
|
|
885
1081
|
*/
|
|
886
1082
|
ResourcesToRemove?: string[];
|
|
887
1083
|
/**
|
|
1084
|
+
* @public
|
|
888
1085
|
* <p>The status for a monitor. The accepted values for <code>Status</code> with the <code>UpdateMonitor</code> API call are the following: <code>ACTIVE</code> and
|
|
889
1086
|
* <code>INACTIVE</code>. The following values are <i>not</i> accepted: <code>PENDING</code>, and <code>ERROR</code>.</p>
|
|
890
1087
|
*/
|
|
891
1088
|
Status?: MonitorConfigState | string;
|
|
892
1089
|
/**
|
|
1090
|
+
* @public
|
|
893
1091
|
* <p>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. You should not reuse the same client
|
|
894
1092
|
* token for other API requests.</p>
|
|
895
1093
|
*/
|
|
896
1094
|
ClientToken?: string;
|
|
897
1095
|
/**
|
|
898
|
-
*
|
|
899
|
-
*
|
|
900
|
-
* such as an internet service provider, that clients access the resources
|
|
1096
|
+
* @public
|
|
1097
|
+
* <p>The maximum number of city-networks to monitor for your application. A city-network is the location (city) where clients access your
|
|
1098
|
+
* application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources
|
|
1099
|
+
* through. Setting this limit can help control billing costs.</p>
|
|
901
1100
|
*/
|
|
902
1101
|
MaxCityNetworksToMonitor?: number;
|
|
903
1102
|
/**
|
|
1103
|
+
* @public
|
|
904
1104
|
* <p>Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.</p>
|
|
905
1105
|
*/
|
|
906
1106
|
InternetMeasurementsLogDelivery?: InternetMeasurementsLogDelivery;
|
|
907
1107
|
/**
|
|
908
|
-
*
|
|
1108
|
+
* @public
|
|
1109
|
+
* <p>The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks
|
|
1110
|
+
* maximum, that limit overrides the traffic percentage that you set.</p>
|
|
1111
|
+
* <p>To learn more, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html">Choosing an application traffic percentage to monitor
|
|
1112
|
+
* </a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
909
1113
|
*/
|
|
910
1114
|
TrafficPercentageToMonitor?: number;
|
|
911
1115
|
/**
|
|
912
|
-
*
|
|
913
|
-
*
|
|
1116
|
+
* @public
|
|
1117
|
+
* <p>The list of health score thresholds. A threshold percentage for health scores, along with other configuration information,
|
|
1118
|
+
* determines when Internet Monitor creates a health event when there's an internet issue that affects your application end users.</p>
|
|
1119
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview">
|
|
1120
|
+
* Change health event thresholds</a> in the Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
914
1121
|
*/
|
|
915
1122
|
HealthEventsConfig?: HealthEventsConfig;
|
|
916
1123
|
}
|
|
@@ -919,10 +1126,12 @@ export interface UpdateMonitorInput {
|
|
|
919
1126
|
*/
|
|
920
1127
|
export interface UpdateMonitorOutput {
|
|
921
1128
|
/**
|
|
1129
|
+
* @public
|
|
922
1130
|
* <p>The Amazon Resource Name (ARN) of the monitor.</p>
|
|
923
1131
|
*/
|
|
924
1132
|
MonitorArn: string | undefined;
|
|
925
1133
|
/**
|
|
1134
|
+
* @public
|
|
926
1135
|
* <p>The status of a monitor.</p>
|
|
927
1136
|
*/
|
|
928
1137
|
Status: MonitorConfigState | string | undefined;
|
|
@@ -932,10 +1141,12 @@ export interface UpdateMonitorOutput {
|
|
|
932
1141
|
*/
|
|
933
1142
|
export interface TagResourceInput {
|
|
934
1143
|
/**
|
|
1144
|
+
* @public
|
|
935
1145
|
* <p>The Amazon Resource Name (ARN) for a tag that you add to a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.</p>
|
|
936
1146
|
*/
|
|
937
1147
|
ResourceArn: string | undefined;
|
|
938
1148
|
/**
|
|
1149
|
+
* @public
|
|
939
1150
|
* <p>Tags that you add to a resource. You can add a maximum of 50 tags in Internet Monitor.</p>
|
|
940
1151
|
*/
|
|
941
1152
|
Tags: Record<string, string> | undefined;
|
|
@@ -950,10 +1161,12 @@ export interface TagResourceOutput {
|
|
|
950
1161
|
*/
|
|
951
1162
|
export interface UntagResourceInput {
|
|
952
1163
|
/**
|
|
1164
|
+
* @public
|
|
953
1165
|
* <p>The Amazon Resource Name (ARN) for a tag you remove a resource from.</p>
|
|
954
1166
|
*/
|
|
955
1167
|
ResourceArn: string | undefined;
|
|
956
1168
|
/**
|
|
1169
|
+
* @public
|
|
957
1170
|
* <p>Tag keys that you remove from a resource.</p>
|
|
958
1171
|
*/
|
|
959
1172
|
TagKeys: string[] | undefined;
|