aws-sdk-networkflowmonitor 1.40.0 → 1.42.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.
@@ -23,6 +23,88 @@ module Aws::NetworkFlowMonitor
23
23
  include Aws::Structure
24
24
  end
25
25
 
26
+ # An account that you can add to the monitoring scope for a monitor, so
27
+ # that Network Flow Monitor can resolve the network paths for traffic to
28
+ # and from resources in the account.
29
+ #
30
+ # @!attribute [rw] account_id
31
+ # The ID of the account that you can add to the monitoring scope.
32
+ # @return [String]
33
+ #
34
+ # @!attribute [rw] region
35
+ # The Amazon Web Services Region of the traffic that Network Flow
36
+ # Monitor identified for the account.
37
+ # @return [String]
38
+ #
39
+ # @!attribute [rw] membership
40
+ # Whether the account is a member of the same organization as the
41
+ # account that owns the monitor. The membership status can be one of
42
+ # the following
43
+ #
44
+ # * `IN_ORG`: The account is a member of the same organization.
45
+ #
46
+ # * `NOT_IN_ORG`: The account isn't a member of the same
47
+ # organization.
48
+ #
49
+ # * `UNKNOWN`: Network Flow Monitor can't determine the organization
50
+ # membership of the account.
51
+ # @return [String]
52
+ #
53
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/AccountToAdd AWS API Documentation
54
+ #
55
+ class AccountToAdd < Struct.new(
56
+ :account_id,
57
+ :region,
58
+ :membership)
59
+ SENSITIVE = []
60
+ include Aws::Structure
61
+ end
62
+
63
+ # Additional information about a network flow, such as the network that
64
+ # the remote address belongs to and the location of the client.
65
+ #
66
+ # @!attribute [rw] network
67
+ # The network that the remote address of the network flow belongs to.
68
+ # @return [Types::Network]
69
+ #
70
+ # @!attribute [rw] client_location
71
+ # The location of the client for the network flow.
72
+ # @return [Types::ClientLocation]
73
+ #
74
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/AdditionalFlowInfo AWS API Documentation
75
+ #
76
+ class AdditionalFlowInfo < Struct.new(
77
+ :network,
78
+ :client_location)
79
+ SENSITIVE = []
80
+ include Aws::Structure
81
+ end
82
+
83
+ # The geographic location of the client for a network flow.
84
+ #
85
+ # @!attribute [rw] city
86
+ # The city where the client is located.
87
+ # @return [String]
88
+ #
89
+ # @!attribute [rw] subdivision
90
+ # The subdivision, such as a state or province, where the client is
91
+ # located.
92
+ # @return [String]
93
+ #
94
+ # @!attribute [rw] country
95
+ # The country where the client is located.
96
+ # @return [String]
97
+ #
98
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/ClientLocation AWS API Documentation
99
+ #
100
+ class ClientLocation < Struct.new(
101
+ :city,
102
+ :subdivision,
103
+ :country)
104
+ SENSITIVE = []
105
+ include Aws::Structure
106
+ end
107
+
26
108
  # The requested resource is in use.
27
109
  #
28
110
  # @!attribute [rw] message
@@ -168,6 +250,111 @@ module Aws::NetworkFlowMonitor
168
250
  include Aws::Structure
169
251
  end
170
252
 
