@aws-sdk/client-internetmonitor 3.533.0 → 3.540.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/dist-cjs/endpoint/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/InternetMonitor.d.ts +2 -1
- package/dist-types/InternetMonitorClient.d.ts +1 -1
- package/dist-types/commands/CreateMonitorCommand.d.ts +2 -1
- package/dist-types/commands/DeleteMonitorCommand.d.ts +2 -1
- package/dist-types/commands/GetHealthEventCommand.d.ts +2 -1
- package/dist-types/commands/GetMonitorCommand.d.ts +2 -1
- package/dist-types/commands/GetQueryResultsCommand.d.ts +2 -1
- package/dist-types/commands/GetQueryStatusCommand.d.ts +2 -1
- package/dist-types/commands/ListHealthEventsCommand.d.ts +2 -1
- package/dist-types/commands/ListMonitorsCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/StartQueryCommand.d.ts +2 -1
- package/dist-types/commands/StopQueryCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateMonitorCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +175 -175
- package/dist-types/ts3.4/InternetMonitor.d.ts +1 -0
- package/dist-types/ts3.4/commands/CreateMonitorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteMonitorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetHealthEventCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetMonitorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetQueryResultsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetQueryStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListHealthEventsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListMonitorsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartQueryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopQueryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateMonitorCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +40 -40
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { InternetMonitorServiceException as __BaseException } from "./InternetMonitorServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>You don't have sufficient permission to perform this action.</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
@@ -13,7 +13,6 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
13
13
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
|
-
* @public
|
|
17
16
|
* <p>Amazon CloudWatch Internet Monitor calculates measurements about the availability for your application's internet traffic between client locations and Amazon Web Services.
|
|
18
17
|
* Amazon Web Services has substantial historical data about internet
|
|
19
18
|
* performance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor
|
|
@@ -23,38 +22,39 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
23
22
|
* for an end user and service location pair is equivalent to 1% of the traffic experiencing an availability drop for that pair.</p>
|
|
24
23
|
* <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
|
|
25
24
|
* scores</a> in the Amazon CloudWatch Internet Monitor section of the <i>Amazon CloudWatch User Guide</i>.</p>
|
|
25
|
+
* @public
|
|
26
26
|
*/
|
|
27
27
|
export interface AvailabilityMeasurement {
|
|
28
28
|
/**
|
|
29
|
-
* @public
|
|
30
29
|
* <p>Experience scores, or health scores are calculated for different geographic and network provider combinations (that is, different granularities) and
|
|
31
30
|
* 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
|
|
32
31
|
* provides global health scores.</p>
|
|
33
32
|
* <p>The Amazon CloudWatch Internet Monitor chapter in the <i>CloudWatch User Guide</i> includes detailed information about how Internet Monitor calculates health scores, including performance and
|
|
34
33
|
* availability scores, and when it creates and resolves health events. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores">How Amazon Web Services calculates performance and
|
|
35
34
|
* availability scores</a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
35
|
+
* @public
|
|
36
36
|
*/
|
|
37
37
|
ExperienceScore?: number;
|
|
38
38
|
/**
|
|
39
|
-
* @public
|
|
40
39
|
* <p>The impact on total traffic that a health event has, in increased latency or reduced availability. This is the
|
|
41
40
|
* percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this
|
|
42
41
|
* client location to the Amazon Web Services location using this client network.</p>
|
|
43
42
|
* <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
|
|
44
43
|
* Guide.</p>
|
|
44
|
+
* @public
|
|
45
45
|
*/
|
|
46
46
|
PercentOfTotalTrafficImpacted?: number;
|
|
47
47
|
/**
|
|
48
|
-
* @public
|
|
49
48
|
* <p>The percentage of impact caused by a health event for client location traffic globally.</p>
|
|
50
49
|
* <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
|
|
51
50
|
* Guide.</p>
|
|
51
|
+
* @public
|
|
52
52
|
*/
|
|
53
53
|
PercentOfClientLocationImpacted?: number;
|
|
54
54
|
}
|
|
55
55
|
/**
|
|
56
|
-
* @public
|
|
57
56
|
* <p>A bad request was received.</p>
|
|
57
|
+
* @public
|
|
58
58
|
*/
|
|
59
59
|
export declare class BadRequestException extends __BaseException {
|
|
60
60
|
readonly name: "BadRequestException";
|
|
@@ -65,8 +65,8 @@ export declare class BadRequestException extends __BaseException {
|
|
|
65
65
|
constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
|
|
66
66
|
}
|
|
67
67
|
/**
|
|
68
|
-
* @public
|
|
69
68
|
* <p>The requested resource is in use.</p>
|
|
69
|
+
* @public
|
|
70
70
|
*/
|
|
71
71
|
export declare class ConflictException extends __BaseException {
|
|
72
72
|
readonly name: "ConflictException";
|
|
@@ -89,7 +89,6 @@ export declare const LocalHealthEventsConfigStatus: {
|
|
|
89
89
|
*/
|
|
90
90
|
export type LocalHealthEventsConfigStatus = (typeof LocalHealthEventsConfigStatus)[keyof typeof LocalHealthEventsConfigStatus];
|
|
91
91
|
/**
|
|
92
|
-
* @public
|
|
93
92
|
* <p>A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event
|
|
94
93
|
* for a local performance or availability issue, when scores cross a threshold for one or more city-networks.</p>
|
|
95
94
|
* <p>Defines the percentages, for performance scores or availability scores, that are the local thresholds
|
|
@@ -98,29 +97,29 @@ export type LocalHealthEventsConfigStatus = (typeof LocalHealthEventsConfigStatu
|
|
|
98
97
|
* <p>If you don't set a local health event threshold, the default value is 60%.</p>
|
|
99
98
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview">
|
|
100
99
|
* Change health event thresholds</a> in the Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
100
|
+
* @public
|
|
101
101
|
*/
|
|
102
102
|
export interface LocalHealthEventsConfig {
|
|
103
103
|
/**
|
|
104
|
-
* @public
|
|
105
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>
|
|
106
105
|
* or <code>DISABLED</code>.</p>
|
|
106
|
+
* @public
|
|
107
107
|
*/
|
|
108
108
|
Status?: LocalHealthEventsConfigStatus;
|
|
109
109
|
/**
|
|
110
|
-
* @public
|
|
111
110
|
* <p>The health event threshold percentage set for a local health score.</p>
|
|
111
|
+
* @public
|
|
112
112
|
*/
|
|
113
113
|
HealthScoreThreshold?: number;
|
|
114
114
|
/**
|
|
115
|
-
* @public
|
|
116
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
|
|
117
116
|
* threshold is crossed for a local health score.</p>
|
|
118
117
|
* <p>If you don't set a minimum traffic impact threshold, the default value is 0.1%.</p>
|
|
118
|
+
* @public
|
|
119
119
|
*/
|
|
120
120
|
MinTrafficImpact?: number;
|
|
121
121
|
}
|
|
122
122
|
/**
|
|
123
|
-
* @public
|
|
124
123
|
* <p>A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event
|
|
125
124
|
* for an overall performance or availability issue, across an application's geographies.</p>
|
|
126
125
|
* <p>Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds
|
|
@@ -133,26 +132,27 @@ export interface LocalHealthEventsConfig {
|
|
|
133
132
|
* In addition, you can disable local thresholds, for performance scores, availability scores, or both.</p>
|
|
134
133
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview">
|
|
135
134
|
* Change health event thresholds</a> in the Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
135
|
+
* @public
|
|
136
136
|
*/
|
|
137
137
|
export interface HealthEventsConfig {
|
|
138
138
|
/**
|
|
139
|
-
* @public
|
|
140
139
|
* <p>The health event threshold percentage set for availability scores.</p>
|
|
140
|
+
* @public
|
|
141
141
|
*/
|
|
142
142
|
AvailabilityScoreThreshold?: number;
|
|
143
143
|
/**
|
|
144
|
-
* @public
|
|
145
144
|
* <p>The health event threshold percentage set for performance scores.</p>
|
|
145
|
+
* @public
|
|
146
146
|
*/
|
|
147
147
|
PerformanceScoreThreshold?: number;
|
|
148
148
|
/**
|
|
149
|
-
* @public
|
|
150
149
|
* <p>The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.</p>
|
|
150
|
+
* @public
|
|
151
151
|
*/
|
|
152
152
|
AvailabilityLocalHealthEventsConfig?: LocalHealthEventsConfig;
|
|
153
153
|
/**
|
|
154
|
-
* @public
|
|
155
154
|
* <p>The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.</p>
|
|
155
|
+
* @public
|
|
156
156
|
*/
|
|
157
157
|
PerformanceLocalHealthEventsConfig?: LocalHealthEventsConfig;
|
|
158
158
|
}
|
|
@@ -169,38 +169,38 @@ export declare const LogDeliveryStatus: {
|
|
|
169
169
|
*/
|
|
170
170
|
export type LogDeliveryStatus = (typeof LogDeliveryStatus)[keyof typeof LogDeliveryStatus];
|
|
171
171
|
/**
|
|
172
|
-
* @public
|
|
173
172
|
* <p>The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) prefix
|
|
174
173
|
* 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
|
|
175
174
|
* whether you choose to deliver internet measurements to S3 logs.</p>
|
|
175
|
+
* @public
|
|
176
176
|
*/
|
|
177
177
|
export interface S3Config {
|
|
178
178
|
/**
|
|
179
|
-
* @public
|
|
180
179
|
* <p>The Amazon S3 bucket name.</p>
|
|
180
|
+
* @public
|
|
181
181
|
*/
|
|
182
182
|
BucketName?: string;
|
|
183
183
|
/**
|
|
184
|
-
* @public
|
|
185
184
|
* <p>The Amazon S3 bucket prefix.</p>
|
|
185
|
+
* @public
|
|
186
186
|
*/
|
|
187
187
|
BucketPrefix?: string;
|
|
188
188
|
/**
|
|
189
|
-
* @public
|
|
190
189
|
* <p>The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket.</p>
|
|
190
|
+
* @public
|
|
191
191
|
*/
|
|
192
192
|
LogDeliveryStatus?: LogDeliveryStatus;
|
|
193
193
|
}
|
|
194
194
|
/**
|
|
195
|
-
* @public
|
|
196
195
|
* <p>Publish internet measurements to an Amazon S3 bucket in addition to CloudWatch Logs.</p>
|
|
196
|
+
* @public
|
|
197
197
|
*/
|
|
198
198
|
export interface InternetMeasurementsLogDelivery {
|
|
199
199
|
/**
|
|
200
|
-
* @public
|
|
201
200
|
* <p>The configuration information for publishing Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) prefix
|
|
202
201
|
* 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
|
|
203
202
|
* whether you choose to deliver internet measurements to S3 logs.</p>
|
|
203
|
+
* @public
|
|
204
204
|
*/
|
|
205
205
|
S3Config?: S3Config;
|
|
206
206
|
}
|
|
@@ -209,12 +209,11 @@ export interface InternetMeasurementsLogDelivery {
|
|
|
209
209
|
*/
|
|
210
210
|
export interface CreateMonitorInput {
|
|
211
211
|
/**
|
|
212
|
-
* @public
|
|
213
212
|
* <p>The name of the monitor. </p>
|
|
213
|
+
* @public
|
|
214
214
|
*/
|
|
215
215
|
MonitorName: string | undefined;
|
|
216
216
|
/**
|
|
217
|
-
* @public
|
|
218
217
|
* <p>The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs,
|
|
219
218
|
* Amazon CloudFront distributions, or Amazon WorkSpaces directories.</p>
|
|
220
219
|
* <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
|
|
@@ -223,49 +222,50 @@ export interface CreateMonitorInput {
|
|
|
223
222
|
* <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
|
|
224
223
|
* internet connectivity.</p>
|
|
225
224
|
* </note>
|
|
225
|
+
* @public
|
|
226
226
|
*/
|
|
227
227
|
Resources?: string[];
|
|
228
228
|
/**
|
|
229
|
-
* @public
|
|
230
229
|
* <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
|
|
231
230
|
* other API requests.</p>
|
|
231
|
+
* @public
|
|
232
232
|
*/
|
|
233
233
|
ClientToken?: string;
|
|
234
234
|
/**
|
|
235
|
-
* @public
|
|
236
235
|
* <p>The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.</p>
|
|
236
|
+
* @public
|
|
237
237
|
*/
|
|
238
238
|
Tags?: Record<string, string>;
|
|
239
239
|
/**
|
|
240
|
-
* @public
|
|
241
240
|
* <p>The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your
|
|
242
241
|
* application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources
|
|
243
242
|
* through. Setting this limit can help control billing costs.</p>
|
|
244
243
|
* <p>To learn more, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html">Choosing a city-network maximum value
|
|
245
244
|
* </a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
245
|
+
* @public
|
|
246
246
|
*/
|
|
247
247
|
MaxCityNetworksToMonitor?: number;
|
|
248
248
|
/**
|
|
249
|
-
* @public
|
|
250
249
|
* <p>Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs.</p>
|
|
250
|
+
* @public
|
|
251
251
|
*/
|
|
252
252
|
InternetMeasurementsLogDelivery?: InternetMeasurementsLogDelivery;
|
|
253
253
|
/**
|
|
254
|
-
* @public
|
|
255
254
|
* <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
|
|
256
255
|
* maximum, that limit overrides the traffic percentage that you set.</p>
|
|
257
256
|
* <p>To learn more, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html">Choosing an application traffic percentage to monitor
|
|
258
257
|
* </a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
258
|
+
* @public
|
|
259
259
|
*/
|
|
260
260
|
TrafficPercentageToMonitor?: number;
|
|
261
261
|
/**
|
|
262
|
-
* @public
|
|
263
262
|
* <p>Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event. Internet Monitor creates a
|
|
264
263
|
* health event when an internet issue that affects your application end users has a health score percentage that is at or below a
|
|
265
264
|
* specific threshold, and, sometimes, when other criteria are met.</p>
|
|
266
265
|
* <p>If you don't set a health event threshold, the default value is 95%.</p>
|
|
267
266
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview">
|
|
268
267
|
* Change health event thresholds</a> in the Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
268
|
+
* @public
|
|
269
269
|
*/
|
|
270
270
|
HealthEventsConfig?: HealthEventsConfig;
|
|
271
271
|
}
|
|
@@ -288,19 +288,19 @@ export type MonitorConfigState = (typeof MonitorConfigState)[keyof typeof Monito
|
|
|
288
288
|
*/
|
|
289
289
|
export interface CreateMonitorOutput {
|
|
290
290
|
/**
|
|
291
|
-
* @public
|
|
292
291
|
* <p>The Amazon Resource Name (ARN) of the monitor.</p>
|
|
292
|
+
* @public
|
|
293
293
|
*/
|
|
294
294
|
Arn: string | undefined;
|
|
295
295
|
/**
|
|
296
|
-
* @public
|
|
297
296
|
* <p>The status of a monitor.</p>
|
|
297
|
+
* @public
|
|
298
298
|
*/
|
|
299
299
|
Status: MonitorConfigState | undefined;
|
|
300
300
|
}
|
|
301
301
|
/**
|
|
302
|
-
* @public
|
|
303
302
|
* <p>An internal error occurred.</p>
|
|
303
|
+
* @public
|
|
304
304
|
*/
|
|
305
305
|
export declare class InternalServerException extends __BaseException {
|
|
306
306
|
readonly name: "InternalServerException";
|
|
@@ -312,8 +312,8 @@ export declare class InternalServerException extends __BaseException {
|
|
|
312
312
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
313
313
|
}
|
|
314
314
|
/**
|
|
315
|
-
* @public
|
|
316
315
|
* <p>The request exceeded a service quota.</p>
|
|
316
|
+
* @public
|
|
317
317
|
*/
|
|
318
318
|
export declare class LimitExceededException extends __BaseException {
|
|
319
319
|
readonly name: "LimitExceededException";
|
|
@@ -324,8 +324,8 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
324
324
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
325
325
|
}
|
|
326
326
|
/**
|
|
327
|
-
* @public
|
|
328
327
|
* <p>The request was denied due to request throttling.</p>
|
|
328
|
+
* @public
|
|
329
329
|
*/
|
|
330
330
|
export declare class ThrottlingException extends __BaseException {
|
|
331
331
|
readonly name: "ThrottlingException";
|
|
@@ -339,8 +339,8 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
339
339
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
340
340
|
}
|
|
341
341
|
/**
|
|
342
|
-
* @public
|
|
343
342
|
* <p>Invalid request.</p>
|
|
343
|
+
* @public
|
|
344
344
|
*/
|
|
345
345
|
export declare class ValidationException extends __BaseException {
|
|
346
346
|
readonly name: "ValidationException";
|
|
@@ -355,8 +355,8 @@ export declare class ValidationException extends __BaseException {
|
|
|
355
355
|
*/
|
|
356
356
|
export interface DeleteMonitorInput {
|
|
357
357
|
/**
|
|
358
|
-
* @public
|
|
359
358
|
* <p>The name of the monitor to delete.</p>
|
|
359
|
+
* @public
|
|
360
360
|
*/
|
|
361
361
|
MonitorName: string | undefined;
|
|
362
362
|
}
|
|
@@ -378,7 +378,6 @@ export declare const Operator: {
|
|
|
378
378
|
*/
|
|
379
379
|
export type Operator = (typeof Operator)[keyof typeof Operator];
|
|
380
380
|
/**
|
|
381
|
-
* @public
|
|
382
381
|
* <p>A filter that you use with the results of a Amazon CloudWatch Internet Monitor query that you created and ran. The query sets up a
|
|
383
382
|
* repository of data that is a subset of your application's Internet Monitor data. <code>FilterParameter</code> is a string
|
|
384
383
|
* that defines how you want to filter the repository of data to return a set of results, based on your criteria.</p>
|
|
@@ -390,25 +389,26 @@ export type Operator = (typeof Operator)[keyof typeof Operator];
|
|
|
390
389
|
* <p>For more information about specifying filter parameters, see
|
|
391
390
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html">Using the Amazon CloudWatch Internet Monitor query interface</a>
|
|
392
391
|
* in the Amazon CloudWatch Internet Monitor User Guide.</p>
|
|
392
|
+
* @public
|
|
393
393
|
*/
|
|
394
394
|
export interface FilterParameter {
|
|
395
395
|
/**
|
|
396
|
-
* @public
|
|
397
396
|
* <p>A data field that you want to filter, to further scope your application's Internet Monitor data in a repository that you
|
|
398
397
|
* created by running a query. A field might be <code>city</code>, for example. The field must be one of the fields
|
|
399
398
|
* that was returned by the specific query that you used to create the repository.</p>
|
|
399
|
+
* @public
|
|
400
400
|
*/
|
|
401
401
|
Field?: string;
|
|
402
402
|
/**
|
|
403
|
-
* @public
|
|
404
403
|
* <p>The operator to use with the filter field and a value, such as <code>not_equals</code>.</p>
|
|
404
|
+
* @public
|
|
405
405
|
*/
|
|
406
406
|
Operator?: Operator;
|
|
407
407
|
/**
|
|
408
|
-
* @public
|
|
409
408
|
* <p>One or more values to be used, together with the specified operator, to filter data for a query.
|
|
410
409
|
* For example, you could specify an array of values such as <code>["Seattle", "Redmond"]</code>. Values in the array are separated by
|
|
411
410
|
* commas.</p>
|
|
411
|
+
* @public
|
|
412
412
|
*/
|
|
413
413
|
Values?: string[];
|
|
414
414
|
}
|
|
@@ -417,30 +417,30 @@ export interface FilterParameter {
|
|
|
417
417
|
*/
|
|
418
418
|
export interface GetHealthEventInput {
|
|
419
419
|
/**
|
|
420
|
-
* @public
|
|
421
420
|
* <p>The name of the monitor.</p>
|
|
421
|
+
* @public
|
|
422
422
|
*/
|
|
423
423
|
MonitorName: string | undefined;
|
|
424
424
|
/**
|
|
425
|
-
* @public
|
|
426
425
|
* <p>The internally-generated identifier of a health event. Because <code>EventID</code> contains the forward slash (“/”) character, you must
|
|
427
426
|
* URL-encode the <code>EventID</code> field in the request URL.</p>
|
|
427
|
+
* @public
|
|
428
428
|
*/
|
|
429
429
|
EventId: string | undefined;
|
|
430
430
|
}
|
|
431
431
|
/**
|
|
432
|
-
* @public
|
|
433
432
|
* <p>An internet service provider (ISP) or network in Amazon CloudWatch Internet Monitor.</p>
|
|
433
|
+
* @public
|
|
434
434
|
*/
|
|
435
435
|
export interface Network {
|
|
436
436
|
/**
|
|
437
|
-
* @public
|
|
438
437
|
* <p>The internet provider name or network name.</p>
|
|
438
|
+
* @public
|
|
439
439
|
*/
|
|
440
440
|
ASName: string | undefined;
|
|
441
441
|
/**
|
|
442
|
-
* @public
|
|
443
442
|
* <p>The Autonomous System Number (ASN) of the internet provider or network.</p>
|
|
443
|
+
* @public
|
|
444
444
|
*/
|
|
445
445
|
ASNumber: number | undefined;
|
|
446
446
|
}
|
|
@@ -457,50 +457,49 @@ export declare const TriangulationEventType: {
|
|
|
457
457
|
*/
|
|
458
458
|
export type TriangulationEventType = (typeof TriangulationEventType)[keyof typeof TriangulationEventType];
|
|
459
459
|
/**
|
|
460
|
-
* @public
|
|
461
460
|
* <p>Information about the network impairment for a specific network measured by Amazon CloudWatch Internet Monitor.</p>
|
|
461
|
+
* @public
|
|
462
462
|
*/
|
|
463
463
|
export interface NetworkImpairment {
|
|
464
464
|
/**
|
|
465
|
-
* @public
|
|
466
465
|
* <p>The networks that could be impacted by a network impairment event.</p>
|
|
466
|
+
* @public
|
|
467
467
|
*/
|
|
468
468
|
Networks: Network[] | undefined;
|
|
469
469
|
/**
|
|
470
|
-
* @public
|
|
471
470
|
* <p>The combination of the Autonomous System Number (ASN) of the network and the name of the network.</p>
|
|
471
|
+
* @public
|
|
472
472
|
*/
|
|
473
473
|
AsPath: Network[] | undefined;
|
|
474
474
|
/**
|
|
475
|
-
* @public
|
|
476
475
|
* <p>Type of network impairment.</p>
|
|
476
|
+
* @public
|
|
477
477
|
*/
|
|
478
478
|
NetworkEventType: TriangulationEventType | undefined;
|
|
479
479
|
}
|
|
480
480
|
/**
|
|
481
|
-
* @public
|
|
482
481
|
* <p>Round-trip time (RTT) is how long it takes for a request from the user to return a response to the user. Amazon CloudWatch Internet Monitor calculates RTT at different
|
|
483
482
|
* percentiles: p50, p90, and p95.</p>
|
|
483
|
+
* @public
|
|
484
484
|
*/
|
|
485
485
|
export interface RoundTripTime {
|
|
486
486
|
/**
|
|
487
|
-
* @public
|
|
488
487
|
* <p>RTT at the 50th percentile (p50).</p>
|
|
488
|
+
* @public
|
|
489
489
|
*/
|
|
490
490
|
P50?: number;
|
|
491
491
|
/**
|
|
492
|
-
* @public
|
|
493
492
|
* <p>RTT at the 90th percentile (p90). </p>
|
|
493
|
+
* @public
|
|
494
494
|
*/
|
|
495
495
|
P90?: number;
|
|
496
496
|
/**
|
|
497
|
-
* @public
|
|
498
497
|
* <p>RTT at the 95th percentile (p95). </p>
|
|
498
|
+
* @public
|
|
499
499
|
*/
|
|
500
500
|
P95?: number;
|
|
501
501
|
}
|
|
502
502
|
/**
|
|
503
|
-
* @public
|
|
504
503
|
* <p>Amazon CloudWatch Internet Monitor calculates measurements about the performance for your application's internet traffic between client locations and Amazon Web Services.
|
|
505
504
|
* Amazon Web Services has substantial historical data about internet
|
|
506
505
|
* performance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor
|
|
@@ -510,66 +509,67 @@ export interface RoundTripTime {
|
|
|
510
509
|
* an end user and service location pair is equivalent to 1% of the traffic experiencing a performance drop for that pair.</p>
|
|
511
510
|
* <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
|
|
512
511
|
* scores</a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
512
|
+
* @public
|
|
513
513
|
*/
|
|
514
514
|
export interface PerformanceMeasurement {
|
|
515
515
|
/**
|
|
516
|
-
* @public
|
|
517
516
|
* <p>Experience scores, or health scores, are calculated for different geographic and network provider combinations (that is, different granularities) and
|
|
518
517
|
* 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
|
|
519
518
|
* provides global health scores.</p>
|
|
520
519
|
* <p>The Amazon CloudWatch Internet Monitor chapter in the CloudWatch User Guide includes detailed information about how Internet Monitor calculates health scores, including performance and
|
|
521
520
|
* availability scores, and when it creates and resolves health events. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores">How Amazon Web Services calculates performance and
|
|
522
521
|
* availability scores</a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
522
|
+
* @public
|
|
523
523
|
*/
|
|
524
524
|
ExperienceScore?: number;
|
|
525
525
|
/**
|
|
526
|
-
* @public
|
|
527
526
|
* <p>The impact on total traffic that a health event has, in increased latency or reduced availability. This is the
|
|
528
527
|
* percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this
|
|
529
528
|
* client location to the Amazon Web Services location using this client network.</p>
|
|
530
529
|
* <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
|
|
531
530
|
* events</a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
531
|
+
* @public
|
|
532
532
|
*/
|
|
533
533
|
PercentOfTotalTrafficImpacted?: number;
|
|
534
534
|
/**
|
|
535
|
-
* @public
|
|
536
535
|
* <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
|
|
537
536
|
* 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>
|
|
538
537
|
* <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
|
|
539
538
|
* events</a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
539
|
+
* @public
|
|
540
540
|
*/
|
|
541
541
|
PercentOfClientLocationImpacted?: number;
|
|
542
542
|
/**
|
|
543
|
-
* @public
|
|
544
543
|
* <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>
|
|
545
544
|
* <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
|
|
546
545
|
* events</a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
546
|
+
* @public
|
|
547
547
|
*/
|
|
548
548
|
RoundTripTime?: RoundTripTime;
|
|
549
549
|
}
|
|
550
550
|
/**
|
|
551
|
-
* @public
|
|
552
551
|
* <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
|
|
553
552
|
* substantial historical data about internet performance and availability between Amazon Web Services services and different network providers and geographies. By
|
|
554
553
|
* applying statistical analysis to the data, Internet Monitor can detect when the performance and availability for your application has dropped, compared to an
|
|
555
554
|
* 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
|
|
556
555
|
* performance score and an availability score.</p>
|
|
556
|
+
* @public
|
|
557
557
|
*/
|
|
558
558
|
export interface InternetHealth {
|
|
559
559
|
/**
|
|
560
|
-
* @public
|
|
561
560
|
* <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%
|
|
562
561
|
* for an end user and service location pair is equivalent to 1% of the traffic experiencing an availability drop for that pair.</p>
|
|
563
562
|
* <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
|
|
564
563
|
* scores</a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
564
|
+
* @public
|
|
565
565
|
*/
|
|
566
566
|
Availability?: AvailabilityMeasurement;
|
|
567
567
|
/**
|
|
568
|
-
* @public
|
|
569
568
|
* <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
|
|
570
569
|
* an end user and service location pair is equivalent to 1% of the traffic experiencing a performance drop for that pair.</p>
|
|
571
570
|
* <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
|
|
572
571
|
* scores</a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
572
|
+
* @public
|
|
573
573
|
*/
|
|
574
574
|
Performance?: PerformanceMeasurement;
|
|
575
575
|
}
|
|
@@ -586,94 +586,94 @@ export declare const HealthEventStatus: {
|
|
|
586
586
|
*/
|
|
587
587
|
export type HealthEventStatus = (typeof HealthEventStatus)[keyof typeof HealthEventStatus];
|
|
588
588
|
/**
|
|
589
|
-
* @public
|
|
590
589
|
* <p>Information about a location impacted by a health event in Amazon CloudWatch Internet Monitor.</p>
|
|
591
590
|
* <p>Geographic regions are hierarchically categorized into country, subdivision,
|
|
592
591
|
* metro and city geographic granularities. The geographic region is identified based
|
|
593
592
|
* on the IP address used at the client locations.</p>
|
|
593
|
+
* @public
|
|
594
594
|
*/
|
|
595
595
|
export interface ImpactedLocation {
|
|
596
596
|
/**
|
|
597
|
-
* @public
|
|
598
597
|
* <p>The name of the network at an impacted location.</p>
|
|
598
|
+
* @public
|
|
599
599
|
*/
|
|
600
600
|
ASName: string | undefined;
|
|
601
601
|
/**
|
|
602
|
-
* @public
|
|
603
602
|
* <p>The Autonomous System Number (ASN) of the network at an impacted location.</p>
|
|
603
|
+
* @public
|
|
604
604
|
*/
|
|
605
605
|
ASNumber: number | undefined;
|
|
606
606
|
/**
|
|
607
|
-
* @public
|
|
608
607
|
* <p>The name of the country where the health event is located.</p>
|
|
608
|
+
* @public
|
|
609
609
|
*/
|
|
610
610
|
Country: string | undefined;
|
|
611
611
|
/**
|
|
612
|
-
* @public
|
|
613
612
|
* <p>The subdivision location where the health event is located. The subdivision usually maps to
|
|
614
613
|
* states in most countries (including the United States). For United Kingdom, it maps to a country (England,
|
|
615
614
|
* Scotland, Wales) or province (Northern Ireland).</p>
|
|
615
|
+
* @public
|
|
616
616
|
*/
|
|
617
617
|
Subdivision?: string;
|
|
618
618
|
/**
|
|
619
|
-
* @public
|
|
620
619
|
* <p>The metro area where the health event is located.</p>
|
|
621
620
|
* <p>Metro indicates a metropolitan region in the United States, such as the region around New York City.
|
|
622
621
|
* In non-US countries, this is a second-level subdivision. For example, in the United Kingdom, it could be
|
|
623
622
|
* a county, a London borough, a unitary authority, council area, and so on.</p>
|
|
623
|
+
* @public
|
|
624
624
|
*/
|
|
625
625
|
Metro?: string;
|
|
626
626
|
/**
|
|
627
|
-
* @public
|
|
628
627
|
* <p>The name of the city where the health event is located.</p>
|
|
628
|
+
* @public
|
|
629
629
|
*/
|
|
630
630
|
City?: string;
|
|
631
631
|
/**
|
|
632
|
-
* @public
|
|
633
632
|
* <p>The latitude where the health event is located.</p>
|
|
633
|
+
* @public
|
|
634
634
|
*/
|
|
635
635
|
Latitude?: number;
|
|
636
636
|
/**
|
|
637
|
-
* @public
|
|
638
637
|
* <p>The longitude where the health event is located.</p>
|
|
638
|
+
* @public
|
|
639
639
|
*/
|
|
640
640
|
Longitude?: number;
|
|
641
641
|
/**
|
|
642
|
-
* @public
|
|
643
642
|
* <p>The country code where the health event is located. The ISO 3166-2 codes for the
|
|
644
643
|
* country is provided, when available. </p>
|
|
644
|
+
* @public
|
|
645
645
|
*/
|
|
646
646
|
CountryCode?: string;
|
|
647
647
|
/**
|
|
648
|
-
* @public
|
|
649
648
|
* <p>The subdivision code where the health event is located. The ISO 3166-2 codes for
|
|
650
649
|
* country subdivisions is provided, when available. </p>
|
|
650
|
+
* @public
|
|
651
651
|
*/
|
|
652
652
|
SubdivisionCode?: string;
|
|
653
653
|
/**
|
|
654
|
-
* @public
|
|
655
654
|
* <p>The service location where the health event is located.</p>
|
|
655
|
+
* @public
|
|
656
656
|
*/
|
|
657
657
|
ServiceLocation?: string;
|
|
658
658
|
/**
|
|
659
|
-
* @public
|
|
660
659
|
* <p>The status of the health event at an impacted location.</p>
|
|
660
|
+
* @public
|
|
661
661
|
*/
|
|
662
662
|
Status: HealthEventStatus | undefined;
|
|
663
663
|
/**
|
|
664
|
-
* @public
|
|
665
664
|
* <p>The cause of the impairment. There are two types of network impairments: Amazon Web Services network issues
|
|
666
665
|
* or internet issues. Internet issues are typically a problem with a network provider, like an internet service provider (ISP).</p>
|
|
666
|
+
* @public
|
|
667
667
|
*/
|
|
668
668
|
CausedBy?: NetworkImpairment;
|
|
669
669
|
/**
|
|
670
|
-
* @public
|
|
671
670
|
* <p>The calculated health at a specific location.</p>
|
|
671
|
+
* @public
|
|
672
672
|
*/
|
|
673
673
|
InternetHealth?: InternetHealth;
|
|
674
674
|
/**
|
|
675
|
-
* @public
|
|
676
675
|
* <p>The IPv4 prefixes at the client location that was impacted by the health event.</p>
|
|
676
|
+
* @public
|
|
677
677
|
*/
|
|
678
678
|
Ipv4Prefixes?: string[];
|
|
679
679
|
}
|
|
@@ -696,61 +696,61 @@ export type HealthEventImpactType = (typeof HealthEventImpactType)[keyof typeof
|
|
|
696
696
|
*/
|
|
697
697
|
export interface GetHealthEventOutput {
|
|
698
698
|
/**
|
|
699
|
-
* @public
|
|
700
699
|
* <p>The Amazon Resource Name (ARN) of the event.</p>
|
|
700
|
+
* @public
|
|
701
701
|
*/
|
|
702
702
|
EventArn: string | undefined;
|
|
703
703
|
/**
|
|
704
|
-
* @public
|
|
705
704
|
* <p>The internally-generated identifier of a health event.</p>
|
|
705
|
+
* @public
|
|
706
706
|
*/
|
|
707
707
|
EventId: string | undefined;
|
|
708
708
|
/**
|
|
709
|
-
* @public
|
|
710
709
|
* <p>The time when a health event started.</p>
|
|
710
|
+
* @public
|
|
711
711
|
*/
|
|
712
712
|
StartedAt: Date | undefined;
|
|
713
713
|
/**
|
|
714
|
-
* @public
|
|
715
714
|
* <p>The time when a health event was resolved. If the health event is still active, the end time is not set.</p>
|
|
715
|
+
* @public
|
|
716
716
|
*/
|
|
717
717
|
EndedAt?: Date;
|
|
718
718
|
/**
|
|
719
|
-
* @public
|
|
720
719
|
* <p>The time when a health event was created.</p>
|
|
720
|
+
* @public
|
|
721
721
|
*/
|
|
722
722
|
CreatedAt?: Date;
|
|
723
723
|
/**
|
|
724
|
-
* @public
|
|
725
724
|
* <p>The time when a health event was last updated or recalculated.</p>
|
|
725
|
+
* @public
|
|
726
726
|
*/
|
|
727
727
|
LastUpdatedAt: Date | undefined;
|
|
728
728
|
/**
|
|
729
|
-
* @public
|
|
730
729
|
* <p>The locations affected by a health event.</p>
|
|
730
|
+
* @public
|
|
731
731
|
*/
|
|
732
732
|
ImpactedLocations: ImpactedLocation[] | undefined;
|
|
733
733
|
/**
|
|
734
|
-
* @public
|
|
735
734
|
* <p>The status of a health event.</p>
|
|
735
|
+
* @public
|
|
736
736
|
*/
|
|
737
737
|
Status: HealthEventStatus | undefined;
|
|
738
738
|
/**
|
|
739
|
-
* @public
|
|
740
739
|
* <p>The impact on total traffic that a health event has, in increased latency or reduced availability. This is the
|
|
741
740
|
* percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this
|
|
742
741
|
* client location to the Amazon Web Services location using this client network.</p>
|
|
742
|
+
* @public
|
|
743
743
|
*/
|
|
744
744
|
PercentOfTotalTrafficImpacted?: number;
|
|
745
745
|
/**
|
|
746
|
-
* @public
|
|
747
746
|
* <p>The type of impairment of a specific health event.</p>
|
|
747
|
+
* @public
|
|
748
748
|
*/
|
|
749
749
|
ImpactType: HealthEventImpactType | undefined;
|
|
750
750
|
/**
|
|
751
|
-
* @public
|
|
752
751
|
* <p>The threshold percentage for a health score that determines, along with other configuration information,
|
|
753
752
|
* when Internet Monitor creates a health event when there's an internet issue that affects your application end users.</p>
|
|
753
|
+
* @public
|
|
754
754
|
*/
|
|
755
755
|
HealthScoreThreshold?: number;
|
|
756
756
|
}
|
|
@@ -759,8 +759,8 @@ export interface GetHealthEventOutput {
|
|
|
759
759
|
*/
|
|
760
760
|
export interface GetMonitorInput {
|
|
761
761
|
/**
|
|
762
|
-
* @public
|
|
763
762
|
* <p>The name of the monitor.</p>
|
|
763
|
+
* @public
|
|
764
764
|
*/
|
|
765
765
|
MonitorName: string | undefined;
|
|
766
766
|
}
|
|
@@ -785,78 +785,78 @@ export type MonitorProcessingStatusCode = (typeof MonitorProcessingStatusCode)[k
|
|
|
785
785
|
*/
|
|
786
786
|
export interface GetMonitorOutput {
|
|
787
787
|
/**
|
|
788
|
-
* @public
|
|
789
788
|
* <p>The name of the monitor.</p>
|
|
789
|
+
* @public
|
|
790
790
|
*/
|
|
791
791
|
MonitorName: string | undefined;
|
|
792
792
|
/**
|
|
793
|
-
* @public
|
|
794
793
|
* <p>The Amazon Resource Name (ARN) of the monitor.</p>
|
|
794
|
+
* @public
|
|
795
795
|
*/
|
|
796
796
|
MonitorArn: string | undefined;
|
|
797
797
|
/**
|
|
798
|
-
* @public
|
|
799
798
|
* <p>The resources monitored by the monitor. Resources are listed by their Amazon Resource Names (ARNs).</p>
|
|
799
|
+
* @public
|
|
800
800
|
*/
|
|
801
801
|
Resources: string[] | undefined;
|
|
802
802
|
/**
|
|
803
|
-
* @public
|
|
804
803
|
* <p>The status of the monitor.</p>
|
|
804
|
+
* @public
|
|
805
805
|
*/
|
|
806
806
|
Status: MonitorConfigState | undefined;
|
|
807
807
|
/**
|
|
808
|
-
* @public
|
|
809
808
|
* <p>The time when the monitor was created.</p>
|
|
809
|
+
* @public
|
|
810
810
|
*/
|
|
811
811
|
CreatedAt: Date | undefined;
|
|
812
812
|
/**
|
|
813
|
-
* @public
|
|
814
813
|
* <p>The last time that the monitor was modified.</p>
|
|
814
|
+
* @public
|
|
815
815
|
*/
|
|
816
816
|
ModifiedAt: Date | undefined;
|
|
817
817
|
/**
|
|
818
|
-
* @public
|
|
819
818
|
* <p>The health of the data processing for the monitor.</p>
|
|
819
|
+
* @public
|
|
820
820
|
*/
|
|
821
821
|
ProcessingStatus?: MonitorProcessingStatusCode;
|
|
822
822
|
/**
|
|
823
|
-
* @public
|
|
824
823
|
* <p>Additional information about the health of the data processing for the monitor.</p>
|
|
824
|
+
* @public
|
|
825
825
|
*/
|
|
826
826
|
ProcessingStatusInfo?: string;
|
|
827
827
|
/**
|
|
828
|
-
* @public
|
|
829
828
|
* <p>The tags that have been added to monitor.</p>
|
|
829
|
+
* @public
|
|
830
830
|
*/
|
|
831
831
|
Tags?: Record<string, string>;
|
|
832
832
|
/**
|
|
833
|
-
* @public
|
|
834
833
|
* <p>The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your
|
|
835
834
|
* application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources
|
|
836
835
|
* through. This limit can help control billing costs.</p>
|
|
837
836
|
* <p>To learn more, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html">Choosing a city-network maximum value
|
|
838
837
|
* </a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
838
|
+
* @public
|
|
839
839
|
*/
|
|
840
840
|
MaxCityNetworksToMonitor?: number;
|
|
841
841
|
/**
|
|
842
|
-
* @public
|
|
843
842
|
* <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>
|
|
843
|
+
* @public
|
|
844
844
|
*/
|
|
845
845
|
InternetMeasurementsLogDelivery?: InternetMeasurementsLogDelivery;
|
|
846
846
|
/**
|
|
847
|
-
* @public
|
|
848
847
|
* <p>The percentage of the internet-facing traffic for your application to monitor with this monitor. If you set a city-networks
|
|
849
848
|
* maximum, that limit overrides the traffic percentage that you set.</p>
|
|
850
849
|
* <p>To learn more, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html">Choosing an application traffic percentage to monitor
|
|
851
850
|
* </a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
851
|
+
* @public
|
|
852
852
|
*/
|
|
853
853
|
TrafficPercentageToMonitor?: number;
|
|
854
854
|
/**
|
|
855
|
-
* @public
|
|
856
855
|
* <p>The list of health event threshold configurations. The threshold percentage for a health score determines, along with other configuration
|
|
857
856
|
* information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.</p>
|
|
858
857
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview">
|
|
859
858
|
* Change health event thresholds</a> in the Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
859
|
+
* @public
|
|
860
860
|
*/
|
|
861
861
|
HealthEventsConfig?: HealthEventsConfig;
|
|
862
862
|
}
|
|
@@ -865,42 +865,42 @@ export interface GetMonitorOutput {
|
|
|
865
865
|
*/
|
|
866
866
|
export interface GetQueryResultsInput {
|
|
867
867
|
/**
|
|
868
|
-
* @public
|
|
869
868
|
* <p>The name of the monitor to return data for.</p>
|
|
869
|
+
* @public
|
|
870
870
|
*/
|
|
871
871
|
MonitorName: string | undefined;
|
|
872
872
|
/**
|
|
873
|
-
* @public
|
|
874
873
|
* <p>The ID of the query that you want to return data results for. A <code>QueryId</code> is an
|
|
875
874
|
* internally-generated identifier for a specific query.</p>
|
|
875
|
+
* @public
|
|
876
876
|
*/
|
|
877
877
|
QueryId: string | undefined;
|
|
878
878
|
/**
|
|
879
|
-
* @public
|
|
880
879
|
* <p>The token for the next set of results. You receive this token from a previous call.</p>
|
|
880
|
+
* @public
|
|
881
881
|
*/
|
|
882
882
|
NextToken?: string;
|
|
883
883
|
/**
|
|
884
|
-
* @public
|
|
885
884
|
* <p>The number of query results that you want to return with this call.</p>
|
|
885
|
+
* @public
|
|
886
886
|
*/
|
|
887
887
|
MaxResults?: number;
|
|
888
888
|
}
|
|
889
889
|
/**
|
|
890
|
-
* @public
|
|
891
890
|
* <p>Defines a field to query for your application's Amazon CloudWatch Internet Monitor data. You create a data repository by running a query of a specific
|
|
892
891
|
* type. Each <code>QueryType</code> includes a specific set of fields and datatypes to retrieve data for. </p>
|
|
892
|
+
* @public
|
|
893
893
|
*/
|
|
894
894
|
export interface QueryField {
|
|
895
895
|
/**
|
|
896
|
-
* @public
|
|
897
896
|
* <p>The name of a field to query your application's Amazon CloudWatch Internet Monitor data for, such as <code>availability_score</code>.</p>
|
|
897
|
+
* @public
|
|
898
898
|
*/
|
|
899
899
|
Name?: string;
|
|
900
900
|
/**
|
|
901
|
-
* @public
|
|
902
901
|
* <p>The data type for a query field, which must correspond to the field you're defining for <code>QueryField</code>. For example, if the query
|
|
903
902
|
* field name is <code>availability_score</code>, the data type is <code>float</code>.</p>
|
|
903
|
+
* @public
|
|
904
904
|
*/
|
|
905
905
|
Type?: string;
|
|
906
906
|
}
|
|
@@ -909,21 +909,21 @@ export interface QueryField {
|
|
|
909
909
|
*/
|
|
910
910
|
export interface GetQueryResultsOutput {
|
|
911
911
|
/**
|
|
912
|
-
* @public
|
|
913
912
|
* <p>The fields that the query returns data for. Fields are name-data type pairs, such as
|
|
914
913
|
* <code>availability_score</code>-<code>float</code>.</p>
|
|
914
|
+
* @public
|
|
915
915
|
*/
|
|
916
916
|
Fields: QueryField[] | undefined;
|
|
917
917
|
/**
|
|
918
|
-
* @public
|
|
919
918
|
* <p>The data results that the query returns. Data is returned in arrays, aligned with the <code>Fields</code>
|
|
920
919
|
* for the query, which creates a repository of Amazon CloudWatch Internet Monitor information for your application. Then, you can filter
|
|
921
920
|
* the information in the repository by using <code>FilterParameters</code> that you define.</p>
|
|
921
|
+
* @public
|
|
922
922
|
*/
|
|
923
923
|
Data: string[][] | undefined;
|
|
924
924
|
/**
|
|
925
|
-
* @public
|
|
926
925
|
* <p>The token for the next set of results. You receive this token from a previous call.</p>
|
|
926
|
+
* @public
|
|
927
927
|
*/
|
|
928
928
|
NextToken?: string;
|
|
929
929
|
}
|
|
@@ -932,14 +932,14 @@ export interface GetQueryResultsOutput {
|
|
|
932
932
|
*/
|
|
933
933
|
export interface GetQueryStatusInput {
|
|
934
934
|
/**
|
|
935
|
-
* @public
|
|
936
935
|
* <p>The name of the monitor.</p>
|
|
936
|
+
* @public
|
|
937
937
|
*/
|
|
938
938
|
MonitorName: string | undefined;
|
|
939
939
|
/**
|
|
940
|
-
* @public
|
|
941
940
|
* <p>The ID of the query that you want to return the status for. A <code>QueryId</code> is an internally-generated
|
|
942
941
|
* dentifier for a specific query.</p>
|
|
942
|
+
* @public
|
|
943
943
|
*/
|
|
944
944
|
QueryId: string | undefined;
|
|
945
945
|
}
|
|
@@ -963,71 +963,71 @@ export type QueryStatus = (typeof QueryStatus)[keyof typeof QueryStatus];
|
|
|
963
963
|
*/
|
|
964
964
|
export interface GetQueryStatusOutput {
|
|
965
965
|
/**
|
|
966
|
-
* @public
|
|
967
966
|
* <p>The current status for a query.</p>
|
|
967
|
+
* @public
|
|
968
968
|
*/
|
|
969
969
|
Status: QueryStatus | undefined;
|
|
970
970
|
}
|
|
971
971
|
/**
|
|
972
|
-
* @public
|
|
973
972
|
* <p>Information about a health event created in a monitor in Amazon CloudWatch Internet Monitor.</p>
|
|
973
|
+
* @public
|
|
974
974
|
*/
|
|
975
975
|
export interface HealthEvent {
|
|
976
976
|
/**
|
|
977
|
-
* @public
|
|
978
977
|
* <p>The Amazon Resource Name (ARN) of the event.</p>
|
|
978
|
+
* @public
|
|
979
979
|
*/
|
|
980
980
|
EventArn: string | undefined;
|
|
981
981
|
/**
|
|
982
|
-
* @public
|
|
983
982
|
* <p>The internally-generated identifier of a specific network traffic impairment health event.</p>
|
|
983
|
+
* @public
|
|
984
984
|
*/
|
|
985
985
|
EventId: string | undefined;
|
|
986
986
|
/**
|
|
987
|
-
* @public
|
|
988
987
|
* <p>When a health event started.</p>
|
|
988
|
+
* @public
|
|
989
989
|
*/
|
|
990
990
|
StartedAt: Date | undefined;
|
|
991
991
|
/**
|
|
992
|
-
* @public
|
|
993
992
|
* <p>The time when a health event ended. If the health event is still active, then the end time is not set.</p>
|
|
993
|
+
* @public
|
|
994
994
|
*/
|
|
995
995
|
EndedAt?: Date;
|
|
996
996
|
/**
|
|
997
|
-
* @public
|
|
998
997
|
* <p>When the health event was created.</p>
|
|
998
|
+
* @public
|
|
999
999
|
*/
|
|
1000
1000
|
CreatedAt?: Date;
|
|
1001
1001
|
/**
|
|
1002
|
-
* @public
|
|
1003
1002
|
* <p>When the health event was last updated.</p>
|
|
1003
|
+
* @public
|
|
1004
1004
|
*/
|
|
1005
1005
|
LastUpdatedAt: Date | undefined;
|
|
1006
1006
|
/**
|
|
1007
|
-
* @public
|
|
1008
1007
|
* <p>The locations impacted by the health event.</p>
|
|
1008
|
+
* @public
|
|
1009
1009
|
*/
|
|
1010
1010
|
ImpactedLocations: ImpactedLocation[] | undefined;
|
|
1011
1011
|
/**
|
|
1012
|
-
* @public
|
|
1013
1012
|
* <p>Health event list member.</p>
|
|
1013
|
+
* @public
|
|
1014
1014
|
*/
|
|
1015
1015
|
Status: HealthEventStatus | undefined;
|
|
1016
1016
|
/**
|
|
1017
|
-
* @public
|
|
1018
1017
|
* <p>The impact on total traffic that a health event has, in increased latency or reduced availability. This is the
|
|
1019
1018
|
* percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this
|
|
1020
1019
|
* client location to the Amazon Web Services location using this client network.</p>
|
|
1020
|
+
* @public
|
|
1021
1021
|
*/
|
|
1022
1022
|
PercentOfTotalTrafficImpacted?: number;
|
|
1023
1023
|
/**
|
|
1024
|
-
* @public
|
|
1025
1024
|
* <p>The type of impairment for a health event.</p>
|
|
1025
|
+
* @public
|
|
1026
1026
|
*/
|
|
1027
1027
|
ImpactType: HealthEventImpactType | undefined;
|
|
1028
1028
|
/**
|
|
1029
|
-
* @public
|
|
1030
1029
|
* <p>The value of the threshold percentage for performance or availability that was configured when Amazon CloudWatch Internet Monitor created the health event.</p>
|
|
1030
|
+
* @public
|
|
1031
1031
|
*/
|
|
1032
1032
|
HealthScoreThreshold?: number;
|
|
1033
1033
|
}
|
|
@@ -1036,33 +1036,33 @@ export interface HealthEvent {
|
|
|
1036
1036
|
*/
|
|
1037
1037
|
export interface ListHealthEventsInput {
|
|
1038
1038
|
/**
|
|
1039
|
-
* @public
|
|
1040
1039
|
* <p>The name of the monitor.</p>
|
|
1040
|
+
* @public
|
|
1041
1041
|
*/
|
|
1042
1042
|
MonitorName: string | undefined;
|
|
1043
1043
|
/**
|
|
1044
|
-
* @public
|
|
1045
1044
|
* <p>The time when a health event started.</p>
|
|
1045
|
+
* @public
|
|
1046
1046
|
*/
|
|
1047
1047
|
StartTime?: Date;
|
|
1048
1048
|
/**
|
|
1049
|
-
* @public
|
|
1050
1049
|
* <p>The time when a health event ended. If the health event is still ongoing, then the end time is not set.</p>
|
|
1050
|
+
* @public
|
|
1051
1051
|
*/
|
|
1052
1052
|
EndTime?: Date;
|
|
1053
1053
|
/**
|
|
1054
|
-
* @public
|
|
1055
1054
|
* <p>The token for the next set of results. You receive this token from a previous call.</p>
|
|
1055
|
+
* @public
|
|
1056
1056
|
*/
|
|
1057
1057
|
NextToken?: string;
|
|
1058
1058
|
/**
|
|
1059
|
-
* @public
|
|
1060
1059
|
* <p>The number of health event objects that you want to return with this call. </p>
|
|
1060
|
+
* @public
|
|
1061
1061
|
*/
|
|
1062
1062
|
MaxResults?: number;
|
|
1063
1063
|
/**
|
|
1064
|
-
* @public
|
|
1065
1064
|
* <p>The status of a health event.</p>
|
|
1065
|
+
* @public
|
|
1066
1066
|
*/
|
|
1067
1067
|
EventStatus?: HealthEventStatus;
|
|
1068
1068
|
}
|
|
@@ -1071,19 +1071,19 @@ export interface ListHealthEventsInput {
|
|
|
1071
1071
|
*/
|
|
1072
1072
|
export interface ListHealthEventsOutput {
|
|
1073
1073
|
/**
|
|
1074
|
-
* @public
|
|
1075
1074
|
* <p>A list of health events.</p>
|
|
1075
|
+
* @public
|
|
1076
1076
|
*/
|
|
1077
1077
|
HealthEvents: HealthEvent[] | undefined;
|
|
1078
1078
|
/**
|
|
1079
|
-
* @public
|
|
1080
1079
|
* <p>The token for the next set of results. You receive this token from a previous call.</p>
|
|
1080
|
+
* @public
|
|
1081
1081
|
*/
|
|
1082
1082
|
NextToken?: string;
|
|
1083
1083
|
}
|
|
1084
1084
|
/**
|
|
1085
|
-
* @public
|
|
1086
1085
|
* <p>There was an internal server error.</p>
|
|
1086
|
+
* @public
|
|
1087
1087
|
*/
|
|
1088
1088
|
export declare class InternalServerErrorException extends __BaseException {
|
|
1089
1089
|
readonly name: "InternalServerErrorException";
|
|
@@ -1099,8 +1099,8 @@ export declare class InternalServerErrorException extends __BaseException {
|
|
|
1099
1099
|
*/
|
|
1100
1100
|
export interface ListTagsForResourceInput {
|
|
1101
1101
|
/**
|
|
1102
|
-
* @public
|
|
1103
1102
|
* <p>The Amazon Resource Name (ARN) for a resource.</p>
|
|
1103
|
+
* @public
|
|
1104
1104
|
*/
|
|
1105
1105
|
ResourceArn: string | undefined;
|
|
1106
1106
|
}
|
|
@@ -1109,14 +1109,14 @@ export interface ListTagsForResourceInput {
|
|
|
1109
1109
|
*/
|
|
1110
1110
|
export interface ListTagsForResourceOutput {
|
|
1111
1111
|
/**
|
|
1112
|
-
* @public
|
|
1113
1112
|
* <p>Tags for a resource.</p>
|
|
1113
|
+
* @public
|
|
1114
1114
|
*/
|
|
1115
1115
|
Tags?: Record<string, string>;
|
|
1116
1116
|
}
|
|
1117
1117
|
/**
|
|
1118
|
-
* @public
|
|
1119
1118
|
* <p>The request specifies something that doesn't exist.</p>
|
|
1119
|
+
* @public
|
|
1120
1120
|
*/
|
|
1121
1121
|
export declare class NotFoundException extends __BaseException {
|
|
1122
1122
|
readonly name: "NotFoundException";
|
|
@@ -1127,8 +1127,8 @@ export declare class NotFoundException extends __BaseException {
|
|
|
1127
1127
|
constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
|
|
1128
1128
|
}
|
|
1129
1129
|
/**
|
|
1130
|
-
* @public
|
|
1131
1130
|
* <p>There were too many requests.</p>
|
|
1131
|
+
* @public
|
|
1132
1132
|
*/
|
|
1133
1133
|
export declare class TooManyRequestsException extends __BaseException {
|
|
1134
1134
|
readonly name: "TooManyRequestsException";
|
|
@@ -1146,46 +1146,46 @@ export declare class TooManyRequestsException extends __BaseException {
|
|
|
1146
1146
|
*/
|
|
1147
1147
|
export interface ListMonitorsInput {
|
|
1148
1148
|
/**
|
|
1149
|
-
* @public
|
|
1150
1149
|
* <p>The token for the next set of results. You receive this token from a previous call.</p>
|
|
1150
|
+
* @public
|
|
1151
1151
|
*/
|
|
1152
1152
|
NextToken?: string;
|
|
1153
1153
|
/**
|
|
1154
|
-
* @public
|
|
1155
1154
|
* <p>The number of monitor objects that you want to return with this call.</p>
|
|
1155
|
+
* @public
|
|
1156
1156
|
*/
|
|
1157
1157
|
MaxResults?: number;
|
|
1158
1158
|
/**
|
|
1159
|
-
* @public
|
|
1160
1159
|
* <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>
|
|
1161
1160
|
* <p>For information about the statuses for a monitor, see <a href="https://docs.aws.amazon.com/internet-monitor/latest/api/API_Monitor.html">
|
|
1162
1161
|
* Monitor</a>.</p>
|
|
1162
|
+
* @public
|
|
1163
1163
|
*/
|
|
1164
1164
|
MonitorStatus?: string;
|
|
1165
1165
|
}
|
|
1166
1166
|
/**
|
|
1167
|
-
* @public
|
|
1168
1167
|
* <p>The description of and information about a monitor in Amazon CloudWatch Internet Monitor. </p>
|
|
1168
|
+
* @public
|
|
1169
1169
|
*/
|
|
1170
1170
|
export interface Monitor {
|
|
1171
1171
|
/**
|
|
1172
|
-
* @public
|
|
1173
1172
|
* <p>The name of the monitor.</p>
|
|
1173
|
+
* @public
|
|
1174
1174
|
*/
|
|
1175
1175
|
MonitorName: string | undefined;
|
|
1176
1176
|
/**
|
|
1177
|
-
* @public
|
|
1178
1177
|
* <p>The Amazon Resource Name (ARN) of the monitor.</p>
|
|
1178
|
+
* @public
|
|
1179
1179
|
*/
|
|
1180
1180
|
MonitorArn: string | undefined;
|
|
1181
1181
|
/**
|
|
1182
|
-
* @public
|
|
1183
1182
|
* <p>The status of a monitor.</p>
|
|
1183
|
+
* @public
|
|
1184
1184
|
*/
|
|
1185
1185
|
Status: MonitorConfigState | undefined;
|
|
1186
1186
|
/**
|
|
1187
|
-
* @public
|
|
1188
1187
|
* <p>The health of data processing for the monitor.</p>
|
|
1188
|
+
* @public
|
|
1189
1189
|
*/
|
|
1190
1190
|
ProcessingStatus?: MonitorProcessingStatusCode;
|
|
1191
1191
|
}
|
|
@@ -1194,13 +1194,13 @@ export interface Monitor {
|
|
|
1194
1194
|
*/
|
|
1195
1195
|
export interface ListMonitorsOutput {
|
|
1196
1196
|
/**
|
|
1197
|
-
* @public
|
|
1198
1197
|
* <p>A list of monitors.</p>
|
|
1198
|
+
* @public
|
|
1199
1199
|
*/
|
|
1200
1200
|
Monitors: Monitor[] | undefined;
|
|
1201
1201
|
/**
|
|
1202
|
-
* @public
|
|
1203
1202
|
* <p>The token for the next set of results. You receive this token from a previous call.</p>
|
|
1203
|
+
* @public
|
|
1204
1204
|
*/
|
|
1205
1205
|
NextToken?: string;
|
|
1206
1206
|
}
|
|
@@ -1222,22 +1222,21 @@ export type QueryType = (typeof QueryType)[keyof typeof QueryType];
|
|
|
1222
1222
|
*/
|
|
1223
1223
|
export interface StartQueryInput {
|
|
1224
1224
|
/**
|
|
1225
|
-
* @public
|
|
1226
1225
|
* <p>The name of the monitor to query.</p>
|
|
1226
|
+
* @public
|
|
1227
1227
|
*/
|
|
1228
1228
|
MonitorName: string | undefined;
|
|
1229
1229
|
/**
|
|
1230
|
-
* @public
|
|
1231
1230
|
* <p>The timestamp that is the beginning of the period that you want to retrieve data for with your query.</p>
|
|
1231
|
+
* @public
|
|
1232
1232
|
*/
|
|
1233
1233
|
StartTime: Date | undefined;
|
|
1234
1234
|
/**
|
|
1235
|
-
* @public
|
|
1236
1235
|
* <p>The timestamp that is the end of the period that you want to retrieve data for with your query.</p>
|
|
1236
|
+
* @public
|
|
1237
1237
|
*/
|
|
1238
1238
|
EndTime: Date | undefined;
|
|
1239
1239
|
/**
|
|
1240
|
-
* @public
|
|
1241
1240
|
* <p>The type of query to run. The following are the three types of queries that you can run using the Internet Monitor query interface:</p>
|
|
1242
1241
|
* <ul>
|
|
1243
1242
|
* <li>
|
|
@@ -1259,16 +1258,17 @@ export interface StartQueryInput {
|
|
|
1259
1258
|
* <p>For lists of the fields returned with each query type and more information about how each type of query is
|
|
1260
1259
|
* performed, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html">
|
|
1261
1260
|
* Using the Amazon CloudWatch Internet Monitor query interface</a> in the Amazon CloudWatch Internet Monitor User Guide.</p>
|
|
1261
|
+
* @public
|
|
1262
1262
|
*/
|
|
1263
1263
|
QueryType: QueryType | undefined;
|
|
1264
1264
|
/**
|
|
1265
|
-
* @public
|
|
1266
1265
|
* <p>The <code>FilterParameters</code> field that you use with Amazon CloudWatch Internet Monitor queries is a string the defines
|
|
1267
1266
|
* how you want a query to be filtered. The filter parameters that you can specify depend on the query type, since
|
|
1268
1267
|
* each query type returns a different set of Internet Monitor data.</p>
|
|
1269
1268
|
* <p>For more information about specifying filter parameters, see
|
|
1270
1269
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html">Using the Amazon CloudWatch Internet Monitor query interface</a>
|
|
1271
1270
|
* in the Amazon CloudWatch Internet Monitor User Guide.</p>
|
|
1271
|
+
* @public
|
|
1272
1272
|
*/
|
|
1273
1273
|
FilterParameters?: FilterParameter[];
|
|
1274
1274
|
}
|
|
@@ -1277,8 +1277,8 @@ export interface StartQueryInput {
|
|
|
1277
1277
|
*/
|
|
1278
1278
|
export interface StartQueryOutput {
|
|
1279
1279
|
/**
|
|
1280
|
-
* @public
|
|
1281
1280
|
* <p>The internally-generated identifier of a specific query.</p>
|
|
1281
|
+
* @public
|
|
1282
1282
|
*/
|
|
1283
1283
|
QueryId: string | undefined;
|
|
1284
1284
|
}
|
|
@@ -1287,13 +1287,13 @@ export interface StartQueryOutput {
|
|
|
1287
1287
|
*/
|
|
1288
1288
|
export interface StopQueryInput {
|
|
1289
1289
|
/**
|
|
1290
|
-
* @public
|
|
1291
1290
|
* <p>The name of the monitor.</p>
|
|
1291
|
+
* @public
|
|
1292
1292
|
*/
|
|
1293
1293
|
MonitorName: string | undefined;
|
|
1294
1294
|
/**
|
|
1295
|
-
* @public
|
|
1296
1295
|
* <p>The ID of the query that you want to stop. A <code>QueryId</code> is an internally-generated identifier for a specific query.</p>
|
|
1296
|
+
* @public
|
|
1297
1297
|
*/
|
|
1298
1298
|
QueryId: string | undefined;
|
|
1299
1299
|
}
|
|
@@ -1303,8 +1303,8 @@ export interface StopQueryInput {
|
|
|
1303
1303
|
export interface StopQueryOutput {
|
|
1304
1304
|
}
|
|
1305
1305
|
/**
|
|
1306
|
-
* @public
|
|
1307
1306
|
* <p>The request specifies a resource that doesn't exist.</p>
|
|
1307
|
+
* @public
|
|
1308
1308
|
*/
|
|
1309
1309
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
1310
1310
|
readonly name: "ResourceNotFoundException";
|
|
@@ -1319,12 +1319,11 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
1319
1319
|
*/
|
|
1320
1320
|
export interface UpdateMonitorInput {
|
|
1321
1321
|
/**
|
|
1322
|
-
* @public
|
|
1323
1322
|
* <p>The name of the monitor. </p>
|
|
1323
|
+
* @public
|
|
1324
1324
|
*/
|
|
1325
1325
|
MonitorName: string | undefined;
|
|
1326
1326
|
/**
|
|
1327
|
-
* @public
|
|
1328
1327
|
* <p>The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs,
|
|
1329
1328
|
* Amazon CloudFront distributions, or Amazon WorkSpaces directories.</p>
|
|
1330
1329
|
* <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
|
|
@@ -1333,51 +1332,52 @@ export interface UpdateMonitorInput {
|
|
|
1333
1332
|
* <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
|
|
1334
1333
|
* connectivity.</p>
|
|
1335
1334
|
* </note>
|
|
1335
|
+
* @public
|
|
1336
1336
|
*/
|
|
1337
1337
|
ResourcesToAdd?: string[];
|
|
1338
1338
|
/**
|
|
1339
|
-
* @public
|
|
1340
1339
|
* <p>The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).</p>
|
|
1340
|
+
* @public
|
|
1341
1341
|
*/
|
|
1342
1342
|
ResourcesToRemove?: string[];
|
|
1343
1343
|
/**
|
|
1344
|
-
* @public
|
|
1345
1344
|
* <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
|
|
1346
1345
|
* <code>INACTIVE</code>. The following values are <i>not</i> accepted: <code>PENDING</code>, and <code>ERROR</code>.</p>
|
|
1346
|
+
* @public
|
|
1347
1347
|
*/
|
|
1348
1348
|
Status?: MonitorConfigState;
|
|
1349
1349
|
/**
|
|
1350
|
-
* @public
|
|
1351
1350
|
* <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
|
|
1352
1351
|
* token for other API requests.</p>
|
|
1352
|
+
* @public
|
|
1353
1353
|
*/
|
|
1354
1354
|
ClientToken?: string;
|
|
1355
1355
|
/**
|
|
1356
|
-
* @public
|
|
1357
1356
|
* <p>The maximum number of city-networks to monitor for your application. A city-network is the location (city) where clients access your
|
|
1358
1357
|
* application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources
|
|
1359
1358
|
* through. Setting this limit can help control billing costs.</p>
|
|
1359
|
+
* @public
|
|
1360
1360
|
*/
|
|
1361
1361
|
MaxCityNetworksToMonitor?: number;
|
|
1362
1362
|
/**
|
|
1363
|
-
* @public
|
|
1364
1363
|
* <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>
|
|
1364
|
+
* @public
|
|
1365
1365
|
*/
|
|
1366
1366
|
InternetMeasurementsLogDelivery?: InternetMeasurementsLogDelivery;
|
|
1367
1367
|
/**
|
|
1368
|
-
* @public
|
|
1369
1368
|
* <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
|
|
1370
1369
|
* maximum, that limit overrides the traffic percentage that you set.</p>
|
|
1371
1370
|
* <p>To learn more, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html">Choosing an application traffic percentage to monitor
|
|
1372
1371
|
* </a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
1372
|
+
* @public
|
|
1373
1373
|
*/
|
|
1374
1374
|
TrafficPercentageToMonitor?: number;
|
|
1375
1375
|
/**
|
|
1376
|
-
* @public
|
|
1377
1376
|
* <p>The list of health score thresholds. A threshold percentage for health scores, along with other configuration information,
|
|
1378
1377
|
* determines when Internet Monitor creates a health event when there's an internet issue that affects your application end users.</p>
|
|
1379
1378
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview">
|
|
1380
1379
|
* Change health event thresholds</a> in the Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>
|
|
1380
|
+
* @public
|
|
1381
1381
|
*/
|
|
1382
1382
|
HealthEventsConfig?: HealthEventsConfig;
|
|
1383
1383
|
}
|
|
@@ -1386,13 +1386,13 @@ export interface UpdateMonitorInput {
|
|
|
1386
1386
|
*/
|
|
1387
1387
|
export interface UpdateMonitorOutput {
|
|
1388
1388
|
/**
|
|
1389
|
-
* @public
|
|
1390
1389
|
* <p>The Amazon Resource Name (ARN) of the monitor.</p>
|
|
1390
|
+
* @public
|
|
1391
1391
|
*/
|
|
1392
1392
|
MonitorArn: string | undefined;
|
|
1393
1393
|
/**
|
|
1394
|
-
* @public
|
|
1395
1394
|
* <p>The status of a monitor.</p>
|
|
1395
|
+
* @public
|
|
1396
1396
|
*/
|
|
1397
1397
|
Status: MonitorConfigState | undefined;
|
|
1398
1398
|
}
|
|
@@ -1401,13 +1401,13 @@ export interface UpdateMonitorOutput {
|
|
|
1401
1401
|
*/
|
|
1402
1402
|
export interface TagResourceInput {
|
|
1403
1403
|
/**
|
|
1404
|
-
* @public
|
|
1405
1404
|
* <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>
|
|
1405
|
+
* @public
|
|
1406
1406
|
*/
|
|
1407
1407
|
ResourceArn: string | undefined;
|
|
1408
1408
|
/**
|
|
1409
|
-
* @public
|
|
1410
1409
|
* <p>Tags that you add to a resource. You can add a maximum of 50 tags in Internet Monitor.</p>
|
|
1410
|
+
* @public
|
|
1411
1411
|
*/
|
|
1412
1412
|
Tags: Record<string, string> | undefined;
|
|
1413
1413
|
}
|
|
@@ -1421,13 +1421,13 @@ export interface TagResourceOutput {
|
|
|
1421
1421
|
*/
|
|
1422
1422
|
export interface UntagResourceInput {
|
|
1423
1423
|
/**
|
|
1424
|
-
* @public
|
|
1425
1424
|
* <p>The Amazon Resource Name (ARN) for a tag you remove a resource from.</p>
|
|
1425
|
+
* @public
|
|
1426
1426
|
*/
|
|
1427
1427
|
ResourceArn: string | undefined;
|
|
1428
1428
|
/**
|
|
1429
|
-
* @public
|
|
1430
1429
|
* <p>Tag keys that you remove from a resource.</p>
|
|
1430
|
+
* @public
|
|
1431
1431
|
*/
|
|
1432
1432
|
TagKeys: string[] | undefined;
|
|
1433
1433
|
}
|