aws-sdk-networkmonitor 1.0.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.
@@ -0,0 +1,965 @@
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::NetworkMonitor
11
+ module Types
12
+
13
+ # You do not have sufficient access to perform this action.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # This operation attempted to create a resource that already exists.
27
+ #
28
+ # @!attribute [rw] message
29
+ # @return [String]
30
+ #
31
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/ConflictException AWS API Documentation
32
+ #
33
+ class ConflictException < Struct.new(
34
+ :message)
35
+ SENSITIVE = []
36
+ include Aws::Structure
37
+ end
38
+
39
+ # @!attribute [rw] monitor_name
40
+ # The name identifying the monitor. It can contain only letters,
41
+ # underscores (\_), or dashes (-), and can be up to 255 characters.
42
+ # @return [String]
43
+ #
44
+ # @!attribute [rw] probes
45
+ # Displays a list of all of the probes created for a monitor.
46
+ # @return [Array<Types::CreateMonitorProbeInput>]
47
+ #
48
+ # @!attribute [rw] aggregation_period
49
+ # The time, in seconds, that metrics are aggregated and sent to Amazon
50
+ # CloudWatch. Valid values are either `30` or `60`.
51
+ # @return [Integer]
52
+ #
53
+ # @!attribute [rw] client_token
54
+ # Unique, case-sensitive identifier to ensure the idempotency of the
55
+ # request. Only returned if a client token was provided in the
56
+ # request.
57
+ #
58
+ # **A suitable default value is auto-generated.** You should normally
59
+ # not need to pass this option.
60
+ # @return [String]
61
+ #
62
+ # @!attribute [rw] tags
63
+ # The list of key-value pairs created and assigned to the monitor.
64
+ # @return [Hash<String,String>]
65
+ #
66
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/CreateMonitorInput AWS API Documentation
67
+ #
68
+ class CreateMonitorInput < Struct.new(
69
+ :monitor_name,
70
+ :probes,
71
+ :aggregation_period,
72
+ :client_token,
73
+ :tags)
74
+ SENSITIVE = []
75
+ include Aws::Structure
76
+ end
77
+
78
+ # @!attribute [rw] monitor_arn
79
+ # The ARN of the monitor.
80
+ # @return [String]
81
+ #
82
+ # @!attribute [rw] monitor_name
83
+ # The name of the monitor.
84
+ # @return [String]
85
+ #
86
+ # @!attribute [rw] state
87
+ # The state of the monitor.
88
+ # @return [String]
89
+ #
90
+ # @!attribute [rw] aggregation_period
91
+ # The number of seconds that metrics are aggregated by and sent to
92
+ # Amazon CloudWatch. This will be either `30` or `60`.
93
+ # @return [Integer]
94
+ #
95
+ # @!attribute [rw] tags
96
+ # The list of key-value pairs assigned to the monitor.
97
+ # @return [Hash<String,String>]
98
+ #
99
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/CreateMonitorOutput AWS API Documentation
100
+ #
101
+ class CreateMonitorOutput < Struct.new(
102
+ :monitor_arn,
103
+ :monitor_name,
104
+ :state,
105
+ :aggregation_period,
106
+ :tags)
107
+ SENSITIVE = []
108
+ include Aws::Structure
109
+ end
110
+
111
+ # Creates a monitor probe.
112
+ #
113
+ # @!attribute [rw] source_arn
114
+ # The ARN of the subnet.
115
+ # @return [String]
116
+ #
117
+ # @!attribute [rw] destination
118
+ # The destination IP address. This will be either `IPV4` or `IPV6`.
119
+ # @return [String]
120
+ #
121
+ # @!attribute [rw] destination_port
122
+ # The port associated with the `destination`. This is required only if
123
+ # the `protocol` is `TCP` and must be a number between `1` and
124
+ # `65536`.
125
+ # @return [Integer]
126
+ #
127
+ # @!attribute [rw] protocol
128
+ # The protocol used for the network traffic between the `source` and
129
+ # `destination`. This will be either `TCP` or `ICMP`.
130
+ # @return [String]
131
+ #
132
+ # @!attribute [rw] packet_size
133
+ # The size of the packets sent between the source and destination.
134
+ # This will be a number between `56` and `8500`.
135
+ # @return [Integer]
136
+ #
137
+ # @!attribute [rw] probe_tags
138
+ # The list of key-value pairs created and assigned to the monitor.
139
+ # @return [Hash<String,String>]
140
+ #
141
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/CreateMonitorProbeInput AWS API Documentation
142
+ #
143
+ class CreateMonitorProbeInput < Struct.new(
144
+ :source_arn,
145
+ :destination,
146
+ :destination_port,
147
+ :protocol,
148
+ :packet_size,
149
+ :probe_tags)
150
+ SENSITIVE = []
151
+ include Aws::Structure
152
+ end
153
+
154
+ # @!attribute [rw] monitor_name
155
+ # The name of the monitor to associated with the probe. To get a list
156
+ # of available monitors, use `ListMonitors`.
157
+ # @return [String]
158
+ #
159
+ # @!attribute [rw] probe
160
+ # Describes the details of an individual probe for a monitor.
161
+ # @return [Types::ProbeInput]
162
+ #
163
+ # @!attribute [rw] client_token
164
+ # Unique, case-sensitive identifier to ensure the idempotency of the
165
+ # request. Only returned if a client token was provided in the
166
+ # request.
167
+ #
168
+ # **A suitable default value is auto-generated.** You should normally
169
+ # not need to pass this option.
170
+ # @return [String]
171
+ #
172
+ # @!attribute [rw] tags
173
+ # The list of key-value pairs created and assigned to the probe.
174
+ # @return [Hash<String,String>]
175
+ #
176
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/CreateProbeInput AWS API Documentation
177
+ #
178
+ class CreateProbeInput < Struct.new(
179
+ :monitor_name,
180
+ :probe,
181
+ :client_token,
182
+ :tags)
183
+ SENSITIVE = []
184
+ include Aws::Structure
185
+ end
186
+
187
+ # @!attribute [rw] probe_id
188
+ # The ID of the probe for which details are returned.
189
+ # @return [String]
190
+ #
191
+ # @!attribute [rw] probe_arn
192
+ # The ARN of the probe.
193
+ # @return [String]
194
+ #
195
+ # @!attribute [rw] source_arn
196
+ # The ARN of the probe.
197
+ # @return [String]
198
+ #
199
+ # @!attribute [rw] destination
200
+ # The destination IP address for the monitor. This will be either an
201
+ # IPv4 or IPv6 address.
202
+ # @return [String]
203
+ #
204
+ # @!attribute [rw] destination_port
205
+ # The port associated with the `destination`. This is required only if
206
+ # the `protocol` is `TCP` and must be a number between `1` and
207
+ # `65536`.
208
+ # @return [Integer]
209
+ #
210
+ # @!attribute [rw] protocol
211
+ # The protocol used for the network traffic between the `source` and
212
+ # `destination`. This will be either `TCP` or `ICMP`.
213
+ # @return [String]
214
+ #
215
+ # @!attribute [rw] packet_size
216
+ # The size of the packets sent between the source and destination.
217
+ # This will be a number between `56` and `8500`.
218
+ # @return [Integer]
219
+ #
220
+ # @!attribute [rw] address_family
221
+ # Indicates whether the IP address is `IPV4` or `IPV6`.
222
+ # @return [String]
223
+ #
224
+ # @!attribute [rw] vpc_id
225
+ # The ID of the source VPC or subnet.
226
+ # @return [String]
227
+ #
228
+ # @!attribute [rw] state
229
+ # The state of the probe.
230
+ # @return [String]
231
+ #
232
+ # @!attribute [rw] created_at
233
+ # The time and date that the probe was created.
234
+ # @return [Time]
235
+ #
236
+ # @!attribute [rw] modified_at
237
+ # The time and date when the probe was last modified.
238
+ # @return [Time]
239
+ #
240
+ # @!attribute [rw] tags
241
+ # The list of key-value pairs assigned to the probe.
242
+ # @return [Hash<String,String>]
243
+ #
244
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/CreateProbeOutput AWS API Documentation
245
+ #
246
+ class CreateProbeOutput < Struct.new(
247
+ :probe_id,
248
+ :probe_arn,
249
+ :source_arn,
250
+ :destination,
251
+ :destination_port,
252
+ :protocol,
253
+ :packet_size,
254
+ :address_family,
255
+ :vpc_id,
256
+ :state,
257
+ :created_at,
258
+ :modified_at,
259
+ :tags)
260
+ SENSITIVE = []
261
+ include Aws::Structure
262
+ end
263
+
264
+ # @!attribute [rw] monitor_name
265
+ # The name of the monitor to delete. Use the `ListMonitors` action to
266
+ # get a list of your current monitors.
267
+ # @return [String]
268
+ #
269
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/DeleteMonitorInput AWS API Documentation
270
+ #
271
+ class DeleteMonitorInput < Struct.new(
272
+ :monitor_name)
273
+ SENSITIVE = []
274
+ include Aws::Structure
275
+ end
276
+
277
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/DeleteMonitorOutput AWS API Documentation
278
+ #
279
+ class DeleteMonitorOutput < Aws::EmptyStructure; end
280
+
281
+ # @!attribute [rw] monitor_name
282
+ # The name of the monitor to delete. For a list of the available
283
+ # monitors, use the `ListMonitors` action.
284
+ # @return [String]
285
+ #
286
+ # @!attribute [rw] probe_id
287
+ # The ID of the probe to delete. Run `GetMonitor` to get a lst of all
288
+ # probes and probe IDs associated with the monitor.
289
+ # @return [String]
290
+ #
291
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/DeleteProbeInput AWS API Documentation
292
+ #
293
+ class DeleteProbeInput < Struct.new(
294
+ :monitor_name,
295
+ :probe_id)
296
+ SENSITIVE = []
297
+ include Aws::Structure
298
+ end
299
+
300
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/DeleteProbeOutput AWS API Documentation
301
+ #
302
+ class DeleteProbeOutput < Aws::EmptyStructure; end
303
+
304
+ # @!attribute [rw] monitor_name
305
+ # The name of the monitor that details are returned for.
306
+ # @return [String]
307
+ #
308
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/GetMonitorInput AWS API Documentation
309
+ #
310
+ class GetMonitorInput < Struct.new(
311
+ :monitor_name)
312
+ SENSITIVE = []
313
+ include Aws::Structure
314
+ end
315
+
316
+ # @!attribute [rw] monitor_arn
317
+ # The ARN of the selected monitor.
318
+ # @return [String]
319
+ #
320
+ # @!attribute [rw] monitor_name
321
+ # The name of the monitor. To get a list of the current monitors and
322
+ # their names, use the `ListMonitors` action.
323
+ # @return [String]
324
+ #
325
+ # @!attribute [rw] state
326
+ # Returns a list of the state of each monitor.
327
+ # @return [String]
328
+ #
329
+ # @!attribute [rw] aggregation_period
330
+ # The aggregation period for the specified monitor.
331
+ # @return [Integer]
332
+ #
333
+ # @!attribute [rw] tags
334
+ # The list of key-value pairs assigned to the monitor.
335
+ # @return [Hash<String,String>]
336
+ #
337
+ # @!attribute [rw] probes
338
+ # The details about each probe associated with that monitor.
339
+ # @return [Array<Types::Probe>]
340
+ #
341
+ # @!attribute [rw] created_at
342
+ # The time and date when the monitor was created.
343
+ # @return [Time]
344
+ #
345
+ # @!attribute [rw] modified_at
346
+ # The time and date when the monitor was last modified.
347
+ # @return [Time]
348
+ #
349
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/GetMonitorOutput AWS API Documentation
350
+ #
351
+ class GetMonitorOutput < Struct.new(
352
+ :monitor_arn,
353
+ :monitor_name,
354
+ :state,
355
+ :aggregation_period,
356
+ :tags,
357
+ :probes,
358
+ :created_at,
359
+ :modified_at)
360
+ SENSITIVE = []
361
+ include Aws::Structure
362
+ end
363
+
364
+ # @!attribute [rw] monitor_name
365
+ # The name of the monitor associated with the probe. Run
366
+ # `ListMonitors` to get a list of monitor names.
367
+ # @return [String]
368
+ #
369
+ # @!attribute [rw] probe_id
370
+ # The ID of the probe to get information about. Run `GetMonitor`
371
+ # action to get a list of probes and probe IDs for the monitor.
372
+ # @return [String]
373
+ #
374
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/GetProbeInput AWS API Documentation
375
+ #
376
+ class GetProbeInput < Struct.new(
377
+ :monitor_name,
378
+ :probe_id)
379
+ SENSITIVE = []
380
+ include Aws::Structure
381
+ end
382
+
383
+ # @!attribute [rw] probe_id
384
+ # The ID of the probe for which details are returned.
385
+ # @return [String]
386
+ #
387
+ # @!attribute [rw] probe_arn
388
+ # The ARN of the probe.
389
+ # @return [String]
390
+ #
391
+ # @!attribute [rw] source_arn
392
+ # The ARN of the probe.
393
+ # @return [String]
394
+ #
395
+ # @!attribute [rw] destination
396
+ # The destination IP address for the monitor. This will be either an
397
+ # IPv4 or IPv6 address.
398
+ # @return [String]
399
+ #
400
+ # @!attribute [rw] destination_port
401
+ # The port associated with the `destination`. This is required only if
402
+ # the `protocol` is `TCP` and must be a number between `1` and
403
+ # `65536`.
404
+ # @return [Integer]
405
+ #
406
+ # @!attribute [rw] protocol
407
+ # The protocol used for the network traffic between the `source` and
408
+ # `destination`. This will be either `TCP` or `ICMP`.
409
+ # @return [String]
410
+ #
411
+ # @!attribute [rw] packet_size
412
+ # The size of the packets sent between the source and destination.
413
+ # This will be a number between `56` and `8500`.
414
+ # @return [Integer]
415
+ #
416
+ # @!attribute [rw] address_family
417
+ # Indicates whether the IP address is `IPV4` or `IPV6`.
418
+ # @return [String]
419
+ #
420
+ # @!attribute [rw] vpc_id
421
+ # The ID of the source VPC or subnet.
422
+ # @return [String]
423
+ #
424
+ # @!attribute [rw] state
425
+ # The state of the probe.
426
+ # @return [String]
427
+ #
428
+ # @!attribute [rw] created_at
429
+ # The time and date that the probe was created.
430
+ # @return [Time]
431
+ #
432
+ # @!attribute [rw] modified_at
433
+ # The time and date that the probe was last modified.
434
+ # @return [Time]
435
+ #
436
+ # @!attribute [rw] tags
437
+ # The list of key-value pairs assigned to the probe.
438
+ # @return [Hash<String,String>]
439
+ #
440
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/GetProbeOutput AWS API Documentation
441
+ #
442
+ class GetProbeOutput < Struct.new(
443
+ :probe_id,
444
+ :probe_arn,
445
+ :source_arn,
446
+ :destination,
447
+ :destination_port,
448
+ :protocol,
449
+ :packet_size,
450
+ :address_family,
451
+ :vpc_id,
452
+ :state,
453
+ :created_at,
454
+ :modified_at,
455
+ :tags)
456
+ SENSITIVE = []
457
+ include Aws::Structure
458
+ end
459
+
460
+ # The request processing has failed because of an unknown error,
461
+ # exception or failure.
462
+ #
463
+ # @!attribute [rw] message
464
+ # @return [String]
465
+ #
466
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/InternalServerException AWS API Documentation
467
+ #
468
+ class InternalServerException < Struct.new(
469
+ :message)
470
+ SENSITIVE = []
471
+ include Aws::Structure
472
+ end
473
+
474
+ # @!attribute [rw] next_token
475
+ # The token for the next page of results.
476
+ # @return [String]
477
+ #
478
+ # @!attribute [rw] max_results
479
+ # The maximum number of results to return with a single call. To
480
+ # retrieve the remaining results, make another call with the returned
481
+ # `nextToken` value.
482
+ #
483
+ # If `MaxResults` is given a value larger than 100, only 100 results
484
+ # are returned.
485
+ # @return [Integer]
486
+ #
487
+ # @!attribute [rw] state
488
+ # The list of all monitors and their states.
489
+ # @return [String]
490
+ #
491
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/ListMonitorsInput AWS API Documentation
492
+ #
493
+ class ListMonitorsInput < Struct.new(
494
+ :next_token,
495
+ :max_results,
496
+ :state)
497
+ SENSITIVE = []
498
+ include Aws::Structure
499
+ end
500
+
501
+ # @!attribute [rw] monitors
502
+ # Lists individual details about each of your monitors.
503
+ # @return [Array<Types::MonitorSummary>]
504
+ #
505
+ # @!attribute [rw] next_token
506
+ # The token for the next page of results.
507
+ # @return [String]
508
+ #
509
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/ListMonitorsOutput AWS API Documentation
510
+ #
511
+ class ListMonitorsOutput < Struct.new(
512
+ :monitors,
513
+ :next_token)
514
+ SENSITIVE = []
515
+ include Aws::Structure
516
+ end
517
+
518
+ # @!attribute [rw] resource_arn
519
+ # The
520
+ # @return [String]
521
+ #
522
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/ListTagsForResourceInput AWS API Documentation
523
+ #
524
+ class ListTagsForResourceInput < Struct.new(
525
+ :resource_arn)
526
+ SENSITIVE = []
527
+ include Aws::Structure
528
+ end
529
+
530
+ # @!attribute [rw] tags
531
+ # Lists the tags assigned to the resource.
532
+ # @return [Hash<String,String>]
533
+ #
534
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/ListTagsForResourceOutput AWS API Documentation
535
+ #
536
+ class ListTagsForResourceOutput < Struct.new(
537
+ :tags)
538
+ SENSITIVE = []
539
+ include Aws::Structure
540
+ end
541
+
542
+ # Displays summary information about a monitor.
543
+ #
544
+ # @!attribute [rw] monitor_arn
545
+ # The ARN of the monitor.
546
+ # @return [String]
547
+ #
548
+ # @!attribute [rw] monitor_name
549
+ # The name of the monitor.
550
+ # @return [String]
551
+ #
552
+ # @!attribute [rw] state
553
+ # The state of the monitor.
554
+ # @return [String]
555
+ #
556
+ # @!attribute [rw] aggregation_period
557
+ # The time, in seconds, that metrics are collected and sent to Amazon
558
+ # CloudWatch. Valid values are either `30` or `60`.
559
+ # @return [Integer]
560
+ #
561
+ # @!attribute [rw] tags
562
+ # The list of key-value pairs assigned to the monitor.
563
+ # @return [Hash<String,String>]
564
+ #
565
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/MonitorSummary AWS API Documentation
566
+ #
567
+ class MonitorSummary < Struct.new(
568
+ :monitor_arn,
569
+ :monitor_name,
570
+ :state,
571
+ :aggregation_period,
572
+ :tags)
573
+ SENSITIVE = []
574
+ include Aws::Structure
575
+ end
576
+
577
+ # Describes information about a monitor probe.
578
+ #
579
+ # @!attribute [rw] probe_id
580
+ # The ID of the probe.
581
+ # @return [String]
582
+ #
583
+ # @!attribute [rw] probe_arn
584
+ # The ARN of the probe.
585
+ # @return [String]
586
+ #
587
+ # @!attribute [rw] source_arn
588
+ # The ARN of the probe source subnet.
589
+ # @return [String]
590
+ #
591
+ # @!attribute [rw] destination
592
+ # The destination for the probe. This should be either an `IPV4` or
593
+ # `IPV6`.
594
+ # @return [String]
595
+ #
596
+ # @!attribute [rw] destination_port
597
+ # The destination port for the probe. This is required only if the
598
+ # `protocol` is `TCP` and must be a number between `1` and `65536`.
599
+ # @return [Integer]
600
+ #
601
+ # @!attribute [rw] protocol
602
+ # The network protocol for the destination. This can be either `TCP`
603
+ # or `ICMP`. If the protocol is `TCP`, then `port` is also required.
604
+ # @return [String]
605
+ #
606
+ # @!attribute [rw] packet_size
607
+ # The size of the packets traveling between the `source` and
608
+ # `destination`. This must be a number between `56` and
609
+ # @return [Integer]
610
+ #
611
+ # @!attribute [rw] address_family
612
+ # The IPv4 or IPv6 address for the probe.
613
+ # @return [String]
614
+ #
615
+ # @!attribute [rw] vpc_id
616
+ # The ID of the source VPC subnet.
617
+ # @return [String]
618
+ #
619
+ # @!attribute [rw] state
620
+ # The state of the probe.
621
+ # @return [String]
622
+ #
623
+ # @!attribute [rw] created_at
624
+ # The time and date the probe was created.
625
+ # @return [Time]
626
+ #
627
+ # @!attribute [rw] modified_at
628
+ # The time and date that the probe was last modified.
629
+ # @return [Time]
630
+ #
631
+ # @!attribute [rw] tags
632
+ # The list of key-value pairs created and assigned to the probe.
633
+ # @return [Hash<String,String>]
634
+ #
635
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/Probe AWS API Documentation
636
+ #
637
+ class Probe < Struct.new(
638
+ :probe_id,
639
+ :probe_arn,
640
+ :source_arn,
641
+ :destination,
642
+ :destination_port,
643
+ :protocol,
644
+ :packet_size,
645
+ :address_family,
646
+ :vpc_id,
647
+ :state,
648
+ :created_at,
649
+ :modified_at,
650
+ :tags)
651
+ SENSITIVE = []
652
+ include Aws::Structure
653
+ end
654
+
655
+ # Defines a probe when creating a probe or monitor.
656
+ #
657
+ # @!attribute [rw] source_arn
658
+ # The ARN of the subnet.
659
+ # @return [String]
660
+ #
661
+ # @!attribute [rw] destination
662
+ # The destination IP address. This will be either `IPV4` or `IPV6`.
663
+ # @return [String]
664
+ #
665
+ # @!attribute [rw] destination_port
666
+ # The port associated with the `destination`. This is required only if
667
+ # the `protocol` is `TCP` and must be a number between `1` and
668
+ # `65536`.
669
+ # @return [Integer]
670
+ #
671
+ # @!attribute [rw] protocol
672
+ # The protocol used for the network traffic between the `source` and
673
+ # `destination`. This will be either `TCP` or `ICMP`.
674
+ # @return [String]
675
+ #
676
+ # @!attribute [rw] packet_size
677
+ # The size of the packets sent between the source and destination.
678
+ # This will be a number between `56` and `8500`.
679
+ # @return [Integer]
680
+ #
681
+ # @!attribute [rw] tags
682
+ # The list of key-value pairs created and assigned to the monitor.
683
+ # @return [Hash<String,String>]
684
+ #
685
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/ProbeInput AWS API Documentation
686
+ #
687
+ class ProbeInput < Struct.new(
688
+ :source_arn,
689
+ :destination,
690
+ :destination_port,
691
+ :protocol,
692
+ :packet_size,
693
+ :tags)
694
+ SENSITIVE = []
695
+ include Aws::Structure
696
+ end
697
+
698
+ # The specified resource does not exist.
699
+ #
700
+ # @!attribute [rw] message
701
+ # @return [String]
702
+ #
703
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/ResourceNotFoundException AWS API Documentation
704
+ #
705
+ class ResourceNotFoundException < Struct.new(
706
+ :message)
707
+ SENSITIVE = []
708
+ include Aws::Structure
709
+ end
710
+
711
+ # This request exceeds a service quota.
712
+ #
713
+ # @!attribute [rw] message
714
+ # @return [String]
715
+ #
716
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/ServiceQuotaExceededException AWS API Documentation
717
+ #
718
+ class ServiceQuotaExceededException < Struct.new(
719
+ :message)
720
+ SENSITIVE = []
721
+ include Aws::Structure
722
+ end
723
+
724
+ # @!attribute [rw] resource_arn
725
+ # The ARN of the monitor or probe to tag.
726
+ # @return [String]
727
+ #
728
+ # @!attribute [rw] tags
729
+ # The list of key-value pairs assigned to the monitor or probe.
730
+ # @return [Hash<String,String>]
731
+ #
732
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/TagResourceInput AWS API Documentation
733
+ #
734
+ class TagResourceInput < Struct.new(
735
+ :resource_arn,
736
+ :tags)
737
+ SENSITIVE = []
738
+ include Aws::Structure
739
+ end
740
+
741
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/TagResourceOutput AWS API Documentation
742
+ #
743
+ class TagResourceOutput < Aws::EmptyStructure; end
744
+
745
+ # The request was denied due to request throttling
746
+ #
747
+ # @!attribute [rw] message
748
+ # @return [String]
749
+ #
750
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/ThrottlingException AWS API Documentation
751
+ #
752
+ class ThrottlingException < Struct.new(
753
+ :message)
754
+ SENSITIVE = []
755
+ include Aws::Structure
756
+ end
757
+
758
+ # @!attribute [rw] resource_arn
759
+ # The ARN of the monitor or probe that the tag should be removed from.
760
+ # @return [String]
761
+ #
762
+ # @!attribute [rw] tag_keys
763
+ # The key-value pa
764
+ # @return [Array<String>]
765
+ #
766
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/UntagResourceInput AWS API Documentation
767
+ #
768
+ class UntagResourceInput < Struct.new(
769
+ :resource_arn,
770
+ :tag_keys)
771
+ SENSITIVE = []
772
+ include Aws::Structure
773
+ end
774
+
775
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/UntagResourceOutput AWS API Documentation
776
+ #
777
+ class UntagResourceOutput < Aws::EmptyStructure; end
778
+
779
+ # @!attribute [rw] monitor_name
780
+ # The name of the monitor to update. Run `ListMonitors` to get a list
781
+ # of monitor names.
782
+ # @return [String]
783
+ #
784
+ # @!attribute [rw] aggregation_period
785
+ # The aggregation time, in seconds, to change to. This must be either
786
+ # `30` or `60`.
787
+ # @return [Integer]
788
+ #
789
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/UpdateMonitorInput AWS API Documentation
790
+ #
791
+ class UpdateMonitorInput < Struct.new(
792
+ :monitor_name,
793
+ :aggregation_period)
794
+ SENSITIVE = []
795
+ include Aws::Structure
796
+ end
797
+
798
+ # @!attribute [rw] monitor_arn
799
+ # The ARN of the monitor that was updated.
800
+ # @return [String]
801
+ #
802
+ # @!attribute [rw] monitor_name
803
+ # The name of the monitor that was updated.
804
+ # @return [String]
805
+ #
806
+ # @!attribute [rw] state
807
+ # The state of the updated monitor.
808
+ # @return [String]
809
+ #
810
+ # @!attribute [rw] aggregation_period
811
+ # The changed aggregation period.
812
+ # @return [Integer]
813
+ #
814
+ # @!attribute [rw] tags
815
+ # The list of key-value pairs associated with the monitor.
816
+ # @return [Hash<String,String>]
817
+ #
818
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/UpdateMonitorOutput AWS API Documentation
819
+ #
820
+ class UpdateMonitorOutput < Struct.new(
821
+ :monitor_arn,
822
+ :monitor_name,
823
+ :state,
824
+ :aggregation_period,
825
+ :tags)
826
+ SENSITIVE = []
827
+ include Aws::Structure
828
+ end
829
+
830
+ # @!attribute [rw] monitor_name
831
+ # The name of the monitor that the probe was updated for.
832
+ # @return [String]
833
+ #
834
+ # @!attribute [rw] probe_id
835
+ # Run `GetMonitor` to get a list of probes and probe IDs.
836
+ # @return [String]
837
+ #
838
+ # @!attribute [rw] state
839
+ # The state of the probe update.
840
+ # @return [String]
841
+ #
842
+ # @!attribute [rw] destination
843
+ # The updated IP address for the probe destination. This must be
844
+ # either an IPv4 or IPv6 address.
845
+ # @return [String]
846
+ #
847
+ # @!attribute [rw] destination_port
848
+ # The updated port for the probe destination. This is required only if
849
+ # the `protocol` is `TCP` and must be a number between `1` and
850
+ # `65536`.
851
+ # @return [Integer]
852
+ #
853
+ # @!attribute [rw] protocol
854
+ # The updated network protocol for the destination. This can be either
855
+ # `TCP` or `ICMP`. If the protocol is `TCP`, then `port` is also
856
+ # required.
857
+ # @return [String]
858
+ #
859
+ # @!attribute [rw] packet_size
860
+ # he updated packets size for network traffic between the source and
861
+ # destination. This must be a number between `56` and `8500`.
862
+ # @return [Integer]
863
+ #
864
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/UpdateProbeInput AWS API Documentation
865
+ #
866
+ class UpdateProbeInput < Struct.new(
867
+ :monitor_name,
868
+ :probe_id,
869
+ :state,
870
+ :destination,
871
+ :destination_port,
872
+ :protocol,
873
+ :packet_size)
874
+ SENSITIVE = []
875
+ include Aws::Structure
876
+ end
877
+
878
+ # @!attribute [rw] probe_id
879
+ # The updated ID of the probe.
880
+ # @return [String]
881
+ #
882
+ # @!attribute [rw] probe_arn
883
+ # The updated ARN of the probe.
884
+ # @return [String]
885
+ #
886
+ # @!attribute [rw] source_arn
887
+ # The updated ARN of the source subnet.
888
+ # @return [String]
889
+ #
890
+ # @!attribute [rw] destination
891
+ # The updated destination IP address for the probe.
892
+ # @return [String]
893
+ #
894
+ # @!attribute [rw] destination_port
895
+ # The updated destination port. This will be a number between `1` and
896
+ # `65536`.
897
+ # @return [Integer]
898
+ #
899
+ # @!attribute [rw] protocol
900
+ # The updated protocol for the probe.
901
+ # @return [String]
902
+ #
903
+ # @!attribute [rw] packet_size
904
+ # The updated packet size for the probe.
905
+ # @return [Integer]
906
+ #
907
+ # @!attribute [rw] address_family
908
+ # The updated IP address family. This will be either `IPV4` or `IPV6`.
909
+ # @return [String]
910
+ #
911
+ # @!attribute [rw] vpc_id
912
+ # The updated ID of the source VPC subnet ID.
913
+ # @return [String]
914
+ #
915
+ # @!attribute [rw] state
916
+ # The state of the updated probe.
917
+ # @return [String]
918
+ #
919
+ # @!attribute [rw] created_at
920
+ # The time and date that the probe was created.
921
+ # @return [Time]
922
+ #
923
+ # @!attribute [rw] modified_at
924
+ # The time and date that the probe was last updated.
925
+ # @return [Time]
926
+ #
927
+ # @!attribute [rw] tags
928
+ # Update tags for a probe.
929
+ # @return [Hash<String,String>]
930
+ #
931
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/UpdateProbeOutput AWS API Documentation
932
+ #
933
+ class UpdateProbeOutput < Struct.new(
934
+ :probe_id,
935
+ :probe_arn,
936
+ :source_arn,
937
+ :destination,
938
+ :destination_port,
939
+ :protocol,
940
+ :packet_size,
941
+ :address_family,
942
+ :vpc_id,
943
+ :state,
944
+ :created_at,
945
+ :modified_at,
946
+ :tags)
947
+ SENSITIVE = []
948
+ include Aws::Structure
949
+ end
950
+
951
+ # One of the parameters for the request is not valid.
952
+ #
953
+ # @!attribute [rw] message
954
+ # @return [String]
955
+ #
956
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/ValidationException AWS API Documentation
957
+ #
958
+ class ValidationException < Struct.new(
959
+ :message)
960
+ SENSITIVE = []
961
+ include Aws::Structure
962
+ end
963
+
964
+ end
965
+ end