253
+ # @!attribute [rw] monitor_name
254
+ # The name of the performance monitor.
255
+ # @return [String]
256
+ #
257
+ # @!attribute [rw] scope_arn
258
+ # The Amazon Resource Name (ARN) of the scope for the performance
259
+ # monitor.
260
+ # @return [String]
261
+ #
262
+ # @!attribute [rw] targets
263
+ # The resources to monitor. Each target identifies a resource,
264
+ # currently a VPC, for which you can track network performance. For a
265
+ # VPC, specify the VPC ARN.
266
+ # @return [Array<Types::PerformanceMonitorTarget>]
267
+ #
268
+ # @!attribute [rw] client_token
269
+ # A unique, case-sensitive string of up to 64 ASCII characters that
270
+ # you specify to make an idempotent API request. If the token matches
271
+ # a previous request, the service ignores the request without
272
+ # returning an error. Don't reuse the same client token for other API
273
+ # requests.
274
+ #
275
+ # **A suitable default value is auto-generated.** You should normally
276
+ # not need to pass this option.
277
+ # @return [String]
278
+ #
279
+ # @!attribute [rw] tags
280
+ # The tags for a performance monitor. You can add a maximum of 200
281
+ # tags.
282
+ # @return [Hash<String,String>]
283
+ #
284
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/CreatePerformanceMonitorInput AWS API Documentation
285
+ #
286
+ class CreatePerformanceMonitorInput < Struct.new(
287
+ :monitor_name,
288
+ :scope_arn,
289
+ :targets,
290
+ :client_token,
291
+ :tags)
292
+ SENSITIVE = []
293
+ include Aws::Structure
294
+ end
295
+
296
+ # @!attribute [rw] monitor_arn
297
+ # The Amazon Resource Name (ARN) of the performance monitor.
298
+ # @return [String]
299
+ #
300
+ # @!attribute [rw] monitor_name
301
+ # The name of the performance monitor.
302
+ # @return [String]
303
+ #
304
+ # @!attribute [rw] monitor_status
305
+ # The status of a performance monitor. The status can be one of the
306
+ # following
307
+ #
308
+ # * `PENDING`: The performance monitor is in the process of being
309
+ # created.
310
+ #
311
+ # * `ACTIVE`: The performance monitor is active.
312
+ #
313
+ # * `INACTIVE`: The performance monitor is inactive.
314
+ #
315
+ # * `ERROR`: The performance monitor can't be created or updated.
316
+ #
317
+ # * `DELETING`: The performance monitor is in the process of being
318
+ # deleted.
319
+ # @return [String]
320
+ #
321
+ # @!attribute [rw] monitor_type
322
+ # The type of resource that you monitor determines the type of the
323
+ # performance monitor.
324
+ # @return [String]
325
+ #
326
+ # @!attribute [rw] targets
327
+ # The resources that the performance monitor tracks network
328
+ # performance for.
329
+ # @return [Array<Types::PerformanceMonitorTarget>]
330
+ #
331
+ # @!attribute [rw] created_at
332
+ # The date and time when the performance monitor was created.
333
+ # @return [Time]
334
+ #
335
+ # @!attribute [rw] modified_at
336
+ # The date and time when the performance monitor was last modified.
337
+ # @return [Time]
338
+ #
339
+ # @!attribute [rw] tags
340
+ # The tags for a performance monitor.
341
+ # @return [Hash<String,String>]
342
+ #
343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/CreatePerformanceMonitorOutput AWS API Documentation
344
+ #
345
+ class CreatePerformanceMonitorOutput < Struct.new(
346
+ :monitor_arn,
347
+ :monitor_name,
348
+ :monitor_status,
349
+ :monitor_type,
350
+ :targets,
351
+ :created_at,
352
+ :modified_at,
353
+ :tags)
354
+ SENSITIVE = []
355
+ include Aws::Structure
356
+ end
357
+
171
358
  # @!attribute [rw] targets
172
359
  # The targets to define the scope to be monitored. A target is an
173
360
  # array of targetResources, which are currently Region-account pairs,
@@ -249,6 +436,22 @@ module Aws::NetworkFlowMonitor
249
436
  #
250
437
  class DeleteMonitorOutput < Aws::EmptyStructure; end
251
438
 
439
+ # @!attribute [rw] monitor_name
440
+ # The name of the performance monitor.
441
+ # @return [String]
442
+ #
443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/DeletePerformanceMonitorInput AWS API Documentation
444
+ #
445
+ class DeletePerformanceMonitorInput < Struct.new(
446
+ :monitor_name)
447
+ SENSITIVE = []
448
+ include Aws::Structure
449
+ end
450
+
451
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/DeletePerformanceMonitorOutput AWS API Documentation
452
+ #
453
+ class DeletePerformanceMonitorOutput < Aws::EmptyStructure; end
454
+
252
455
  # @!attribute [rw] scope_id
253
456
  # The identifier for the scope that includes the resources you want to
254
457
  # get data results for. A scope ID is an internally-generated
@@ -268,6 +471,40 @@ module Aws::NetworkFlowMonitor
268
471
  #
269
472
  class DeleteScopeOutput < Aws::EmptyStructure; end
270
473
 
