aws-sdk-internetmonitor 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-internetmonitor/client.rb +965 -0
- data/lib/aws-sdk-internetmonitor/client_api.rb +449 -0
- data/lib/aws-sdk-internetmonitor/customizations.rb +0 -0
- data/lib/aws-sdk-internetmonitor/endpoint_parameters.rb +54 -0
- data/lib/aws-sdk-internetmonitor/endpoint_provider.rb +47 -0
- data/lib/aws-sdk-internetmonitor/endpoints.rb +145 -0
- data/lib/aws-sdk-internetmonitor/errors.rb +238 -0
- data/lib/aws-sdk-internetmonitor/plugins/endpoints.rb +88 -0
- data/lib/aws-sdk-internetmonitor/resource.rb +26 -0
- data/lib/aws-sdk-internetmonitor/types.rb +1145 -0
- data/lib/aws-sdk-internetmonitor/waiters.rb +15 -0
- data/lib/aws-sdk-internetmonitor.rb +58 -0
- metadata +95 -0
@@ -0,0 +1,1145 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::InternetMonitor
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You don't have sufficient permission to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/AccessDeniedException AWS API Documentation
|
19
|
+
#
|
20
|
+
class AccessDeniedException < Struct.new(
|
21
|
+
:message)
|
22
|
+
SENSITIVE = []
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
26
|
+
# Measurements about the availability for your application on the
|
27
|
+
# internet, calculated by Amazon CloudWatch Internet Monitor. Amazon Web
|
28
|
+
# Services has substantial historical data about internet performance
|
29
|
+
# and availability between Amazon Web Services services and different
|
30
|
+
# network providers and geographies. By applying statistical analysis to
|
31
|
+
# the data, Internet Monitor can detect when the performance and
|
32
|
+
# availability for your application has dropped, compared to an
|
33
|
+
# estimated baseline that's already calculated. To make it easier to
|
34
|
+
# see those drops, we report that information to you in the form of
|
35
|
+
# health scores: a performance score and an availability score.
|
36
|
+
#
|
37
|
+
# Availability in Internet Monitor represents the estimated percentage
|
38
|
+
# of traffic that is not seeing an availability drop. For example, an
|
39
|
+
# availability score of 99% for an end user and service location pair is
|
40
|
+
# equivalent to 1% of the traffic experiencing an availability drop for
|
41
|
+
# that pair.
|
42
|
+
#
|
43
|
+
# For more information, see [ How Internet Monitor calculates
|
44
|
+
# performance and availability scores][1] in the Amazon CloudWatch
|
45
|
+
# Internet Monitor section of the Amazon CloudWatch User Guide.
|
46
|
+
#
|
47
|
+
#
|
48
|
+
#
|
49
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores
|
50
|
+
#
|
51
|
+
# @!attribute [rw] experience_score
|
52
|
+
# Experience scores, or health scores are calculated for different
|
53
|
+
# geographic and network provider combinations (that is, different
|
54
|
+
# granularities) and also summed into global scores. If you view
|
55
|
+
# performance or availability scores without filtering for any
|
56
|
+
# specific geography or service provider, Amazon CloudWatch Internet
|
57
|
+
# Monitor provides global health scores.
|
58
|
+
#
|
59
|
+
# The Amazon CloudWatch Internet Monitor chapter in the CloudWatch
|
60
|
+
# User Guide includes detailed information about how Internet Monitor
|
61
|
+
# calculates health scores, including performance and availability
|
62
|
+
# scores, and when it creates and resolves health events. For more
|
63
|
+
# information, see [ How Amazon Web Services calculates performance
|
64
|
+
# and availability scores][1] in the Amazon CloudWatch Internet
|
65
|
+
# Monitor section of the CloudWatch User Guide.
|
66
|
+
#
|
67
|
+
#
|
68
|
+
#
|
69
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores
|
70
|
+
# @return [Float]
|
71
|
+
#
|
72
|
+
# @!attribute [rw] percent_of_total_traffic_impacted
|
73
|
+
# The percentage of impact caused by a health event for total traffic
|
74
|
+
# globally.
|
75
|
+
#
|
76
|
+
# For information about how Internet Monitor calculates impact, see [
|
77
|
+
# Inside Internet Monitor][1] in the Amazon CloudWatch Internet
|
78
|
+
# Monitor section of the Amazon CloudWatch User Guide.
|
79
|
+
#
|
80
|
+
#
|
81
|
+
#
|
82
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html
|
83
|
+
# @return [Float]
|
84
|
+
#
|
85
|
+
# @!attribute [rw] percent_of_client_location_impacted
|
86
|
+
# The percentage of impact caused by a health event for client
|
87
|
+
# location traffic globally.
|
88
|
+
#
|
89
|
+
# For information about how Internet Monitor calculates impact, see [
|
90
|
+
# Inside Internet Monitor][1] in the Amazon CloudWatch Internet
|
91
|
+
# Monitor section of the Amazon CloudWatch User Guide.
|
92
|
+
#
|
93
|
+
#
|
94
|
+
#
|
95
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html
|
96
|
+
# @return [Float]
|
97
|
+
#
|
98
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/AvailabilityMeasurement AWS API Documentation
|
99
|
+
#
|
100
|
+
class AvailabilityMeasurement < Struct.new(
|
101
|
+
:experience_score,
|
102
|
+
:percent_of_total_traffic_impacted,
|
103
|
+
:percent_of_client_location_impacted)
|
104
|
+
SENSITIVE = []
|
105
|
+
include Aws::Structure
|
106
|
+
end
|
107
|
+
|
108
|
+
# A bad request was received.
|
109
|
+
#
|
110
|
+
# @!attribute [rw] message
|
111
|
+
# @return [String]
|
112
|
+
#
|
113
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/BadRequestException AWS API Documentation
|
114
|
+
#
|
115
|
+
class BadRequestException < Struct.new(
|
116
|
+
:message)
|
117
|
+
SENSITIVE = []
|
118
|
+
include Aws::Structure
|
119
|
+
end
|
120
|
+
|
121
|
+
# The requested resource is in use.
|
122
|
+
#
|
123
|
+
# @!attribute [rw] message
|
124
|
+
# @return [String]
|
125
|
+
#
|
126
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/ConflictException AWS API Documentation
|
127
|
+
#
|
128
|
+
class ConflictException < Struct.new(
|
129
|
+
:message)
|
130
|
+
SENSITIVE = []
|
131
|
+
include Aws::Structure
|
132
|
+
end
|
133
|
+
|
134
|
+
# @!attribute [rw] monitor_name
|
135
|
+
# The name of the monitor.
|
136
|
+
# @return [String]
|
137
|
+
#
|
138
|
+
# @!attribute [rw] resources
|
139
|
+
# The resources to include in a monitor, which you provide as a set of
|
140
|
+
# Amazon Resource Names (ARNs).
|
141
|
+
#
|
142
|
+
# You can add a combination of Amazon Virtual Private Clouds (VPCs)
|
143
|
+
# and Amazon CloudFront distributions, or you can add Amazon
|
144
|
+
# WorkSpaces directories. You can't add all three types of resources.
|
145
|
+
#
|
146
|
+
# <note markdown="1"> If you add only VPC resources, at least one VPC must have an
|
147
|
+
# Internet Gateway attached to it, to make sure that it has internet
|
148
|
+
# connectivity.
|
149
|
+
#
|
150
|
+
# </note>
|
151
|
+
# @return [Array<String>]
|
152
|
+
#
|
153
|
+
# @!attribute [rw] client_token
|
154
|
+
# A unique, case-sensitive string of up to 64 ASCII characters that
|
155
|
+
# you specify to make an idempotent API request. Don't reuse the same
|
156
|
+
# client token for other API requests.
|
157
|
+
#
|
158
|
+
# **A suitable default value is auto-generated.** You should normally
|
159
|
+
# not need to pass this option.
|
160
|
+
# @return [String]
|
161
|
+
#
|
162
|
+
# @!attribute [rw] tags
|
163
|
+
# The tags for a monitor. You can add a maximum of 50 tags in Internet
|
164
|
+
# Monitor.
|
165
|
+
# @return [Hash<String,String>]
|
166
|
+
#
|
167
|
+
# @!attribute [rw] max_city_networks_to_monitor
|
168
|
+
# The maximum number of city-network combinations (that is,
|
169
|
+
# combinations of a city location and network, such as an ISP) to be
|
170
|
+
# monitored for your resources.
|
171
|
+
# @return [Integer]
|
172
|
+
#
|
173
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/CreateMonitorInput AWS API Documentation
|
174
|
+
#
|
175
|
+
class CreateMonitorInput < Struct.new(
|
176
|
+
:monitor_name,
|
177
|
+
:resources,
|
178
|
+
:client_token,
|
179
|
+
:tags,
|
180
|
+
:max_city_networks_to_monitor)
|
181
|
+
SENSITIVE = []
|
182
|
+
include Aws::Structure
|
183
|
+
end
|
184
|
+
|
185
|
+
# @!attribute [rw] arn
|
186
|
+
# The Amazon Resource Name (ARN) of the monitor.
|
187
|
+
# @return [String]
|
188
|
+
#
|
189
|
+
# @!attribute [rw] status
|
190
|
+
# The status of a monitor.
|
191
|
+
# @return [String]
|
192
|
+
#
|
193
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/CreateMonitorOutput AWS API Documentation
|
194
|
+
#
|
195
|
+
class CreateMonitorOutput < Struct.new(
|
196
|
+
:arn,
|
197
|
+
:status)
|
198
|
+
SENSITIVE = []
|
199
|
+
include Aws::Structure
|
200
|
+
end
|
201
|
+
|
202
|
+
# @!attribute [rw] monitor_name
|
203
|
+
# The name of the monitor to delete.
|
204
|
+
# @return [String]
|
205
|
+
#
|
206
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/DeleteMonitorInput AWS API Documentation
|
207
|
+
#
|
208
|
+
class DeleteMonitorInput < Struct.new(
|
209
|
+
:monitor_name)
|
210
|
+
SENSITIVE = []
|
211
|
+
include Aws::Structure
|
212
|
+
end
|
213
|
+
|
214
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/DeleteMonitorOutput AWS API Documentation
|
215
|
+
#
|
216
|
+
class DeleteMonitorOutput < Aws::EmptyStructure; end
|
217
|
+
|
218
|
+
# @!attribute [rw] monitor_name
|
219
|
+
# The name of the monitor.
|
220
|
+
# @return [String]
|
221
|
+
#
|
222
|
+
# @!attribute [rw] event_id
|
223
|
+
# The internally generated identifier of a health event. Because
|
224
|
+
# `EventID` contains the forward slash (“/”) character, you must
|
225
|
+
# URL-encode the `EventID` field in the request URL.
|
226
|
+
# @return [String]
|
227
|
+
#
|
228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/GetHealthEventInput AWS API Documentation
|
229
|
+
#
|
230
|
+
class GetHealthEventInput < Struct.new(
|
231
|
+
:monitor_name,
|
232
|
+
:event_id)
|
233
|
+
SENSITIVE = []
|
234
|
+
include Aws::Structure
|
235
|
+
end
|
236
|
+
|
237
|
+
# @!attribute [rw] event_arn
|
238
|
+
# The Amazon Resource Name (ARN) of the event.
|
239
|
+
# @return [String]
|
240
|
+
#
|
241
|
+
# @!attribute [rw] event_id
|
242
|
+
# The internally generated identifier of a health event.
|
243
|
+
# @return [String]
|
244
|
+
#
|
245
|
+
# @!attribute [rw] started_at
|
246
|
+
# The time when a health event started.
|
247
|
+
# @return [Time]
|
248
|
+
#
|
249
|
+
# @!attribute [rw] ended_at
|
250
|
+
# The time when a health event was resolved. If the health event is
|
251
|
+
# still active, the end time is not set.
|
252
|
+
# @return [Time]
|
253
|
+
#
|
254
|
+
# @!attribute [rw] created_at
|
255
|
+
# The time when a health event was created.
|
256
|
+
# @return [Time]
|
257
|
+
#
|
258
|
+
# @!attribute [rw] last_updated_at
|
259
|
+
# The time when a health event was last updated or recalculated.
|
260
|
+
# @return [Time]
|
261
|
+
#
|
262
|
+
# @!attribute [rw] impacted_locations
|
263
|
+
# The locations affected by a health event.
|
264
|
+
# @return [Array<Types::ImpactedLocation>]
|
265
|
+
#
|
266
|
+
# @!attribute [rw] status
|
267
|
+
# The status of a health event.
|
268
|
+
# @return [String]
|
269
|
+
#
|
270
|
+
# @!attribute [rw] percent_of_total_traffic_impacted
|
271
|
+
# The impact on total traffic that a health event has.
|
272
|
+
# @return [Float]
|
273
|
+
#
|
274
|
+
# @!attribute [rw] impact_type
|
275
|
+
# The type of impairment of a specific health event.
|
276
|
+
# @return [String]
|
277
|
+
#
|
278
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/GetHealthEventOutput AWS API Documentation
|
279
|
+
#
|
280
|
+
class GetHealthEventOutput < Struct.new(
|
281
|
+
:event_arn,
|
282
|
+
:event_id,
|
283
|
+
:started_at,
|
284
|
+
:ended_at,
|
285
|
+
:created_at,
|
286
|
+
:last_updated_at,
|
287
|
+
:impacted_locations,
|
288
|
+
:status,
|
289
|
+
:percent_of_total_traffic_impacted,
|
290
|
+
:impact_type)
|
291
|
+
SENSITIVE = []
|
292
|
+
include Aws::Structure
|
293
|
+
end
|
294
|
+
|
295
|
+
# @!attribute [rw] monitor_name
|
296
|
+
# The name of the monitor.
|
297
|
+
# @return [String]
|
298
|
+
#
|
299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/GetMonitorInput AWS API Documentation
|
300
|
+
#
|
301
|
+
class GetMonitorInput < Struct.new(
|
302
|
+
:monitor_name)
|
303
|
+
SENSITIVE = []
|
304
|
+
include Aws::Structure
|
305
|
+
end
|
306
|
+
|
307
|
+
# @!attribute [rw] monitor_name
|
308
|
+
# The name of the monitor.
|
309
|
+
# @return [String]
|
310
|
+
#
|
311
|
+
# @!attribute [rw] monitor_arn
|
312
|
+
# The Amazon Resource Name (ARN) of the monitor.
|
313
|
+
# @return [String]
|
314
|
+
#
|
315
|
+
# @!attribute [rw] resources
|
316
|
+
# The resources that have been added for the monitor. Resources are
|
317
|
+
# listed by their Amazon Resource Names (ARNs).
|
318
|
+
# @return [Array<String>]
|
319
|
+
#
|
320
|
+
# @!attribute [rw] status
|
321
|
+
# The status of the monitor.
|
322
|
+
# @return [String]
|
323
|
+
#
|
324
|
+
# @!attribute [rw] created_at
|
325
|
+
# The time when the monitor was created.
|
326
|
+
# @return [Time]
|
327
|
+
#
|
328
|
+
# @!attribute [rw] modified_at
|
329
|
+
# The last time that the monitor was modified.
|
330
|
+
# @return [Time]
|
331
|
+
#
|
332
|
+
# @!attribute [rw] processing_status
|
333
|
+
# The health of the data processing for the monitor.
|
334
|
+
# @return [String]
|
335
|
+
#
|
336
|
+
# @!attribute [rw] processing_status_info
|
337
|
+
# Additional information about the health of the data processing for
|
338
|
+
# the monitor.
|
339
|
+
# @return [String]
|
340
|
+
#
|
341
|
+
# @!attribute [rw] tags
|
342
|
+
# The tags that have been added to monitor.
|
343
|
+
# @return [Hash<String,String>]
|
344
|
+
#
|
345
|
+
# @!attribute [rw] max_city_networks_to_monitor
|
346
|
+
# The maximum number of city-network combinations (that is,
|
347
|
+
# combinations of a city location and network, such as an ISP) to be
|
348
|
+
# monitored for your resources.
|
349
|
+
# @return [Integer]
|
350
|
+
#
|
351
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/GetMonitorOutput AWS API Documentation
|
352
|
+
#
|
353
|
+
class GetMonitorOutput < Struct.new(
|
354
|
+
:monitor_name,
|
355
|
+
:monitor_arn,
|
356
|
+
:resources,
|
357
|
+
:status,
|
358
|
+
:created_at,
|
359
|
+
:modified_at,
|
360
|
+
:processing_status,
|
361
|
+
:processing_status_info,
|
362
|
+
:tags,
|
363
|
+
:max_city_networks_to_monitor)
|
364
|
+
SENSITIVE = []
|
365
|
+
include Aws::Structure
|
366
|
+
end
|
367
|
+
|
368
|
+
# Information about a health event created in a monitor in Amazon
|
369
|
+
# CloudWatch Internet Monitor.
|
370
|
+
#
|
371
|
+
# @!attribute [rw] event_arn
|
372
|
+
# The Amazon Resource Name (ARN) of the event.
|
373
|
+
# @return [String]
|
374
|
+
#
|
375
|
+
# @!attribute [rw] event_id
|
376
|
+
# The internally generated identifier of a specific network traffic
|
377
|
+
# impairment health event.
|
378
|
+
# @return [String]
|
379
|
+
#
|
380
|
+
# @!attribute [rw] started_at
|
381
|
+
# When a health event started.
|
382
|
+
# @return [Time]
|
383
|
+
#
|
384
|
+
# @!attribute [rw] ended_at
|
385
|
+
# The time when a health event ended. If the health event is still
|
386
|
+
# active, then the end time is not set.
|
387
|
+
# @return [Time]
|
388
|
+
#
|
389
|
+
# @!attribute [rw] created_at
|
390
|
+
# When the health event was created.
|
391
|
+
# @return [Time]
|
392
|
+
#
|
393
|
+
# @!attribute [rw] last_updated_at
|
394
|
+
# When the health event was last updated.
|
395
|
+
# @return [Time]
|
396
|
+
#
|
397
|
+
# @!attribute [rw] impacted_locations
|
398
|
+
# The locations impacted by the health event.
|
399
|
+
# @return [Array<Types::ImpactedLocation>]
|
400
|
+
#
|
401
|
+
# @!attribute [rw] status
|
402
|
+
# Health event list member.
|
403
|
+
# @return [String]
|
404
|
+
#
|
405
|
+
# @!attribute [rw] percent_of_total_traffic_impacted
|
406
|
+
# The impact on global traffic monitored by this monitor for this
|
407
|
+
# health event.
|
408
|
+
# @return [Float]
|
409
|
+
#
|
410
|
+
# @!attribute [rw] impact_type
|
411
|
+
# The type of impairment for a health event.
|
412
|
+
# @return [String]
|
413
|
+
#
|
414
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/HealthEvent AWS API Documentation
|
415
|
+
#
|
416
|
+
class HealthEvent < Struct.new(
|
417
|
+
:event_arn,
|
418
|
+
:event_id,
|
419
|
+
:started_at,
|
420
|
+
:ended_at,
|
421
|
+
:created_at,
|
422
|
+
:last_updated_at,
|
423
|
+
:impacted_locations,
|
424
|
+
:status,
|
425
|
+
:percent_of_total_traffic_impacted,
|
426
|
+
:impact_type)
|
427
|
+
SENSITIVE = []
|
428
|
+
include Aws::Structure
|
429
|
+
end
|
430
|
+
|
431
|
+
# Information about a location impacted by a health event in Amazon
|
432
|
+
# CloudWatch Internet Monitor.
|
433
|
+
#
|
434
|
+
# Geographic regions are hierarchically categorized into country,
|
435
|
+
# subdivision, metro and city geographic granularities. The geographic
|
436
|
+
# region is identified based on the IP address used at the client
|
437
|
+
# locations.
|
438
|
+
#
|
439
|
+
# @!attribute [rw] as_name
|
440
|
+
# The name of the network at an impacted location.
|
441
|
+
# @return [String]
|
442
|
+
#
|
443
|
+
# @!attribute [rw] as_number
|
444
|
+
# The Autonomous System Number (ASN) of the network at an impacted
|
445
|
+
# location.
|
446
|
+
# @return [Integer]
|
447
|
+
#
|
448
|
+
# @!attribute [rw] country
|
449
|
+
# The name of the country where the health event is located.
|
450
|
+
# @return [String]
|
451
|
+
#
|
452
|
+
# @!attribute [rw] subdivision
|
453
|
+
# The subdivision location where the health event is located. The
|
454
|
+
# subdivision usually maps to states in most countries (including the
|
455
|
+
# United States). For United Kingdom, it maps to a country (England,
|
456
|
+
# Scotland, Wales) or province (Northern Ireland).
|
457
|
+
# @return [String]
|
458
|
+
#
|
459
|
+
# @!attribute [rw] metro
|
460
|
+
# The metro area where the health event is located.
|
461
|
+
#
|
462
|
+
# Metro indicates a metropolitan region in the United States, such as
|
463
|
+
# the region around New York City. In non-US countries, this is a
|
464
|
+
# second-level subdivision. For example, in the United Kingdom, it
|
465
|
+
# could be a county, a London borough, a unitary authority, council
|
466
|
+
# area, and so on.
|
467
|
+
# @return [String]
|
468
|
+
#
|
469
|
+
# @!attribute [rw] city
|
470
|
+
# The name of the city where the health event is located.
|
471
|
+
# @return [String]
|
472
|
+
#
|
473
|
+
# @!attribute [rw] latitude
|
474
|
+
# The latitude where the health event is located.
|
475
|
+
# @return [Float]
|
476
|
+
#
|
477
|
+
# @!attribute [rw] longitude
|
478
|
+
# The longitude where the health event is located.
|
479
|
+
# @return [Float]
|
480
|
+
#
|
481
|
+
# @!attribute [rw] country_code
|
482
|
+
# The country code where the health event is located. The ISO 3166-2
|
483
|
+
# codes for the country is provided, when available.
|
484
|
+
# @return [String]
|
485
|
+
#
|
486
|
+
# @!attribute [rw] subdivision_code
|
487
|
+
# The subdivision code where the health event is located. The ISO
|
488
|
+
# 3166-2 codes for country subdivisions is provided, when available.
|
489
|
+
# @return [String]
|
490
|
+
#
|
491
|
+
# @!attribute [rw] service_location
|
492
|
+
# The service location where the health event is located.
|
493
|
+
# @return [String]
|
494
|
+
#
|
495
|
+
# @!attribute [rw] status
|
496
|
+
# The status of the health event at an impacted location.
|
497
|
+
# @return [String]
|
498
|
+
#
|
499
|
+
# @!attribute [rw] caused_by
|
500
|
+
# The cause of the impairment. There are two types of network
|
501
|
+
# impairments: Amazon Web Services network issues or internet issues.
|
502
|
+
# Internet issues are typically a problem with a network provider,
|
503
|
+
# like an internet service provider (ISP).
|
504
|
+
# @return [Types::NetworkImpairment]
|
505
|
+
#
|
506
|
+
# @!attribute [rw] internet_health
|
507
|
+
# The calculated health at a specific location.
|
508
|
+
# @return [Types::InternetHealth]
|
509
|
+
#
|
510
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/ImpactedLocation AWS API Documentation
|
511
|
+
#
|
512
|
+
class ImpactedLocation < Struct.new(
|
513
|
+
:as_name,
|
514
|
+
:as_number,
|
515
|
+
:country,
|
516
|
+
:subdivision,
|
517
|
+
:metro,
|
518
|
+
:city,
|
519
|
+
:latitude,
|
520
|
+
:longitude,
|
521
|
+
:country_code,
|
522
|
+
:subdivision_code,
|
523
|
+
:service_location,
|
524
|
+
:status,
|
525
|
+
:caused_by,
|
526
|
+
:internet_health)
|
527
|
+
SENSITIVE = []
|
528
|
+
include Aws::Structure
|
529
|
+
end
|
530
|
+
|
531
|
+
# There was an internal server error.
|
532
|
+
#
|
533
|
+
# @!attribute [rw] message
|
534
|
+
# @return [String]
|
535
|
+
#
|
536
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/InternalServerErrorException AWS API Documentation
|
537
|
+
#
|
538
|
+
class InternalServerErrorException < Struct.new(
|
539
|
+
:message)
|
540
|
+
SENSITIVE = []
|
541
|
+
include Aws::Structure
|
542
|
+
end
|
543
|
+
|
544
|
+
# An internal error occurred.
|
545
|
+
#
|
546
|
+
# @!attribute [rw] message
|
547
|
+
# @return [String]
|
548
|
+
#
|
549
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/InternalServerException AWS API Documentation
|
550
|
+
#
|
551
|
+
class InternalServerException < Struct.new(
|
552
|
+
:message)
|
553
|
+
SENSITIVE = []
|
554
|
+
include Aws::Structure
|
555
|
+
end
|
556
|
+
|
557
|
+
# Internet health includes measurements calculated by Amazon CloudWatch
|
558
|
+
# Internet Monitor about the performance and availability for your
|
559
|
+
# application on the internet. Amazon Web Services has substantial
|
560
|
+
# historical data about internet performance and availability between
|
561
|
+
# Amazon Web Services services and different network providers and
|
562
|
+
# geographies. By applying statistical analysis to the data, Internet
|
563
|
+
# Monitor can detect when the performance and availability for your
|
564
|
+
# application has dropped, compared to an estimated baseline that's
|
565
|
+
# already calculated. To make it easier to see those drops, we report
|
566
|
+
# that information to you in the form of health scores: a performance
|
567
|
+
# score and an availability score.
|
568
|
+
#
|
569
|
+
# @!attribute [rw] availability
|
570
|
+
# Availability in Internet Monitor represents the estimated percentage
|
571
|
+
# of traffic that is not seeing an availability drop. For example, an
|
572
|
+
# availability score of 99% for an end user and service location pair
|
573
|
+
# is equivalent to 1% of the traffic experiencing an availability drop
|
574
|
+
# for that pair.
|
575
|
+
#
|
576
|
+
# For more information, see [ How Internet Monitor calculates
|
577
|
+
# performance and availability scores][1] in the Amazon CloudWatch
|
578
|
+
# Internet Monitor section of the Amazon CloudWatch User Guide.
|
579
|
+
#
|
580
|
+
#
|
581
|
+
#
|
582
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores
|
583
|
+
# @return [Types::AvailabilityMeasurement]
|
584
|
+
#
|
585
|
+
# @!attribute [rw] performance
|
586
|
+
# Performance in Internet Monitor represents the estimated percentage
|
587
|
+
# of traffic that is not seeing a performance drop. For example, a
|
588
|
+
# performance score of 99% for an end user and service location pair
|
589
|
+
# is equivalent to 1% of the traffic experiencing a performance drop
|
590
|
+
# for that pair.
|
591
|
+
#
|
592
|
+
# For more information, see [ How Internet Monitor calculates
|
593
|
+
# performance and availability scores][1] in the Amazon CloudWatch
|
594
|
+
# Internet Monitor section of the Amazon CloudWatch User Guide.
|
595
|
+
#
|
596
|
+
#
|
597
|
+
#
|
598
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores
|
599
|
+
# @return [Types::PerformanceMeasurement]
|
600
|
+
#
|
601
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/InternetHealth AWS API Documentation
|
602
|
+
#
|
603
|
+
class InternetHealth < Struct.new(
|
604
|
+
:availability,
|
605
|
+
:performance)
|
606
|
+
SENSITIVE = []
|
607
|
+
include Aws::Structure
|
608
|
+
end
|
609
|
+
|
610
|
+
# The request exceeded a service quota.
|
611
|
+
#
|
612
|
+
# @!attribute [rw] message
|
613
|
+
# @return [String]
|
614
|
+
#
|
615
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/LimitExceededException AWS API Documentation
|
616
|
+
#
|
617
|
+
class LimitExceededException < Struct.new(
|
618
|
+
:message)
|
619
|
+
SENSITIVE = []
|
620
|
+
include Aws::Structure
|
621
|
+
end
|
622
|
+
|
623
|
+
# @!attribute [rw] monitor_name
|
624
|
+
# The name of the monitor.
|
625
|
+
# @return [String]
|
626
|
+
#
|
627
|
+
# @!attribute [rw] start_time
|
628
|
+
# The time when a health event started.
|
629
|
+
# @return [Time]
|
630
|
+
#
|
631
|
+
# @!attribute [rw] end_time
|
632
|
+
# The time when a health event ended. If the health event is still
|
633
|
+
# ongoing, then the end time is not set.
|
634
|
+
# @return [Time]
|
635
|
+
#
|
636
|
+
# @!attribute [rw] next_token
|
637
|
+
# The token for the next set of results. You receive this token from a
|
638
|
+
# previous call.
|
639
|
+
# @return [String]
|
640
|
+
#
|
641
|
+
# @!attribute [rw] max_results
|
642
|
+
# The number of health event objects that you want to return with this
|
643
|
+
# call.
|
644
|
+
# @return [Integer]
|
645
|
+
#
|
646
|
+
# @!attribute [rw] event_status
|
647
|
+
# The status of a health event.
|
648
|
+
# @return [String]
|
649
|
+
#
|
650
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/ListHealthEventsInput AWS API Documentation
|
651
|
+
#
|
652
|
+
class ListHealthEventsInput < Struct.new(
|
653
|
+
:monitor_name,
|
654
|
+
:start_time,
|
655
|
+
:end_time,
|
656
|
+
:next_token,
|
657
|
+
:max_results,
|
658
|
+
:event_status)
|
659
|
+
SENSITIVE = []
|
660
|
+
include Aws::Structure
|
661
|
+
end
|
662
|
+
|
663
|
+
# @!attribute [rw] health_events
|
664
|
+
# A list of health events.
|
665
|
+
# @return [Array<Types::HealthEvent>]
|
666
|
+
#
|
667
|
+
# @!attribute [rw] next_token
|
668
|
+
# The token for the next set of results. You receive this token from a
|
669
|
+
# previous call.
|
670
|
+
# @return [String]
|
671
|
+
#
|
672
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/ListHealthEventsOutput AWS API Documentation
|
673
|
+
#
|
674
|
+
class ListHealthEventsOutput < Struct.new(
|
675
|
+
:health_events,
|
676
|
+
:next_token)
|
677
|
+
SENSITIVE = []
|
678
|
+
include Aws::Structure
|
679
|
+
end
|
680
|
+
|
681
|
+
# @!attribute [rw] next_token
|
682
|
+
# The token for the next set of results. You receive this token from a
|
683
|
+
# previous call.
|
684
|
+
# @return [String]
|
685
|
+
#
|
686
|
+
# @!attribute [rw] max_results
|
687
|
+
# The number of monitor objects that you want to return with this
|
688
|
+
# call.
|
689
|
+
# @return [Integer]
|
690
|
+
#
|
691
|
+
# @!attribute [rw] monitor_status
|
692
|
+
# The status of a monitor. This includes the status of the data
|
693
|
+
# processing for the monitor and the status of the monitor itself.
|
694
|
+
#
|
695
|
+
# For information about the statuses for a monitor, see [ Monitor][1].
|
696
|
+
#
|
697
|
+
#
|
698
|
+
#
|
699
|
+
# [1]: https://docs.aws.amazon.com/internet-monitor/latest/api/API_Monitor.html
|
700
|
+
# @return [String]
|
701
|
+
#
|
702
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/ListMonitorsInput AWS API Documentation
|
703
|
+
#
|
704
|
+
class ListMonitorsInput < Struct.new(
|
705
|
+
:next_token,
|
706
|
+
:max_results,
|
707
|
+
:monitor_status)
|
708
|
+
SENSITIVE = []
|
709
|
+
include Aws::Structure
|
710
|
+
end
|
711
|
+
|
712
|
+
# @!attribute [rw] monitors
|
713
|
+
# A list of monitors.
|
714
|
+
# @return [Array<Types::Monitor>]
|
715
|
+
#
|
716
|
+
# @!attribute [rw] next_token
|
717
|
+
# The token for the next set of results. You receive this token from a
|
718
|
+
# previous call.
|
719
|
+
# @return [String]
|
720
|
+
#
|
721
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/ListMonitorsOutput AWS API Documentation
|
722
|
+
#
|
723
|
+
class ListMonitorsOutput < Struct.new(
|
724
|
+
:monitors,
|
725
|
+
:next_token)
|
726
|
+
SENSITIVE = []
|
727
|
+
include Aws::Structure
|
728
|
+
end
|
729
|
+
|
730
|
+
# @!attribute [rw] resource_arn
|
731
|
+
# The Amazon Resource Name (ARN) for a resource.
|
732
|
+
# @return [String]
|
733
|
+
#
|
734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/ListTagsForResourceInput AWS API Documentation
|
735
|
+
#
|
736
|
+
class ListTagsForResourceInput < Struct.new(
|
737
|
+
:resource_arn)
|
738
|
+
SENSITIVE = []
|
739
|
+
include Aws::Structure
|
740
|
+
end
|
741
|
+
|
742
|
+
# @!attribute [rw] tags
|
743
|
+
# Tags for a resource.
|
744
|
+
# @return [Hash<String,String>]
|
745
|
+
#
|
746
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/ListTagsForResourceOutput AWS API Documentation
|
747
|
+
#
|
748
|
+
class ListTagsForResourceOutput < Struct.new(
|
749
|
+
:tags)
|
750
|
+
SENSITIVE = []
|
751
|
+
include Aws::Structure
|
752
|
+
end
|
753
|
+
|
754
|
+
# The description of and information about a monitor in Amazon
|
755
|
+
# CloudWatch Internet Monitor.
|
756
|
+
#
|
757
|
+
# @!attribute [rw] monitor_name
|
758
|
+
# The name of the monitor.
|
759
|
+
# @return [String]
|
760
|
+
#
|
761
|
+
# @!attribute [rw] monitor_arn
|
762
|
+
# The Amazon Resource Name (ARN) of the monitor.
|
763
|
+
# @return [String]
|
764
|
+
#
|
765
|
+
# @!attribute [rw] status
|
766
|
+
# The status of a monitor.
|
767
|
+
# @return [String]
|
768
|
+
#
|
769
|
+
# @!attribute [rw] processing_status
|
770
|
+
# The health of data processing for the monitor.
|
771
|
+
# @return [String]
|
772
|
+
#
|
773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/Monitor AWS API Documentation
|
774
|
+
#
|
775
|
+
class Monitor < Struct.new(
|
776
|
+
:monitor_name,
|
777
|
+
:monitor_arn,
|
778
|
+
:status,
|
779
|
+
:processing_status)
|
780
|
+
SENSITIVE = []
|
781
|
+
include Aws::Structure
|
782
|
+
end
|
783
|
+
|
784
|
+
# An internet service provider (ISP) or network in Amazon CloudWatch
|
785
|
+
# Internet Monitor.
|
786
|
+
#
|
787
|
+
# @!attribute [rw] as_name
|
788
|
+
# The internet provider name or network name.
|
789
|
+
# @return [String]
|
790
|
+
#
|
791
|
+
# @!attribute [rw] as_number
|
792
|
+
# The Autonomous System Number (ASN) of the internet provider or
|
793
|
+
# network.
|
794
|
+
# @return [Integer]
|
795
|
+
#
|
796
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/Network AWS API Documentation
|
797
|
+
#
|
798
|
+
class Network < Struct.new(
|
799
|
+
:as_name,
|
800
|
+
:as_number)
|
801
|
+
SENSITIVE = []
|
802
|
+
include Aws::Structure
|
803
|
+
end
|
804
|
+
|
805
|
+
# Information about the network impairment for a specific network
|
806
|
+
# measured by Amazon CloudWatch Internet Monitor.
|
807
|
+
#
|
808
|
+
# @!attribute [rw] networks
|
809
|
+
# The networks that could be impacted by a network impairment event.
|
810
|
+
# @return [Array<Types::Network>]
|
811
|
+
#
|
812
|
+
# @!attribute [rw] as_path
|
813
|
+
# The combination of the Autonomous System Number (ASN) of the network
|
814
|
+
# and the name of the network.
|
815
|
+
# @return [Array<Types::Network>]
|
816
|
+
#
|
817
|
+
# @!attribute [rw] network_event_type
|
818
|
+
# Type of network impairment.
|
819
|
+
# @return [String]
|
820
|
+
#
|
821
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/NetworkImpairment AWS API Documentation
|
822
|
+
#
|
823
|
+
class NetworkImpairment < Struct.new(
|
824
|
+
:networks,
|
825
|
+
:as_path,
|
826
|
+
:network_event_type)
|
827
|
+
SENSITIVE = []
|
828
|
+
include Aws::Structure
|
829
|
+
end
|
830
|
+
|
831
|
+
# The request specifies something that doesn't exist.
|
832
|
+
#
|
833
|
+
# @!attribute [rw] message
|
834
|
+
# @return [String]
|
835
|
+
#
|
836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/NotFoundException AWS API Documentation
|
837
|
+
#
|
838
|
+
class NotFoundException < Struct.new(
|
839
|
+
:message)
|
840
|
+
SENSITIVE = []
|
841
|
+
include Aws::Structure
|
842
|
+
end
|
843
|
+
|
844
|
+
# Measurements about the performance for your application on the
|
845
|
+
# internet calculated by Amazon CloudWatch Internet Monitor. Amazon Web
|
846
|
+
# Services has substantial historical data about internet performance
|
847
|
+
# and availability between Amazon Web Services services and different
|
848
|
+
# network providers and geographies. By applying statistical analysis to
|
849
|
+
# the data, Internet Monitor can detect when the performance and
|
850
|
+
# availability for your application has dropped, compared to an
|
851
|
+
# estimated baseline that's already calculated. To make it easier to
|
852
|
+
# see those drops, we report that information to you in the form of
|
853
|
+
# health scores: a performance score and an availability score.
|
854
|
+
#
|
855
|
+
# Performance in Internet Monitor represents the estimated percentage of
|
856
|
+
# traffic that is not seeing a performance drop. For example, a
|
857
|
+
# performance score of 99% for an end user and service location pair is
|
858
|
+
# equivalent to 1% of the traffic experiencing a performance drop for
|
859
|
+
# that pair.
|
860
|
+
#
|
861
|
+
# For more information, see [ How Internet Monitor calculates
|
862
|
+
# performance and availability scores][1] in the Amazon CloudWatch
|
863
|
+
# Internet Monitor section of the Amazon CloudWatch User Guide.
|
864
|
+
#
|
865
|
+
#
|
866
|
+
#
|
867
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores
|
868
|
+
#
|
869
|
+
# @!attribute [rw] experience_score
|
870
|
+
# Experience scores, or health scores, are calculated for different
|
871
|
+
# geographic and network provider combinations (that is, different
|
872
|
+
# granularities) and also totaled into global scores. If you view
|
873
|
+
# performance or availability scores without filtering for any
|
874
|
+
# specific geography or service provider, Amazon CloudWatch Internet
|
875
|
+
# Monitor provides global health scores.
|
876
|
+
#
|
877
|
+
# The Amazon CloudWatch Internet Monitor chapter in the CloudWatch
|
878
|
+
# User Guide includes detailed information about how Internet Monitor
|
879
|
+
# calculates health scores, including performance and availability
|
880
|
+
# scores, and when it creates and resolves health events. For more
|
881
|
+
# information, see [ How Amazon Web Services calculates performance
|
882
|
+
# and availability scores][1] in the Amazon CloudWatch Internet
|
883
|
+
# Monitor section of the CloudWatch User Guide.
|
884
|
+
#
|
885
|
+
#
|
886
|
+
#
|
887
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores
|
888
|
+
# @return [Float]
|
889
|
+
#
|
890
|
+
# @!attribute [rw] percent_of_total_traffic_impacted
|
891
|
+
# How much performance impact was caused by a health event for total
|
892
|
+
# traffic globally. For performance, this is the percentage of how
|
893
|
+
# much latency increased during the event compared to typical
|
894
|
+
# performance for your application traffic globally.
|
895
|
+
#
|
896
|
+
# For more information, see [ When Amazon Web Services creates and
|
897
|
+
# resolves health events][1] in the Amazon CloudWatch Internet Monitor
|
898
|
+
# section of the CloudWatch User Guide.
|
899
|
+
#
|
900
|
+
#
|
901
|
+
#
|
902
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMHealthEventStartStop
|
903
|
+
# @return [Float]
|
904
|
+
#
|
905
|
+
# @!attribute [rw] percent_of_client_location_impacted
|
906
|
+
# How much performance impact was caused by a health event at a client
|
907
|
+
# location. For performance, this is the percentage of how much
|
908
|
+
# latency increased during the event compared to typical performance
|
909
|
+
# for traffic, from this client location to an Amazon Web Services
|
910
|
+
# location, using a specific client network.
|
911
|
+
#
|
912
|
+
# For more information, see [ When Amazon Web Services creates and
|
913
|
+
# resolves health events][1] in the Amazon CloudWatch Internet Monitor
|
914
|
+
# section of the CloudWatch User Guide.
|
915
|
+
#
|
916
|
+
#
|
917
|
+
#
|
918
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMHealthEventStartStop
|
919
|
+
# @return [Float]
|
920
|
+
#
|
921
|
+
# @!attribute [rw] round_trip_time
|
922
|
+
# This is the percentage of how much round-trip time increased during
|
923
|
+
# the event compared to typical round-trip time for your application
|
924
|
+
# for traffic.
|
925
|
+
#
|
926
|
+
# For more information, see [ When Amazon Web Services creates and
|
927
|
+
# resolves health events][1] in the Amazon CloudWatch Internet Monitor
|
928
|
+
# section of the CloudWatch User Guide.
|
929
|
+
#
|
930
|
+
#
|
931
|
+
#
|
932
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMHealthEventStartStop
|
933
|
+
# @return [Types::RoundTripTime]
|
934
|
+
#
|
935
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/PerformanceMeasurement AWS API Documentation
|
936
|
+
#
|
937
|
+
class PerformanceMeasurement < Struct.new(
|
938
|
+
:experience_score,
|
939
|
+
:percent_of_total_traffic_impacted,
|
940
|
+
:percent_of_client_location_impacted,
|
941
|
+
:round_trip_time)
|
942
|
+
SENSITIVE = []
|
943
|
+
include Aws::Structure
|
944
|
+
end
|
945
|
+
|
946
|
+
# The request specifies a resource that doesn't exist.
|
947
|
+
#
|
948
|
+
# @!attribute [rw] message
|
949
|
+
# @return [String]
|
950
|
+
#
|
951
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/ResourceNotFoundException AWS API Documentation
|
952
|
+
#
|
953
|
+
class ResourceNotFoundException < Struct.new(
|
954
|
+
:message)
|
955
|
+
SENSITIVE = []
|
956
|
+
include Aws::Structure
|
957
|
+
end
|
958
|
+
|
959
|
+
# Round-trip time (RTT) is how long it takes for a request from the user
|
960
|
+
# to return a response to the user. Amazon CloudWatch Internet Monitor
|
961
|
+
# calculates RTT at different percentiles: p50, p90, and p95.
|
962
|
+
#
|
963
|
+
# @!attribute [rw] p50
|
964
|
+
# RTT at the 50th percentile (p50).
|
965
|
+
# @return [Float]
|
966
|
+
#
|
967
|
+
# @!attribute [rw] p90
|
968
|
+
# RTT at the 90th percentile (p90).
|
969
|
+
# @return [Float]
|
970
|
+
#
|
971
|
+
# @!attribute [rw] p95
|
972
|
+
# RTT at the 95th percentile (p95).
|
973
|
+
# @return [Float]
|
974
|
+
#
|
975
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/RoundTripTime AWS API Documentation
|
976
|
+
#
|
977
|
+
class RoundTripTime < Struct.new(
|
978
|
+
:p50,
|
979
|
+
:p90,
|
980
|
+
:p95)
|
981
|
+
SENSITIVE = []
|
982
|
+
include Aws::Structure
|
983
|
+
end
|
984
|
+
|
985
|
+
# @!attribute [rw] resource_arn
|
986
|
+
# The Amazon Resource Name (ARN) for a tag that you add to a resource.
|
987
|
+
# Tags are supported only for monitors in Amazon CloudWatch Internet
|
988
|
+
# Monitor.
|
989
|
+
# @return [String]
|
990
|
+
#
|
991
|
+
# @!attribute [rw] tags
|
992
|
+
# Tags that you add to a resource. You can add a maximum of 50 tags in
|
993
|
+
# Internet Monitor.
|
994
|
+
# @return [Hash<String,String>]
|
995
|
+
#
|
996
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/TagResourceInput AWS API Documentation
|
997
|
+
#
|
998
|
+
class TagResourceInput < Struct.new(
|
999
|
+
:resource_arn,
|
1000
|
+
:tags)
|
1001
|
+
SENSITIVE = []
|
1002
|
+
include Aws::Structure
|
1003
|
+
end
|
1004
|
+
|
1005
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/TagResourceOutput AWS API Documentation
|
1006
|
+
#
|
1007
|
+
class TagResourceOutput < Aws::EmptyStructure; end
|
1008
|
+
|
1009
|
+
# The request was denied due to request throttling.
|
1010
|
+
#
|
1011
|
+
# @!attribute [rw] message
|
1012
|
+
# @return [String]
|
1013
|
+
#
|
1014
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/ThrottlingException AWS API Documentation
|
1015
|
+
#
|
1016
|
+
class ThrottlingException < Struct.new(
|
1017
|
+
:message)
|
1018
|
+
SENSITIVE = []
|
1019
|
+
include Aws::Structure
|
1020
|
+
end
|
1021
|
+
|
1022
|
+
# There were too many requests.
|
1023
|
+
#
|
1024
|
+
# @!attribute [rw] message
|
1025
|
+
# @return [String]
|
1026
|
+
#
|
1027
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/TooManyRequestsException AWS API Documentation
|
1028
|
+
#
|
1029
|
+
class TooManyRequestsException < Struct.new(
|
1030
|
+
:message)
|
1031
|
+
SENSITIVE = []
|
1032
|
+
include Aws::Structure
|
1033
|
+
end
|
1034
|
+
|
1035
|
+
# @!attribute [rw] resource_arn
|
1036
|
+
# The Amazon Resource Name (ARN) for a tag you remove a resource from.
|
1037
|
+
# @return [String]
|
1038
|
+
#
|
1039
|
+
# @!attribute [rw] tag_keys
|
1040
|
+
# Tag keys that you remove from a resource.
|
1041
|
+
# @return [Array<String>]
|
1042
|
+
#
|
1043
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/UntagResourceInput AWS API Documentation
|
1044
|
+
#
|
1045
|
+
class UntagResourceInput < Struct.new(
|
1046
|
+
:resource_arn,
|
1047
|
+
:tag_keys)
|
1048
|
+
SENSITIVE = []
|
1049
|
+
include Aws::Structure
|
1050
|
+
end
|
1051
|
+
|
1052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/UntagResourceOutput AWS API Documentation
|
1053
|
+
#
|
1054
|
+
class UntagResourceOutput < Aws::EmptyStructure; end
|
1055
|
+
|
1056
|
+
# @!attribute [rw] monitor_name
|
1057
|
+
# The name of the monitor.
|
1058
|
+
# @return [String]
|
1059
|
+
#
|
1060
|
+
# @!attribute [rw] resources_to_add
|
1061
|
+
# The resources to include in a monitor, which you provide as a set of
|
1062
|
+
# Amazon Resource Names (ARNs).
|
1063
|
+
#
|
1064
|
+
# You can add a combination of Amazon Virtual Private Clouds (VPCs)
|
1065
|
+
# and Amazon CloudFront distributions, or you can add Amazon
|
1066
|
+
# WorkSpaces directories. You can't add all three types of resources.
|
1067
|
+
#
|
1068
|
+
# <note markdown="1"> If you add only VPC resources, at least one VPC must have an
|
1069
|
+
# Internet Gateway attached to it, to make sure that it has internet
|
1070
|
+
# connectivity.
|
1071
|
+
#
|
1072
|
+
# </note>
|
1073
|
+
# @return [Array<String>]
|
1074
|
+
#
|
1075
|
+
# @!attribute [rw] resources_to_remove
|
1076
|
+
# The resources to remove from a monitor, which you provide as a set
|
1077
|
+
# of Amazon Resource Names (ARNs).
|
1078
|
+
# @return [Array<String>]
|
1079
|
+
#
|
1080
|
+
# @!attribute [rw] status
|
1081
|
+
# The status for a monitor. The accepted values for `Status` with the
|
1082
|
+
# `UpdateMonitor` API call are the following: `ACTIVE` and `INACTIVE`.
|
1083
|
+
# The following values are *not* accepted: `PENDING`, and `ERROR`.
|
1084
|
+
# @return [String]
|
1085
|
+
#
|
1086
|
+
# @!attribute [rw] client_token
|
1087
|
+
# A unique, case-sensitive string of up to 64 ASCII characters that
|
1088
|
+
# you specify to make an idempotent API request. You should not reuse
|
1089
|
+
# the same client token for other API requests.
|
1090
|
+
#
|
1091
|
+
# **A suitable default value is auto-generated.** You should normally
|
1092
|
+
# not need to pass this option.
|
1093
|
+
# @return [String]
|
1094
|
+
#
|
1095
|
+
# @!attribute [rw] max_city_networks_to_monitor
|
1096
|
+
# The maximum number of city-network combinations (that is,
|
1097
|
+
# combinations of a city location and network, such as an ISP) to be
|
1098
|
+
# monitored for your resources.
|
1099
|
+
# @return [Integer]
|
1100
|
+
#
|
1101
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/UpdateMonitorInput AWS API Documentation
|
1102
|
+
#
|
1103
|
+
class UpdateMonitorInput < Struct.new(
|
1104
|
+
:monitor_name,
|
1105
|
+
:resources_to_add,
|
1106
|
+
:resources_to_remove,
|
1107
|
+
:status,
|
1108
|
+
:client_token,
|
1109
|
+
:max_city_networks_to_monitor)
|
1110
|
+
SENSITIVE = []
|
1111
|
+
include Aws::Structure
|
1112
|
+
end
|
1113
|
+
|
1114
|
+
# @!attribute [rw] monitor_arn
|
1115
|
+
# The Amazon Resource Name (ARN) of the monitor.
|
1116
|
+
# @return [String]
|
1117
|
+
#
|
1118
|
+
# @!attribute [rw] status
|
1119
|
+
# The status of a monitor.
|
1120
|
+
# @return [String]
|
1121
|
+
#
|
1122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/UpdateMonitorOutput AWS API Documentation
|
1123
|
+
#
|
1124
|
+
class UpdateMonitorOutput < Struct.new(
|
1125
|
+
:monitor_arn,
|
1126
|
+
:status)
|
1127
|
+
SENSITIVE = []
|
1128
|
+
include Aws::Structure
|
1129
|
+
end
|
1130
|
+
|
1131
|
+
# Invalid request.
|
1132
|
+
#
|
1133
|
+
# @!attribute [rw] message
|
1134
|
+
# @return [String]
|
1135
|
+
#
|
1136
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/ValidationException AWS API Documentation
|
1137
|
+
#
|
1138
|
+
class ValidationException < Struct.new(
|
1139
|
+
:message)
|
1140
|
+
SENSITIVE = []
|
1141
|
+
include Aws::Structure
|
1142
|
+
end
|
1143
|
+
|
1144
|
+
end
|
1145
|
+
end
|