474
+ # A filter for a query, to return a subset of the results.
475
+ #
476
+ # @!attribute [rw] field
477
+ # The name of the field that you want to filter on. The fields that
478
+ # you can specify depend on the type of query.
479
+ # @return [String]
480
+ #
481
+ # @!attribute [rw] operator
482
+ # The operator to use to compare the field with the values that you
483
+ # specify. The operator can be one of the following
484
+ #
485
+ # * `EQUALS`: The field matches a single value.
486
+ #
487
+ # * `NOT_EQUALS`: The field doesn't match a single value.
488
+ #
489
+ # * `IN`: The field matches any one of several values.
490
+ #
491
+ # * `CONTAINS`: The field contains a value.
492
+ # @return [String]
493
+ #
494
+ # @!attribute [rw] values
495
+ # The values to compare the field with.
496
+ # @return [Array<String>]
497
+ #
498
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/FilterParameter AWS API Documentation
499
+ #
500
+ class FilterParameter < Struct.new(
501
+ :field,
502
+ :operator,
503
+ :values)
504
+ SENSITIVE = []
505
+ include Aws::Structure
506
+ end
507
+
271
508
  # @!attribute [rw] monitor_name
272
509
  # The name of the monitor.
273
510
  # @return [String]
@@ -341,6 +578,147 @@ module Aws::NetworkFlowMonitor
341
578
  include Aws::Structure
342
579
  end
343
580
 
581
+ # @!attribute [rw] monitor_arn
582
+ # The Amazon Resource Name (ARN) of the monitor that you want to
583
+ # return scope suggestions for.
584
+ # @return [String]
585
+ #
586
+ # @!attribute [rw] max_results
587
+ # The number of query results that you want to return with this call.
588
+ # @return [Integer]
589
+ #
590
+ # @!attribute [rw] next_token
591
+ # The token for the next set of results. You receive this token from a
592
+ # previous call.
593
+ # @return [String]
594
+ #
595
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetMonitorScopeSuggestionsInput AWS API Documentation
596
+ #
597
+ class GetMonitorScopeSuggestionsInput < Struct.new(
598
+ :monitor_arn,
599
+ :max_results,
600
+ :next_token)
601
+ SENSITIVE = []
602
+ include Aws::Structure
603
+ end
604
+
605
+ # @!attribute [rw] status
606
+ # The coverage status of the monitoring scope for the monitor. The
607
+ # status can be one of the following
608
+ #
609
+ # * `COMPLETE`: The scope includes every account that sends traffic
610
+ # to, or receives traffic from, resources in the monitor.
611
+ #
612
+ # * `INCOMPLETE`: There are accounts that you can add to the scope.
613
+ #
614
+ # * `PENDING`: Network Flow Monitor is determining the coverage of the
615
+ # scope.
616
+ #
617
+ # * `STALE`: The coverage of the scope was last determined too long
618
+ # ago to be current.
619
+ # @return [String]
620
+ #
621
+ # @!attribute [rw] accounts_to_add
622
+ # The accounts that you can add to the monitoring scope, so that
623
+ # Network Flow Monitor can resolve the network paths for traffic to
624
+ # and from resources in those accounts.
625
+ # @return [Array<Types::AccountToAdd>]
626
+ #
627
+ # @!attribute [rw] next_token
628
+ # The token for the next set of results. You receive this token from a
629
+ # previous call.
630
+ # @return [String]
631
+ #
632
+ # @!attribute [rw] updated_at
633
+ # The date and time when Network Flow Monitor last determined the
634
+ # coverage of the monitoring scope.
635
+ # @return [Time]
636
+ #
637
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetMonitorScopeSuggestionsOutput AWS API Documentation
638
+ #
639
+ class GetMonitorScopeSuggestionsOutput < Struct.new(
640
+ :status,
641
+ :accounts_to_add,
642
+ :next_token,
643
+ :updated_at)
644
+ SENSITIVE = []
645
+ include Aws::Structure
646
+ end
647
+
648
+ # @!attribute [rw] monitor_name
649
+ # The name of the performance monitor.
650
+ # @return [String]
651
+ #
652
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetPerformanceMonitorInput AWS API Documentation
653
+ #
654
+ class GetPerformanceMonitorInput < Struct.new(
655
+ :monitor_name)
656
+ SENSITIVE = []
657
+ include Aws::Structure
658
+ end
659
+
660
+ # @!attribute [rw] monitor_arn
661
+ # The Amazon Resource Name (ARN) of the performance monitor.
662
+ # @return [String]
663
+ #
664
+ # @!attribute [rw] monitor_name
665
+ # The name of the performance monitor.
666
+ # @return [String]
667
+ #
668
+ # @!attribute [rw] monitor_status
669
+ # The status of a performance monitor. The status can be one of the
670
+ # following
671
+ #
672
+ # * `PENDING`: The performance monitor is in the process of being
673
+ # created.
674
+ #
675
+ # * `ACTIVE`: The performance monitor is active.
676
+ #
677
+ # * `INACTIVE`: The performance monitor is inactive.
678
+ #
679
+ # * `ERROR`: The performance monitor can't be created or updated.
680
+ #
681
+ # * `DELETING`: The performance monitor is in the process of being
682
+ # deleted.
683
+ # @return [String]
684
+ #
685
+ # @!attribute [rw] monitor_type
686
+ # The type of resource that you monitor determines the type of the
687
+ # performance monitor.
688
+ # @return [String]
689
+ #
690
+ # @!attribute [rw] targets
691
+ # The resources that the performance monitor tracks network
692
+ # performance for.
693
+ # @return [Array<Types::PerformanceMonitorTarget>]
694
+ #
695
+ # @!attribute [rw] created_at
696
+ # The date and time when the performance monitor was created.
697
+ # @return [Time]
698
+ #
699
+ # @!attribute [rw] modified_at
700
+ # The date and time when the performance monitor was last modified.
701
+ # @return [Time]
702
+ #
703
+ # @!attribute [rw] tags
704
+ # The tags for a performance monitor.
705
+ # @return [Hash<String,String>]
706
+ #
707
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetPerformanceMonitorOutput AWS API Documentation
708
+ #
709
+ class GetPerformanceMonitorOutput < Struct.new(
710
+ :monitor_arn,
711
+ :monitor_name,
712
+ :monitor_status,
713
+ :monitor_type,
714
+ :targets,
715
+ :created_at,
716
+ :modified_at,
717
+ :tags)
718
+ SENSITIVE = []
719
+ include Aws::Structure
720
+ end
721
+
344
722
  # @!attribute [rw] monitor_name
345
723
  # The name of the monitor.
346
724
  # @return [String]
@@ -395,6 +773,61 @@ module Aws::NetworkFlowMonitor
395
773
  include Aws::Structure
396
774
  end
397
775
 
776
+ # @!attribute [rw] monitor_name
777
+ # The name of the performance monitor.
778
+ # @return [String]
779
+ #
780
+ # @!attribute [rw] query_id
781
+ # The identifier for the query. A query ID is an internally-generated
782
+ # identifier for a specific query returned from an API call to start a
783
+ # query.
784
+ # @return [String]
785
+ #
786
+ # @!attribute [rw] next_token
787
+ # The token for the next set of results. You receive this token from a
788
+ # previous call.
789
+ # @return [String]
790
+ #
791
+ # @!attribute [rw] max_results
792
+ # The number of query results that you want to return with this call.
793
+ # @return [Integer]
794
+ #
795
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryResultsPerformanceMonitorInput AWS API Documentation
796
+ #
797
+ class GetQueryResultsPerformanceMonitorInput < Struct.new(
798
+ :monitor_name,
799
+ :query_id,
800
+ :next_token,
801
+ :max_results)
802
+ SENSITIVE = []
803
+ include Aws::Structure
804
+ end
805
+
806
+ # @!attribute [rw] fields
807
+ # The columns that the query returns, in the order that the values for
808
+ # each row appear in `data`.
809
+ # @return [Array<Types::QueryField>]
810
+ #
811
+ # @!attribute [rw] data
812
+ # The results of the query. Each row contains the values for the
813
+ # columns that `fields` describes, in the same order.
814
+ # @return [Array<Array<String>>]
815
+ #
816
+ # @!attribute [rw] next_token
817
+ # The token for the next set of results. You receive this token from a
818
+ # previous call.
819
+ # @return [String]
820
+ #
821
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryResultsPerformanceMonitorOutput AWS API Documentation
822
+ #
823
+ class GetQueryResultsPerformanceMonitorOutput < Struct.new(
824
+ :fields,
825
+ :data,
826
+ :next_token)
827
+ SENSITIVE = []
828
+ include Aws::Structure
829
+ end
830
+
398
831
  # @!attribute [rw] scope_id
399
832
  # The identifier for the scope that includes the resources you want to
400
833
  # get data results for. A scope ID is an internally-generated
@@ -546,6 +979,49 @@ module Aws::NetworkFlowMonitor
546
979
  include Aws::Structure
547
980
  end
548
981
 
982
+ # @!attribute [rw] monitor_name
983
+ # The name of the performance monitor.
984
+ # @return [String]
985
+ #
986
+ # @!attribute [rw] query_id
987
+ # The identifier for the query. A query ID is an internally-generated
988
+ # identifier for a specific query returned from an API call to start a
989
+ # query.
990
+ # @return [String]
991
+ #
992
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryStatusPerformanceMonitorInput AWS API Documentation
993
+ #
994
+ class GetQueryStatusPerformanceMonitorInput < Struct.new(
995
+ :monitor_name,
996
+ :query_id)
997
+ SENSITIVE = []
998
+ include Aws::Structure
999
+ end
1000
+
1001
+ # @!attribute [rw] status
1002
+ # When you run a query, use this call to check the status of the query
1003
+ # to make sure that the query has `SUCCEEDED` before you review the
1004
+ # results.
1005
+ #
1006
+ # * `QUEUED`: The query is scheduled to run.
1007
+ #
1008
+ # * `RUNNING`: The query is in progress but not complete.
1009
+ #
1010
+ # * `SUCCEEDED`: The query completed successfully.
1011
+ #
1012
+ # * `FAILED`: The query failed due to an error.
1013
+ #
1014
+ # * `CANCELED`: The query was canceled.
1015
+ # @return [String]
1016
+ #
1017
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryStatusPerformanceMonitorOutput AWS API Documentation
1018
+ #
1019
+ class GetQueryStatusPerformanceMonitorOutput < Struct.new(
1020
+ :status)
1021
+ SENSITIVE = []
1022
+ include Aws::Structure
1023
+ end
1024
+
549
1025
  # @!attribute [rw] scope_id
550
1026
  # The identifier for the scope that includes the resources you want to
551
1027
  # get data results for. A scope ID is an internally-generated
@@ -798,6 +1274,57 @@ module Aws::NetworkFlowMonitor
798
1274
  include Aws::Structure
799
1275
  end
800
1276
 
1277
+ # @!attribute [rw] next_token
1278
+ # The token for the next set of results. You receive this token from a
1279
+ # previous call.
1280
+ # @return [String]
1281
+ #
1282
+ # @!attribute [rw] max_results
1283
+ # The number of performance monitors that you want to return with this
1284
+ # call. If you don't specify a value, the default is 25.
1285
+ # @return [Integer]
1286
+ #
1287
+ # @!attribute [rw] monitor_status
1288
+ # The status of the performance monitors that you want to return. If
1289
+ # you don't specify a status, Network Flow Monitor returns
1290
+ # performance monitors with any status.
1291
+ # @return [String]
1292
+ #
1293
+ # @!attribute [rw] monitor_type
1294
+ # The type of the performance monitors that you want to return. If you
1295
+ # don't specify a type, Network Flow Monitor returns performance
1296
+ # monitors of any type.
1297
+ # @return [String]
1298
+ #
1299
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/ListPerformanceMonitorsInput AWS API Documentation
1300
+ #
1301
+ class ListPerformanceMonitorsInput < Struct.new(
1302
+ :next_token,
1303
+ :max_results,
1304
+ :monitor_status,
1305
+ :monitor_type)
1306
+ SENSITIVE = []
1307
+ include Aws::Structure
1308
+ end
1309
+
1310
+ # @!attribute [rw] monitors
1311
+ # The performance monitors in the account.
1312
+ # @return [Array<Types::PerformanceMonitorSummary>]
1313
+ #
1314
+ # @!attribute [rw] next_token
1315
+ # The token for the next set of results. You receive this token from a
1316
+ # previous call.
1317
+ # @return [String]
1318
+ #
1319
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/ListPerformanceMonitorsOutput AWS API Documentation
1320
+ #
1321
+ class ListPerformanceMonitorsOutput < Struct.new(
1322
+ :monitors,
1323
+ :next_token)
1324
+ SENSITIVE = []
1325
+ include Aws::Structure
1326
+ end
1327
+
801
1328
  # @!attribute [rw] next_token
802
1329
  # The token for the next set of results. You receive this token from a
803
1330
  # previous call.
@@ -1106,6 +1633,11 @@ module Aws::NetworkFlowMonitor
1106
1633
  # The Amazon Resource Name (ARN) of a remote VPC.
1107
1634
  # @return [String]
1108
1635
  #
1636
+ # @!attribute [rw] additional_flow_info
1637
+ # Additional information about the network flow, such as the network
1638
+ # that the remote address belongs to and the location of the client.
1639
+ # @return [Types::AdditionalFlowInfo]
1640
+ #
1109
1641
  # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/MonitorTopContributorsRow AWS API Documentation
1110
1642
  #
1111
1643
  class MonitorTopContributorsRow < Struct.new(
@@ -1133,7 +1665,119 @@ module Aws::NetworkFlowMonitor
1133
1665
  :local_vpc_arn,
1134
1666
  :remote_instance_arn,
1135
1667
  :remote_subnet_arn,
1136
- :remote_vpc_arn)
1668
+ :remote_vpc_arn,
1669
+ :additional_flow_info)
1670
+ SENSITIVE = []
1671
+ include Aws::Structure
1672
+ end
1673
+
1674
+ # The network that an address in a network flow belongs to.
1675
+ #
1676
+ # @!attribute [rw] as_name
1677
+ # The name of the autonomous system that the network belongs to.
1678
+ # @return [String]
1679
+ #
1680
+ # @!attribute [rw] as_number
1681
+ # The autonomous system number (ASN) of the autonomous system that the
1682
+ # network belongs to.
1683
+ # @return [Integer]
1684
+ #
1685
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/Network AWS API Documentation
1686
+ #
1687
+ class Network < Struct.new(
1688
+ :as_name,
1689
+ :as_number)
1690
+ SENSITIVE = []
1691
+ include Aws::Structure
1692
+ end
1693
+
1694
+ # A summary of information about a performance monitor, including the
1695
+ # ARN, the name, the status, and the resources that it tracks network
1696
+ # performance for.
1697
+ #
1698
+ # @!attribute [rw] monitor_arn
1699
+ # The Amazon Resource Name (ARN) of the performance monitor.
1700
+ # @return [String]
1701
+ #
1702
+ # @!attribute [rw] monitor_name
1703
+ # The name of the performance monitor.
1704
+ # @return [String]
1705
+ #
1706
+ # @!attribute [rw] monitor_status
1707
+ # The status of a performance monitor. The status can be one of the
1708
+ # following
1709
+ #
1710
+ # * `PENDING`: The performance monitor is in the process of being
1711
+ # created.
1712
+ #
1713
+ # * `ACTIVE`: The performance monitor is active.
1714
+ #
1715
+ # * `INACTIVE`: The performance monitor is inactive.
1716
+ #
1717
+ # * `ERROR`: The performance monitor can't be created or updated.
1718
+ #
1719
+ # * `DELETING`: The performance monitor is in the process of being
1720
+ # deleted.
1721
+ # @return [String]
1722
+ #
1723
+ # @!attribute [rw] monitor_type
1724
+ # The type of resource that you monitor determines the type of the
1725
+ # performance monitor.
1726
+ # @return [String]
1727
+ #
1728
+ # @!attribute [rw] targets
1729
+ # The resources that the performance monitor tracks network
1730
+ # performance for.
1731
+ # @return [Array<Types::PerformanceMonitorTarget>]
1732
+ #
1733
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/PerformanceMonitorSummary AWS API Documentation
1734
+ #
1735
+ class PerformanceMonitorSummary < Struct.new(
1736
+ :monitor_arn,
1737
+ :monitor_name,
1738
+ :monitor_status,
1739
+ :monitor_type,
1740
+ :targets)
1741
+ SENSITIVE = []
1742
+ include Aws::Structure
1743
+ end
1744
+
1745
+ # A resource that a performance monitor tracks network performance for.
1746
+ #
1747
+ # @!attribute [rw] type
1748
+ # The type of the resource that you want Network Flow Monitor to track
1749
+ # network performance for. Specify `AWS::EC2::VPC`.
1750
+ # @return [String]
1751
+ #
1752
+ # @!attribute [rw] identifier
1753
+ # The Amazon Resource Name (ARN) of the resource that you want Network
1754
+ # Flow Monitor to track network performance for.
1755
+ # @return [String]
1756
+ #
1757
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/PerformanceMonitorTarget AWS API Documentation
1758
+ #
1759
+ class PerformanceMonitorTarget < Struct.new(
1760
+ :type,
1761
+ :identifier)
1762
+ SENSITIVE = []
1763
+ include Aws::Structure
1764
+ end
1765
+
1766
+ # A column that a query returns, with its name and data type.
1767
+ #
1768
+ # @!attribute [rw] name
1769
+ # The name of the column.
1770
+ # @return [String]
1771
+ #
1772
+ # @!attribute [rw] type
1773
+ # The data type of the values in the column.
1774
+ # @return [String]
1775
+ #
1776
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/QueryField AWS API Documentation
1777
+ #
1778
+ class QueryField < Struct.new(
1779
+ :name,
1780
+ :type)
1137
1781
  SENSITIVE = []
1138
1782
  include Aws::Structure
1139
1783
  end
@@ -1277,6 +1921,77 @@ module Aws::NetworkFlowMonitor
1277
1921
  include Aws::Structure
1278
1922
  end
1279
1923
 
1924
+ # @!attribute [rw] monitor_name
1925
+ # The name of the performance monitor.
1926
+ # @return [String]
1927
+ #
1928
+ # @!attribute [rw] start_time
1929
+ # The timestamp that is the date and time that is the beginning of the
1930
+ # period that you want to retrieve results for with your query.
1931
+ # @return [Time]
1932
+ #
1933
+ # @!attribute [rw] end_time
1934
+ # The timestamp that is the date and time end of the period that you
1935
+ # want to retrieve results for with your query.
1936
+ # @return [Time]
1937
+ #
1938
+ # @!attribute [rw] query_type
1939
+ # The type of query that you want to create. Specify `TOP_PATHS` to
1940
+ # return the top paths for the performance monitor.
1941
+ # @return [String]
1942
+ #
1943
+ # @!attribute [rw] filter_parameters
1944
+ # The filters for the query, to return a subset of the top paths. For
1945
+ # a `TOP_PATHS` query, you can filter on the following fields:
1946
+ #
1947
+ # * `local_az_id`: The Availability Zone ID of the local end of a path
1948
+ #
1949
+ # * `remote_az_id`: The Availability Zone ID of the remote end of a
1950
+ # path
1951
+ #
1952
+ # * `impact_level`: The impact level of a path
1953
+ #
1954
+ # When you filter on `impact_level`, Network Flow Monitor compares the
1955
+ # filter with the most severe impact level for the path over the time
1956
+ # period of the query, and the traffic and round-trip time that
1957
+ # Network Flow Monitor returns for each path still cover the full time
1958
+ # period. Paths that have no impact data don't match an
1959
+ # `impact_level` filter, including a `NOT_EQUALS` filter. Network Flow
1960
+ # Monitor doesn't filter the subnet pairs within a path by impact
1961
+ # level.
1962
+ # @return [Array<Types::FilterParameter>]
1963
+ #
1964
+ # @!attribute [rw] limit
1965
+ # The maximum number of top paths that you want the query to return.
1966
+ # @return [Integer]
1967
+ #
1968
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/StartQueryPerformanceMonitorInput AWS API Documentation
1969
+ #
1970
+ class StartQueryPerformanceMonitorInput < Struct.new(
1971
+ :monitor_name,
1972
+ :start_time,
1973
+ :end_time,
1974
+ :query_type,
1975
+ :filter_parameters,
1976
+ :limit)
1977
+ SENSITIVE = []
1978
+ include Aws::Structure
1979
+ end
1980
+
1981
+ # @!attribute [rw] query_id
1982
+ # The identifier for the query. A query ID is an internally-generated
1983
+ # identifier for a specific query returned from an API call to start a
1984
+ # query.
1985
+ # @return [String]
1986
+ #
1987
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/StartQueryPerformanceMonitorOutput AWS API Documentation
1988
+ #
1989
+ class StartQueryPerformanceMonitorOutput < Struct.new(
1990
+ :query_id)
1991
+ SENSITIVE = []
1992
+ include Aws::Structure
1993
+ end
1994
+
1280
1995
  # @!attribute [rw] scope_id
1281
1996
  # The identifier for the scope that includes the resources you want to
1282
1997
  # get data results for. A scope ID is an internally-generated
@@ -1449,6 +2164,29 @@ module Aws::NetworkFlowMonitor
1449
2164
  #
1450
2165
  class StopQueryMonitorTopContributorsOutput < Aws::EmptyStructure; end
1451
2166
 
2167
+ # @!attribute [rw] monitor_name
2168
+ # The name of the performance monitor.
2169
+ # @return [String]
2170
+ #
2171
+ # @!attribute [rw] query_id
2172
+ # The identifier for the query. A query ID is an internally-generated
2173
+ # identifier for a specific query returned from an API call to start a
2174
+ # query.
2175
+ # @return [String]
2176
+ #
2177
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/StopQueryPerformanceMonitorInput AWS API Documentation
2178
+ #
2179
+ class StopQueryPerformanceMonitorInput < Struct.new(
2180
+ :monitor_name,
2181
+ :query_id)
2182
+ SENSITIVE = []
2183
+ include Aws::Structure
2184
+ end
2185
+
2186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/StopQueryPerformanceMonitorOutput AWS API Documentation
2187
+ #
2188
+ class StopQueryPerformanceMonitorOutput < Aws::EmptyStructure; end
2189
+
1452
2190
  # @!attribute [rw] scope_id
1453
2191
  # The identifier for the scope that includes the resources you want to
1454
2192
  # get data results for. A scope ID is an internally-generated
@@ -1779,6 +2517,102 @@ module Aws::NetworkFlowMonitor
1779
2517
  include Aws::Structure
1780
2518
  end
1781
2519
 
2520
+ # @!attribute [rw] monitor_name
2521
+ # The name of the performance monitor.
2522
+ # @return [String]
2523
+ #
2524
+ # @!attribute [rw] targets_to_add
2525
+ # The resources to add to the performance monitor.
2526
+ # @return [Array<Types::PerformanceMonitorTarget>]
2527
+ #
2528
+ # @!attribute [rw] targets_to_remove
2529
+ # The resources to remove from the performance monitor.
2530
+ # @return [Array<Types::PerformanceMonitorTarget>]
2531
+ #
2532
+ # @!attribute [rw] client_token
2533
+ # A unique, case-sensitive string of up to 64 ASCII characters that
2534
+ # you specify to make an idempotent API request. If the token matches
2535
+ # a previous request, the service ignores the request without
2536
+ # returning an error. Don't reuse the same client token for other API
2537
+ # requests.
2538
+ #
2539
+ # **A suitable default value is auto-generated.** You should normally
2540
+ # not need to pass this option.
2541
+ # @return [String]
2542
+ #
2543
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/UpdatePerformanceMonitorInput AWS API Documentation
2544
+ #
2545
+ class UpdatePerformanceMonitorInput < Struct.new(
2546
+ :monitor_name,
2547
+ :targets_to_add,
2548
+ :targets_to_remove,
2549
+ :client_token)
2550
+ SENSITIVE = []
2551
+ include Aws::Structure
2552
+ end
2553
+
2554
+ # @!attribute [rw] monitor_arn
2555
+ # The Amazon Resource Name (ARN) of the performance monitor.
2556
+ # @return [String]
2557
+ #
2558
+ # @!attribute [rw] monitor_name
2559
+ # The name of the performance monitor.
2560
+ # @return [String]
2561
+ #
2562
+ # @!attribute [rw] monitor_status
2563
+ # The status of a performance monitor. The status can be one of the
2564
+ # following
2565
+ #
2566
+ # * `PENDING`: The performance monitor is in the process of being
2567
+ # created.
2568
+ #
2569
+ # * `ACTIVE`: The performance monitor is active.
2570
+ #
2571
+ # * `INACTIVE`: The performance monitor is inactive.
2572
+ #
2573
+ # * `ERROR`: The performance monitor can't be created or updated.
2574
+ #
2575
+ # * `DELETING`: The performance monitor is in the process of being
2576
+ # deleted.
2577
+ # @return [String]
2578
+ #
2579
+ # @!attribute [rw] monitor_type
2580
+ # The type of resource that you monitor determines the type of the
2581
+ # performance monitor.
2582
+ # @return [String]
2583
+ #
2584
+ # @!attribute [rw] targets
2585
+ # The resources that the performance monitor tracks network
2586
+ # performance for.
2587
+ # @return [Array<Types::PerformanceMonitorTarget>]
2588
+ #
2589
+ # @!attribute [rw] created_at
2590
+ # The date and time when the performance monitor was created.
2591
+ # @return [Time]
2592
+ #
2593
+ # @!attribute [rw] modified_at
2594
+ # The date and time when the performance monitor was last modified.
2595
+ # @return [Time]
2596
+ #
2597
+ # @!attribute [rw] tags
2598
+ # The tags for a performance monitor.
2599
+ # @return [Hash<String,String>]
2600
+ #
2601
+ # @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/UpdatePerformanceMonitorOutput AWS API Documentation
2602
+ #
2603
+ class UpdatePerformanceMonitorOutput < Struct.new(
2604
+ :monitor_arn,
2605
+ :monitor_name,
2606
+ :monitor_status,
2607
+ :monitor_type,
2608
+ :targets,
2609
+ :created_at,
2610
+ :modified_at,
2611
+ :tags)
2612
+ SENSITIVE = []
2613
+ include Aws::Structure
2614
+ end
2615
+
1782
2616
  # @!attribute [rw] scope_id
1783
2617
  # The identifier for the scope that includes the resources you want to
1784
2618
  # get data results for. A scope ID is an internally-generated