aws-sdk-networkflowmonitor 1.39.0 → 1.41.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-networkflowmonitor/client.rb +573 -5
- data/lib/aws-sdk-networkflowmonitor/client_api.rb +371 -0
- data/lib/aws-sdk-networkflowmonitor/types.rb +835 -1
- data/lib/aws-sdk-networkflowmonitor.rb +1 -1
- data/sig/client.rbs +170 -3
- data/sig/types.rbs +204 -4
- metadata +3 -3
|
@@ -599,6 +599,88 @@ module Aws::NetworkFlowMonitor
|
|
|
599
599
|
req.send_request(options)
|
|
600
600
|
end
|
|
601
601
|
|
|
602
|
+
# Create a performance monitor to monitor the traffic of the Amazon
|
|
603
|
+
# Virtual Private Clouds (VPCs) that you specify as targets, to
|
|
604
|
+
# determine whether the Amazon Web Services network is causing issues
|
|
605
|
+
# for your workloads. With a performance monitor, you can identify
|
|
606
|
+
# network degradation across paths between Availability Zones and across
|
|
607
|
+
# Amazon Web Services Regions.
|
|
608
|
+
#
|
|
609
|
+
# @option params [required, String] :monitor_name
|
|
610
|
+
# The name of the performance monitor.
|
|
611
|
+
#
|
|
612
|
+
# @option params [String] :scope_arn
|
|
613
|
+
# The Amazon Resource Name (ARN) of the scope for the performance
|
|
614
|
+
# monitor.
|
|
615
|
+
#
|
|
616
|
+
# @option params [required, Array<Types::PerformanceMonitorTarget>] :targets
|
|
617
|
+
# The resources to monitor. Each target identifies a resource, currently
|
|
618
|
+
# a VPC, for which you can track network performance. For a VPC, specify
|
|
619
|
+
# the VPC ARN.
|
|
620
|
+
#
|
|
621
|
+
# @option params [String] :client_token
|
|
622
|
+
# A unique, case-sensitive string of up to 64 ASCII characters that you
|
|
623
|
+
# specify to make an idempotent API request. If the token matches a
|
|
624
|
+
# previous request, the service ignores the request without returning an
|
|
625
|
+
# error. Don't reuse the same client token for other API requests.
|
|
626
|
+
#
|
|
627
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
628
|
+
# not need to pass this option.**
|
|
629
|
+
#
|
|
630
|
+
# @option params [Hash<String,String>] :tags
|
|
631
|
+
# The tags for a performance monitor. You can add a maximum of 200 tags.
|
|
632
|
+
#
|
|
633
|
+
# @return [Types::CreatePerformanceMonitorOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
634
|
+
#
|
|
635
|
+
# * {Types::CreatePerformanceMonitorOutput#monitor_arn #monitor_arn} => String
|
|
636
|
+
# * {Types::CreatePerformanceMonitorOutput#monitor_name #monitor_name} => String
|
|
637
|
+
# * {Types::CreatePerformanceMonitorOutput#monitor_status #monitor_status} => String
|
|
638
|
+
# * {Types::CreatePerformanceMonitorOutput#monitor_type #monitor_type} => String
|
|
639
|
+
# * {Types::CreatePerformanceMonitorOutput#targets #targets} => Array<Types::PerformanceMonitorTarget>
|
|
640
|
+
# * {Types::CreatePerformanceMonitorOutput#created_at #created_at} => Time
|
|
641
|
+
# * {Types::CreatePerformanceMonitorOutput#modified_at #modified_at} => Time
|
|
642
|
+
# * {Types::CreatePerformanceMonitorOutput#tags #tags} => Hash<String,String>
|
|
643
|
+
#
|
|
644
|
+
# @example Request syntax with placeholder values
|
|
645
|
+
#
|
|
646
|
+
# resp = client.create_performance_monitor({
|
|
647
|
+
# monitor_name: "ResourceName", # required
|
|
648
|
+
# scope_arn: "Arn",
|
|
649
|
+
# targets: [ # required
|
|
650
|
+
# {
|
|
651
|
+
# type: "AWS::EC2::VPC", # required, accepts AWS::EC2::VPC
|
|
652
|
+
# identifier: "PerformanceMonitorTargetIdentifierString", # required
|
|
653
|
+
# },
|
|
654
|
+
# ],
|
|
655
|
+
# client_token: "UuidString",
|
|
656
|
+
# tags: {
|
|
657
|
+
# "TagKey" => "TagValue",
|
|
658
|
+
# },
|
|
659
|
+
# })
|
|
660
|
+
#
|
|
661
|
+
# @example Response structure
|
|
662
|
+
#
|
|
663
|
+
# resp.monitor_arn #=> String
|
|
664
|
+
# resp.monitor_name #=> String
|
|
665
|
+
# resp.monitor_status #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "ERROR", "DELETING"
|
|
666
|
+
# resp.monitor_type #=> String, one of "VPC"
|
|
667
|
+
# resp.targets #=> Array
|
|
668
|
+
# resp.targets[0].type #=> String, one of "AWS::EC2::VPC"
|
|
669
|
+
# resp.targets[0].identifier #=> String
|
|
670
|
+
# resp.created_at #=> Time
|
|
671
|
+
# resp.modified_at #=> Time
|
|
672
|
+
# resp.tags #=> Hash
|
|
673
|
+
# resp.tags["TagKey"] #=> String
|
|
674
|
+
#
|
|
675
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/CreatePerformanceMonitor AWS API Documentation
|
|
676
|
+
#
|
|
677
|
+
# @overload create_performance_monitor(params = {})
|
|
678
|
+
# @param [Hash] params ({})
|
|
679
|
+
def create_performance_monitor(params = {}, options = {})
|
|
680
|
+
req = build_request(:create_performance_monitor, params)
|
|
681
|
+
req.send_request(options)
|
|
682
|
+
end
|
|
683
|
+
|
|
602
684
|
# In Network Flow Monitor, you specify a scope for the service to
|
|
603
685
|
# generate metrics for. By using the scope, Network Flow Monitor can
|
|
604
686
|
# generate a topology of all the resources to measure performance
|
|
@@ -705,6 +787,29 @@ module Aws::NetworkFlowMonitor
|
|
|
705
787
|
req.send_request(options)
|
|
706
788
|
end
|
|
707
789
|
|
|
790
|
+
# Delete a performance monitor. Network Flow Monitor stops tracking
|
|
791
|
+
# network performance for the resources that the monitor included.
|
|
792
|
+
#
|
|
793
|
+
# @option params [required, String] :monitor_name
|
|
794
|
+
# The name of the performance monitor.
|
|
795
|
+
#
|
|
796
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
797
|
+
#
|
|
798
|
+
# @example Request syntax with placeholder values
|
|
799
|
+
#
|
|
800
|
+
# resp = client.delete_performance_monitor({
|
|
801
|
+
# monitor_name: "ResourceName", # required
|
|
802
|
+
# })
|
|
803
|
+
#
|
|
804
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/DeletePerformanceMonitor AWS API Documentation
|
|
805
|
+
#
|
|
806
|
+
# @overload delete_performance_monitor(params = {})
|
|
807
|
+
# @param [Hash] params ({})
|
|
808
|
+
def delete_performance_monitor(params = {}, options = {})
|
|
809
|
+
req = build_request(:delete_performance_monitor, params)
|
|
810
|
+
req.send_request(options)
|
|
811
|
+
end
|
|
812
|
+
|
|
708
813
|
# Deletes a scope that has been defined.
|
|
709
814
|
#
|
|
710
815
|
# @option params [required, String] :scope_id
|
|
@@ -779,6 +884,105 @@ module Aws::NetworkFlowMonitor
|
|
|
779
884
|
req.send_request(options)
|
|
780
885
|
end
|
|
781
886
|
|
|
887
|
+
# Returns the accounts that are sending traffic to, or receiving traffic
|
|
888
|
+
# from, resources in a monitor, but that aren't included in the
|
|
889
|
+
# monitoring scope for the monitor. By adding the suggested accounts to
|
|
890
|
+
# your scope, you enable Network Flow Monitor to resolve the network
|
|
891
|
+
# paths for that traffic.
|
|
892
|
+
#
|
|
893
|
+
# @option params [required, String] :monitor_arn
|
|
894
|
+
# The Amazon Resource Name (ARN) of the monitor that you want to return
|
|
895
|
+
# scope suggestions for.
|
|
896
|
+
#
|
|
897
|
+
# @option params [Integer] :max_results
|
|
898
|
+
# The number of query results that you want to return with this call.
|
|
899
|
+
#
|
|
900
|
+
# @option params [String] :next_token
|
|
901
|
+
# The token for the next set of results. You receive this token from a
|
|
902
|
+
# previous call.
|
|
903
|
+
#
|
|
904
|
+
# @return [Types::GetMonitorScopeSuggestionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
905
|
+
#
|
|
906
|
+
# * {Types::GetMonitorScopeSuggestionsOutput#status #status} => String
|
|
907
|
+
# * {Types::GetMonitorScopeSuggestionsOutput#accounts_to_add #accounts_to_add} => Array<Types::AccountToAdd>
|
|
908
|
+
# * {Types::GetMonitorScopeSuggestionsOutput#next_token #next_token} => String
|
|
909
|
+
# * {Types::GetMonitorScopeSuggestionsOutput#updated_at #updated_at} => Time
|
|
910
|
+
#
|
|
911
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
912
|
+
#
|
|
913
|
+
# @example Request syntax with placeholder values
|
|
914
|
+
#
|
|
915
|
+
# resp = client.get_monitor_scope_suggestions({
|
|
916
|
+
# monitor_arn: "MonitorArn", # required
|
|
917
|
+
# max_results: 1,
|
|
918
|
+
# next_token: "String",
|
|
919
|
+
# })
|
|
920
|
+
#
|
|
921
|
+
# @example Response structure
|
|
922
|
+
#
|
|
923
|
+
# resp.status #=> String, one of "COMPLETE", "INCOMPLETE", "PENDING", "STALE"
|
|
924
|
+
# resp.accounts_to_add #=> Array
|
|
925
|
+
# resp.accounts_to_add[0].account_id #=> String
|
|
926
|
+
# resp.accounts_to_add[0].region #=> String
|
|
927
|
+
# resp.accounts_to_add[0].membership #=> String, one of "IN_ORG", "NOT_IN_ORG", "UNKNOWN"
|
|
928
|
+
# resp.next_token #=> String
|
|
929
|
+
# resp.updated_at #=> Time
|
|
930
|
+
#
|
|
931
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetMonitorScopeSuggestions AWS API Documentation
|
|
932
|
+
#
|
|
933
|
+
# @overload get_monitor_scope_suggestions(params = {})
|
|
934
|
+
# @param [Hash] params ({})
|
|
935
|
+
def get_monitor_scope_suggestions(params = {}, options = {})
|
|
936
|
+
req = build_request(:get_monitor_scope_suggestions, params)
|
|
937
|
+
req.send_request(options)
|
|
938
|
+
end
|
|
939
|
+
|
|
940
|
+
# Returns information about a performance monitor, including the
|
|
941
|
+
# resources that it monitors, its status, and the tags for the monitor.
|
|
942
|
+
#
|
|
943
|
+
# @option params [required, String] :monitor_name
|
|
944
|
+
# The name of the performance monitor.
|
|
945
|
+
#
|
|
946
|
+
# @return [Types::GetPerformanceMonitorOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
947
|
+
#
|
|
948
|
+
# * {Types::GetPerformanceMonitorOutput#monitor_arn #monitor_arn} => String
|
|
949
|
+
# * {Types::GetPerformanceMonitorOutput#monitor_name #monitor_name} => String
|
|
950
|
+
# * {Types::GetPerformanceMonitorOutput#monitor_status #monitor_status} => String
|
|
951
|
+
# * {Types::GetPerformanceMonitorOutput#monitor_type #monitor_type} => String
|
|
952
|
+
# * {Types::GetPerformanceMonitorOutput#targets #targets} => Array<Types::PerformanceMonitorTarget>
|
|
953
|
+
# * {Types::GetPerformanceMonitorOutput#created_at #created_at} => Time
|
|
954
|
+
# * {Types::GetPerformanceMonitorOutput#modified_at #modified_at} => Time
|
|
955
|
+
# * {Types::GetPerformanceMonitorOutput#tags #tags} => Hash<String,String>
|
|
956
|
+
#
|
|
957
|
+
# @example Request syntax with placeholder values
|
|
958
|
+
#
|
|
959
|
+
# resp = client.get_performance_monitor({
|
|
960
|
+
# monitor_name: "ResourceName", # required
|
|
961
|
+
# })
|
|
962
|
+
#
|
|
963
|
+
# @example Response structure
|
|
964
|
+
#
|
|
965
|
+
# resp.monitor_arn #=> String
|
|
966
|
+
# resp.monitor_name #=> String
|
|
967
|
+
# resp.monitor_status #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "ERROR", "DELETING"
|
|
968
|
+
# resp.monitor_type #=> String, one of "VPC"
|
|
969
|
+
# resp.targets #=> Array
|
|
970
|
+
# resp.targets[0].type #=> String, one of "AWS::EC2::VPC"
|
|
971
|
+
# resp.targets[0].identifier #=> String
|
|
972
|
+
# resp.created_at #=> Time
|
|
973
|
+
# resp.modified_at #=> Time
|
|
974
|
+
# resp.tags #=> Hash
|
|
975
|
+
# resp.tags["TagKey"] #=> String
|
|
976
|
+
#
|
|
977
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetPerformanceMonitor AWS API Documentation
|
|
978
|
+
#
|
|
979
|
+
# @overload get_performance_monitor(params = {})
|
|
980
|
+
# @param [Hash] params ({})
|
|
981
|
+
def get_performance_monitor(params = {}, options = {})
|
|
982
|
+
req = build_request(:get_performance_monitor, params)
|
|
983
|
+
req.send_request(options)
|
|
984
|
+
end
|
|
985
|
+
|
|
782
986
|
# Return the data for a query with the Network Flow Monitor query
|
|
783
987
|
# interface. You specify the query that you want to return results for
|
|
784
988
|
# by providing a query ID and a monitor name. This query returns the top
|
|
@@ -838,7 +1042,7 @@ module Aws::NetworkFlowMonitor
|
|
|
838
1042
|
# resp.top_contributors[0].local_az #=> String
|
|
839
1043
|
# resp.top_contributors[0].local_subnet_id #=> String
|
|
840
1044
|
# resp.top_contributors[0].target_port #=> Integer
|
|
841
|
-
# resp.top_contributors[0].destination_category #=> String, one of "INTRA_AZ", "INTER_AZ", "INTER_VPC", "UNCLASSIFIED", "AMAZON_S3", "AMAZON_DYNAMODB", "INTER_REGION"
|
|
1045
|
+
# resp.top_contributors[0].destination_category #=> String, one of "INTRA_AZ", "INTER_AZ", "INTER_VPC", "UNCLASSIFIED", "AMAZON_S3", "AMAZON_DYNAMODB", "INTER_REGION", "INTERNET", "AWS_SERVICE", "LOCAL_ZONE", "TRANSIT_GATEWAY"
|
|
842
1046
|
# resp.top_contributors[0].remote_vpc_id #=> String
|
|
843
1047
|
# resp.top_contributors[0].remote_region #=> String
|
|
844
1048
|
# resp.top_contributors[0].remote_az #=> String
|
|
@@ -864,6 +1068,11 @@ module Aws::NetworkFlowMonitor
|
|
|
864
1068
|
# resp.top_contributors[0].remote_instance_arn #=> String
|
|
865
1069
|
# resp.top_contributors[0].remote_subnet_arn #=> String
|
|
866
1070
|
# resp.top_contributors[0].remote_vpc_arn #=> String
|
|
1071
|
+
# resp.top_contributors[0].additional_flow_info.network.as_name #=> String
|
|
1072
|
+
# resp.top_contributors[0].additional_flow_info.network.as_number #=> Integer
|
|
1073
|
+
# resp.top_contributors[0].additional_flow_info.client_location.city #=> String
|
|
1074
|
+
# resp.top_contributors[0].additional_flow_info.client_location.subdivision #=> String
|
|
1075
|
+
# resp.top_contributors[0].additional_flow_info.client_location.country #=> String
|
|
867
1076
|
# resp.next_token #=> String
|
|
868
1077
|
#
|
|
869
1078
|
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryResultsMonitorTopContributors AWS API Documentation
|
|
@@ -875,6 +1084,68 @@ module Aws::NetworkFlowMonitor
|
|
|
875
1084
|
req.send_request(options)
|
|
876
1085
|
end
|
|
877
1086
|
|
|
1087
|
+
# Returns the results of a query for the Network Flow Monitor query
|
|
1088
|
+
# interface, for a specified query ID and performance monitor. This call
|
|
1089
|
+
# returns the top paths for a performance monitor.
|
|
1090
|
+
#
|
|
1091
|
+
# Create a query with [ StartQueryPerformanceMonitor][1], and then use
|
|
1092
|
+
# the query ID with this call to return the results.
|
|
1093
|
+
#
|
|
1094
|
+
#
|
|
1095
|
+
#
|
|
1096
|
+
# [1]: https://docs.aws.amazon.com/networkflowmonitor/2.0/APIReference/API_StartQueryPerformanceMonitor.html
|
|
1097
|
+
#
|
|
1098
|
+
# @option params [required, String] :monitor_name
|
|
1099
|
+
# The name of the performance monitor.
|
|
1100
|
+
#
|
|
1101
|
+
# @option params [required, String] :query_id
|
|
1102
|
+
# The identifier for the query. A query ID is an internally-generated
|
|
1103
|
+
# identifier for a specific query returned from an API call to start a
|
|
1104
|
+
# query.
|
|
1105
|
+
#
|
|
1106
|
+
# @option params [String] :next_token
|
|
1107
|
+
# The token for the next set of results. You receive this token from a
|
|
1108
|
+
# previous call.
|
|
1109
|
+
#
|
|
1110
|
+
# @option params [Integer] :max_results
|
|
1111
|
+
# The number of query results that you want to return with this call.
|
|
1112
|
+
#
|
|
1113
|
+
# @return [Types::GetQueryResultsPerformanceMonitorOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1114
|
+
#
|
|
1115
|
+
# * {Types::GetQueryResultsPerformanceMonitorOutput#fields #fields} => Array<Types::QueryField>
|
|
1116
|
+
# * {Types::GetQueryResultsPerformanceMonitorOutput#data #data} => Array<Array<String>>
|
|
1117
|
+
# * {Types::GetQueryResultsPerformanceMonitorOutput#next_token #next_token} => String
|
|
1118
|
+
#
|
|
1119
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1120
|
+
#
|
|
1121
|
+
# @example Request syntax with placeholder values
|
|
1122
|
+
#
|
|
1123
|
+
# resp = client.get_query_results_performance_monitor({
|
|
1124
|
+
# monitor_name: "ResourceName", # required
|
|
1125
|
+
# query_id: "String", # required
|
|
1126
|
+
# next_token: "String",
|
|
1127
|
+
# max_results: 1,
|
|
1128
|
+
# })
|
|
1129
|
+
#
|
|
1130
|
+
# @example Response structure
|
|
1131
|
+
#
|
|
1132
|
+
# resp.fields #=> Array
|
|
1133
|
+
# resp.fields[0].name #=> String
|
|
1134
|
+
# resp.fields[0].type #=> String
|
|
1135
|
+
# resp.data #=> Array
|
|
1136
|
+
# resp.data[0] #=> Array
|
|
1137
|
+
# resp.data[0][0] #=> String
|
|
1138
|
+
# resp.next_token #=> String
|
|
1139
|
+
#
|
|
1140
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryResultsPerformanceMonitor AWS API Documentation
|
|
1141
|
+
#
|
|
1142
|
+
# @overload get_query_results_performance_monitor(params = {})
|
|
1143
|
+
# @param [Hash] params ({})
|
|
1144
|
+
def get_query_results_performance_monitor(params = {}, options = {})
|
|
1145
|
+
req = build_request(:get_query_results_performance_monitor, params)
|
|
1146
|
+
req.send_request(options)
|
|
1147
|
+
end
|
|
1148
|
+
|
|
878
1149
|
# Return the data for a query with the Network Flow Monitor query
|
|
879
1150
|
# interface. You specify the query that you want to return results for
|
|
880
1151
|
# by providing a query ID and a monitor name.
|
|
@@ -1073,6 +1344,48 @@ module Aws::NetworkFlowMonitor
|
|
|
1073
1344
|
req.send_request(options)
|
|
1074
1345
|
end
|
|
1075
1346
|
|
|
1347
|
+
# Returns the current status of a query for the Network Flow Monitor
|
|
1348
|
+
# query interface, for a specified query ID and performance monitor.
|
|
1349
|
+
# This call returns the query status for the top paths for a performance
|
|
1350
|
+
# monitor.
|
|
1351
|
+
#
|
|
1352
|
+
# When you run a query, use this call to check the status of the query
|
|
1353
|
+
# to make sure that the query has `SUCCEEDED` before you review the
|
|
1354
|
+
# results. Use the same query ID that you used for the corresponding API
|
|
1355
|
+
# call to start (create) the query, `StartQueryPerformanceMonitor`.
|
|
1356
|
+
#
|
|
1357
|
+
# @option params [required, String] :monitor_name
|
|
1358
|
+
# The name of the performance monitor.
|
|
1359
|
+
#
|
|
1360
|
+
# @option params [required, String] :query_id
|
|
1361
|
+
# The identifier for the query. A query ID is an internally-generated
|
|
1362
|
+
# identifier for a specific query returned from an API call to start a
|
|
1363
|
+
# query.
|
|
1364
|
+
#
|
|
1365
|
+
# @return [Types::GetQueryStatusPerformanceMonitorOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1366
|
+
#
|
|
1367
|
+
# * {Types::GetQueryStatusPerformanceMonitorOutput#status #status} => String
|
|
1368
|
+
#
|
|
1369
|
+
# @example Request syntax with placeholder values
|
|
1370
|
+
#
|
|
1371
|
+
# resp = client.get_query_status_performance_monitor({
|
|
1372
|
+
# monitor_name: "ResourceName", # required
|
|
1373
|
+
# query_id: "String", # required
|
|
1374
|
+
# })
|
|
1375
|
+
#
|
|
1376
|
+
# @example Response structure
|
|
1377
|
+
#
|
|
1378
|
+
# resp.status #=> String, one of "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELED"
|
|
1379
|
+
#
|
|
1380
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryStatusPerformanceMonitor AWS API Documentation
|
|
1381
|
+
#
|
|
1382
|
+
# @overload get_query_status_performance_monitor(params = {})
|
|
1383
|
+
# @param [Hash] params ({})
|
|
1384
|
+
def get_query_status_performance_monitor(params = {}, options = {})
|
|
1385
|
+
req = build_request(:get_query_status_performance_monitor, params)
|
|
1386
|
+
req.send_request(options)
|
|
1387
|
+
end
|
|
1388
|
+
|
|
1076
1389
|
# Return the data for a query with the Network Flow Monitor query
|
|
1077
1390
|
# interface. Specify the query that you want to return results for by
|
|
1078
1391
|
# providing a query ID and a monitor name. This query returns the top
|
|
@@ -1277,6 +1590,68 @@ module Aws::NetworkFlowMonitor
|
|
|
1277
1590
|
req.send_request(options)
|
|
1278
1591
|
end
|
|
1279
1592
|
|
|
1593
|
+
# Returns a list of the performance monitors in an account. You can
|
|
1594
|
+
# optionally return only the monitors that have a specific status or
|
|
1595
|
+
# type.
|
|
1596
|
+
#
|
|
1597
|
+
# Results are paginated. Use the `nextToken` parameter to return
|
|
1598
|
+
# additional results.
|
|
1599
|
+
#
|
|
1600
|
+
# @option params [String] :next_token
|
|
1601
|
+
# The token for the next set of results. You receive this token from a
|
|
1602
|
+
# previous call.
|
|
1603
|
+
#
|
|
1604
|
+
# @option params [Integer] :max_results
|
|
1605
|
+
# The number of performance monitors that you want to return with this
|
|
1606
|
+
# call. If you don't specify a value, the default is 25.
|
|
1607
|
+
#
|
|
1608
|
+
# @option params [String] :monitor_status
|
|
1609
|
+
# The status of the performance monitors that you want to return. If you
|
|
1610
|
+
# don't specify a status, Network Flow Monitor returns performance
|
|
1611
|
+
# monitors with any status.
|
|
1612
|
+
#
|
|
1613
|
+
# @option params [String] :monitor_type
|
|
1614
|
+
# The type of the performance monitors that you want to return. If you
|
|
1615
|
+
# don't specify a type, Network Flow Monitor returns performance
|
|
1616
|
+
# monitors of any type.
|
|
1617
|
+
#
|
|
1618
|
+
# @return [Types::ListPerformanceMonitorsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1619
|
+
#
|
|
1620
|
+
# * {Types::ListPerformanceMonitorsOutput#monitors #monitors} => Array<Types::PerformanceMonitorSummary>
|
|
1621
|
+
# * {Types::ListPerformanceMonitorsOutput#next_token #next_token} => String
|
|
1622
|
+
#
|
|
1623
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1624
|
+
#
|
|
1625
|
+
# @example Request syntax with placeholder values
|
|
1626
|
+
#
|
|
1627
|
+
# resp = client.list_performance_monitors({
|
|
1628
|
+
# next_token: "String",
|
|
1629
|
+
# max_results: 1,
|
|
1630
|
+
# monitor_status: "PENDING", # accepts PENDING, ACTIVE, INACTIVE, ERROR, DELETING
|
|
1631
|
+
# monitor_type: "VPC", # accepts VPC
|
|
1632
|
+
# })
|
|
1633
|
+
#
|
|
1634
|
+
# @example Response structure
|
|
1635
|
+
#
|
|
1636
|
+
# resp.monitors #=> Array
|
|
1637
|
+
# resp.monitors[0].monitor_arn #=> String
|
|
1638
|
+
# resp.monitors[0].monitor_name #=> String
|
|
1639
|
+
# resp.monitors[0].monitor_status #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "ERROR", "DELETING"
|
|
1640
|
+
# resp.monitors[0].monitor_type #=> String, one of "VPC"
|
|
1641
|
+
# resp.monitors[0].targets #=> Array
|
|
1642
|
+
# resp.monitors[0].targets[0].type #=> String, one of "AWS::EC2::VPC"
|
|
1643
|
+
# resp.monitors[0].targets[0].identifier #=> String
|
|
1644
|
+
# resp.next_token #=> String
|
|
1645
|
+
#
|
|
1646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/ListPerformanceMonitors AWS API Documentation
|
|
1647
|
+
#
|
|
1648
|
+
# @overload list_performance_monitors(params = {})
|
|
1649
|
+
# @param [Hash] params ({})
|
|
1650
|
+
def list_performance_monitors(params = {}, options = {})
|
|
1651
|
+
req = build_request(:list_performance_monitors, params)
|
|
1652
|
+
req.send_request(options)
|
|
1653
|
+
end
|
|
1654
|
+
|
|
1280
1655
|
# List all the scopes for an account.
|
|
1281
1656
|
#
|
|
1282
1657
|
# @option params [String] :next_token
|
|
@@ -1418,7 +1793,7 @@ module Aws::NetworkFlowMonitor
|
|
|
1418
1793
|
# start_time: Time.now, # required
|
|
1419
1794
|
# end_time: Time.now, # required
|
|
1420
1795
|
# metric_name: "ROUND_TRIP_TIME", # required, accepts ROUND_TRIP_TIME, TIMEOUTS, RETRANSMISSIONS, DATA_TRANSFERRED
|
|
1421
|
-
# destination_category: "INTRA_AZ", # required, accepts INTRA_AZ, INTER_AZ, INTER_VPC, UNCLASSIFIED, AMAZON_S3, AMAZON_DYNAMODB, INTER_REGION
|
|
1796
|
+
# destination_category: "INTRA_AZ", # required, accepts INTRA_AZ, INTER_AZ, INTER_VPC, UNCLASSIFIED, AMAZON_S3, AMAZON_DYNAMODB, INTER_REGION, INTERNET, AWS_SERVICE, LOCAL_ZONE, TRANSIT_GATEWAY
|
|
1422
1797
|
# limit: 1,
|
|
1423
1798
|
# })
|
|
1424
1799
|
#
|
|
@@ -1435,6 +1810,94 @@ module Aws::NetworkFlowMonitor
|
|
|
1435
1810
|
req.send_request(options)
|
|
1436
1811
|
end
|
|
1437
1812
|
|
|
1813
|
+
# Create a query that you can use with the Network Flow Monitor query
|
|
1814
|
+
# interface to return the top paths for a performance monitor. Specify
|
|
1815
|
+
# the performance monitor that you want to create the query for.
|
|
1816
|
+
#
|
|
1817
|
+
# The call returns a query ID that you can use with [
|
|
1818
|
+
# GetQueryResultsPerformanceMonitor][1] to return the results of the
|
|
1819
|
+
# query.
|
|
1820
|
+
#
|
|
1821
|
+
# Top paths in Network Flow Monitor are the network paths used by the
|
|
1822
|
+
# traffic for the resources that a performance monitor tracks, ranked by
|
|
1823
|
+
# impact score and then by traffic volume. Each path includes the
|
|
1824
|
+
# traffic and round-trip time for the path, together with a breakdown of
|
|
1825
|
+
# the subnet pairs that the path includes.
|
|
1826
|
+
#
|
|
1827
|
+
#
|
|
1828
|
+
#
|
|
1829
|
+
# [1]: https://docs.aws.amazon.com/networkflowmonitor/2.0/APIReference/API_GetQueryResultsPerformanceMonitor.html
|
|
1830
|
+
#
|
|
1831
|
+
# @option params [required, String] :monitor_name
|
|
1832
|
+
# The name of the performance monitor.
|
|
1833
|
+
#
|
|
1834
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
|
1835
|
+
# The timestamp that is the date and time that is the beginning of the
|
|
1836
|
+
# period that you want to retrieve results for with your query.
|
|
1837
|
+
#
|
|
1838
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
|
|
1839
|
+
# The timestamp that is the date and time end of the period that you
|
|
1840
|
+
# want to retrieve results for with your query.
|
|
1841
|
+
#
|
|
1842
|
+
# @option params [required, String] :query_type
|
|
1843
|
+
# The type of query that you want to create. Specify `TOP_PATHS` to
|
|
1844
|
+
# return the top paths for the performance monitor.
|
|
1845
|
+
#
|
|
1846
|
+
# @option params [Array<Types::FilterParameter>] :filter_parameters
|
|
1847
|
+
# The filters for the query, to return a subset of the top paths. For a
|
|
1848
|
+
# `TOP_PATHS` query, you can filter on the following fields:
|
|
1849
|
+
#
|
|
1850
|
+
# * `local_az_id`: The Availability Zone ID of the local end of a path
|
|
1851
|
+
#
|
|
1852
|
+
# * `remote_az_id`: The Availability Zone ID of the remote end of a path
|
|
1853
|
+
#
|
|
1854
|
+
# * `impact_level`: The impact level of a path
|
|
1855
|
+
#
|
|
1856
|
+
# When you filter on `impact_level`, Network Flow Monitor compares the
|
|
1857
|
+
# filter with the most severe impact level for the path over the time
|
|
1858
|
+
# period of the query, and the traffic and round-trip time that Network
|
|
1859
|
+
# Flow Monitor returns for each path still cover the full time period.
|
|
1860
|
+
# Paths that have no impact data don't match an `impact_level` filter,
|
|
1861
|
+
# including a `NOT_EQUALS` filter. Network Flow Monitor doesn't filter
|
|
1862
|
+
# the subnet pairs within a path by impact level.
|
|
1863
|
+
#
|
|
1864
|
+
# @option params [Integer] :limit
|
|
1865
|
+
# The maximum number of top paths that you want the query to return.
|
|
1866
|
+
#
|
|
1867
|
+
# @return [Types::StartQueryPerformanceMonitorOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1868
|
+
#
|
|
1869
|
+
# * {Types::StartQueryPerformanceMonitorOutput#query_id #query_id} => String
|
|
1870
|
+
#
|
|
1871
|
+
# @example Request syntax with placeholder values
|
|
1872
|
+
#
|
|
1873
|
+
# resp = client.start_query_performance_monitor({
|
|
1874
|
+
# monitor_name: "ResourceName", # required
|
|
1875
|
+
# start_time: Time.now, # required
|
|
1876
|
+
# end_time: Time.now, # required
|
|
1877
|
+
# query_type: "TOP_PATHS", # required, accepts TOP_PATHS
|
|
1878
|
+
# filter_parameters: [
|
|
1879
|
+
# {
|
|
1880
|
+
# field: "String", # required
|
|
1881
|
+
# operator: "EQUALS", # required, accepts EQUALS, NOT_EQUALS, IN, CONTAINS
|
|
1882
|
+
# values: ["String"], # required
|
|
1883
|
+
# },
|
|
1884
|
+
# ],
|
|
1885
|
+
# limit: 1,
|
|
1886
|
+
# })
|
|
1887
|
+
#
|
|
1888
|
+
# @example Response structure
|
|
1889
|
+
#
|
|
1890
|
+
# resp.query_id #=> String
|
|
1891
|
+
#
|
|
1892
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/StartQueryPerformanceMonitor AWS API Documentation
|
|
1893
|
+
#
|
|
1894
|
+
# @overload start_query_performance_monitor(params = {})
|
|
1895
|
+
# @param [Hash] params ({})
|
|
1896
|
+
def start_query_performance_monitor(params = {}, options = {})
|
|
1897
|
+
req = build_request(:start_query_performance_monitor, params)
|
|
1898
|
+
req.send_request(options)
|
|
1899
|
+
end
|
|
1900
|
+
|
|
1438
1901
|
# Create a query with the Network Flow Monitor query interface that you
|
|
1439
1902
|
# can run to return workload insights top contributors. Specify the
|
|
1440
1903
|
# scope that you want to create a query for.
|
|
@@ -1507,7 +1970,7 @@ module Aws::NetworkFlowMonitor
|
|
|
1507
1970
|
# start_time: Time.now, # required
|
|
1508
1971
|
# end_time: Time.now, # required
|
|
1509
1972
|
# metric_name: "TIMEOUTS", # required, accepts TIMEOUTS, RETRANSMISSIONS, DATA_TRANSFERRED
|
|
1510
|
-
# destination_category: "INTRA_AZ", # required, accepts INTRA_AZ, INTER_AZ, INTER_VPC, UNCLASSIFIED, AMAZON_S3, AMAZON_DYNAMODB, INTER_REGION
|
|
1973
|
+
# destination_category: "INTRA_AZ", # required, accepts INTRA_AZ, INTER_AZ, INTER_VPC, UNCLASSIFIED, AMAZON_S3, AMAZON_DYNAMODB, INTER_REGION, INTERNET, AWS_SERVICE, LOCAL_ZONE, TRANSIT_GATEWAY
|
|
1511
1974
|
# limit: 1,
|
|
1512
1975
|
# })
|
|
1513
1976
|
#
|
|
@@ -1593,7 +2056,7 @@ module Aws::NetworkFlowMonitor
|
|
|
1593
2056
|
# start_time: Time.now, # required
|
|
1594
2057
|
# end_time: Time.now, # required
|
|
1595
2058
|
# metric_name: "TIMEOUTS", # required, accepts TIMEOUTS, RETRANSMISSIONS, DATA_TRANSFERRED
|
|
1596
|
-
# destination_category: "INTRA_AZ", # required, accepts INTRA_AZ, INTER_AZ, INTER_VPC, UNCLASSIFIED, AMAZON_S3, AMAZON_DYNAMODB, INTER_REGION
|
|
2059
|
+
# destination_category: "INTRA_AZ", # required, accepts INTRA_AZ, INTER_AZ, INTER_VPC, UNCLASSIFIED, AMAZON_S3, AMAZON_DYNAMODB, INTER_REGION, INTERNET, AWS_SERVICE, LOCAL_ZONE, TRANSIT_GATEWAY
|
|
1597
2060
|
# })
|
|
1598
2061
|
#
|
|
1599
2062
|
# @example Response structure
|
|
@@ -1644,6 +2107,37 @@ module Aws::NetworkFlowMonitor
|
|
|
1644
2107
|
req.send_request(options)
|
|
1645
2108
|
end
|
|
1646
2109
|
|
|
2110
|
+
# Stop a query for the Network Flow Monitor query interface, for a
|
|
2111
|
+
# specified query ID and performance monitor. Use the same query ID that
|
|
2112
|
+
# you used for the corresponding API call to start the query,
|
|
2113
|
+
# `StartQueryPerformanceMonitor`.
|
|
2114
|
+
#
|
|
2115
|
+
# @option params [required, String] :monitor_name
|
|
2116
|
+
# The name of the performance monitor.
|
|
2117
|
+
#
|
|
2118
|
+
# @option params [required, String] :query_id
|
|
2119
|
+
# The identifier for the query. A query ID is an internally-generated
|
|
2120
|
+
# identifier for a specific query returned from an API call to start a
|
|
2121
|
+
# query.
|
|
2122
|
+
#
|
|
2123
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2124
|
+
#
|
|
2125
|
+
# @example Request syntax with placeholder values
|
|
2126
|
+
#
|
|
2127
|
+
# resp = client.stop_query_performance_monitor({
|
|
2128
|
+
# monitor_name: "ResourceName", # required
|
|
2129
|
+
# query_id: "String", # required
|
|
2130
|
+
# })
|
|
2131
|
+
#
|
|
2132
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/StopQueryPerformanceMonitor AWS API Documentation
|
|
2133
|
+
#
|
|
2134
|
+
# @overload stop_query_performance_monitor(params = {})
|
|
2135
|
+
# @param [Hash] params ({})
|
|
2136
|
+
def stop_query_performance_monitor(params = {}, options = {})
|
|
2137
|
+
req = build_request(:stop_query_performance_monitor, params)
|
|
2138
|
+
req.send_request(options)
|
|
2139
|
+
end
|
|
2140
|
+
|
|
1647
2141
|
# Stop a top contributors query for workload insights. Specify the query
|
|
1648
2142
|
# that you want to stop by providing a query ID and a scope ID.
|
|
1649
2143
|
#
|
|
@@ -1878,6 +2372,80 @@ module Aws::NetworkFlowMonitor
|
|
|
1878
2372
|
req.send_request(options)
|
|
1879
2373
|
end
|
|
1880
2374
|
|
|
2375
|
+
# Update a performance monitor, to add or remove the resources that the
|
|
2376
|
+
# monitor tracks network performance for.
|
|
2377
|
+
#
|
|
2378
|
+
# @option params [required, String] :monitor_name
|
|
2379
|
+
# The name of the performance monitor.
|
|
2380
|
+
#
|
|
2381
|
+
# @option params [Array<Types::PerformanceMonitorTarget>] :targets_to_add
|
|
2382
|
+
# The resources to add to the performance monitor.
|
|
2383
|
+
#
|
|
2384
|
+
# @option params [Array<Types::PerformanceMonitorTarget>] :targets_to_remove
|
|
2385
|
+
# The resources to remove from the performance monitor.
|
|
2386
|
+
#
|
|
2387
|
+
# @option params [String] :client_token
|
|
2388
|
+
# A unique, case-sensitive string of up to 64 ASCII characters that you
|
|
2389
|
+
# specify to make an idempotent API request. If the token matches a
|
|
2390
|
+
# previous request, the service ignores the request without returning an
|
|
2391
|
+
# error. Don't reuse the same client token for other API requests.
|
|
2392
|
+
#
|
|
2393
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
2394
|
+
# not need to pass this option.**
|
|
2395
|
+
#
|
|
2396
|
+
# @return [Types::UpdatePerformanceMonitorOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2397
|
+
#
|
|
2398
|
+
# * {Types::UpdatePerformanceMonitorOutput#monitor_arn #monitor_arn} => String
|
|
2399
|
+
# * {Types::UpdatePerformanceMonitorOutput#monitor_name #monitor_name} => String
|
|
2400
|
+
# * {Types::UpdatePerformanceMonitorOutput#monitor_status #monitor_status} => String
|
|
2401
|
+
# * {Types::UpdatePerformanceMonitorOutput#monitor_type #monitor_type} => String
|
|
2402
|
+
# * {Types::UpdatePerformanceMonitorOutput#targets #targets} => Array<Types::PerformanceMonitorTarget>
|
|
2403
|
+
# * {Types::UpdatePerformanceMonitorOutput#created_at #created_at} => Time
|
|
2404
|
+
# * {Types::UpdatePerformanceMonitorOutput#modified_at #modified_at} => Time
|
|
2405
|
+
# * {Types::UpdatePerformanceMonitorOutput#tags #tags} => Hash<String,String>
|
|
2406
|
+
#
|
|
2407
|
+
# @example Request syntax with placeholder values
|
|
2408
|
+
#
|
|
2409
|
+
# resp = client.update_performance_monitor({
|
|
2410
|
+
# monitor_name: "ResourceName", # required
|
|
2411
|
+
# targets_to_add: [
|
|
2412
|
+
# {
|
|
2413
|
+
# type: "AWS::EC2::VPC", # required, accepts AWS::EC2::VPC
|
|
2414
|
+
# identifier: "PerformanceMonitorTargetIdentifierString", # required
|
|
2415
|
+
# },
|
|
2416
|
+
# ],
|
|
2417
|
+
# targets_to_remove: [
|
|
2418
|
+
# {
|
|
2419
|
+
# type: "AWS::EC2::VPC", # required, accepts AWS::EC2::VPC
|
|
2420
|
+
# identifier: "PerformanceMonitorTargetIdentifierString", # required
|
|
2421
|
+
# },
|
|
2422
|
+
# ],
|
|
2423
|
+
# client_token: "UuidString",
|
|
2424
|
+
# })
|
|
2425
|
+
#
|
|
2426
|
+
# @example Response structure
|
|
2427
|
+
#
|
|
2428
|
+
# resp.monitor_arn #=> String
|
|
2429
|
+
# resp.monitor_name #=> String
|
|
2430
|
+
# resp.monitor_status #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "ERROR", "DELETING"
|
|
2431
|
+
# resp.monitor_type #=> String, one of "VPC"
|
|
2432
|
+
# resp.targets #=> Array
|
|
2433
|
+
# resp.targets[0].type #=> String, one of "AWS::EC2::VPC"
|
|
2434
|
+
# resp.targets[0].identifier #=> String
|
|
2435
|
+
# resp.created_at #=> Time
|
|
2436
|
+
# resp.modified_at #=> Time
|
|
2437
|
+
# resp.tags #=> Hash
|
|
2438
|
+
# resp.tags["TagKey"] #=> String
|
|
2439
|
+
#
|
|
2440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/UpdatePerformanceMonitor AWS API Documentation
|
|
2441
|
+
#
|
|
2442
|
+
# @overload update_performance_monitor(params = {})
|
|
2443
|
+
# @param [Hash] params ({})
|
|
2444
|
+
def update_performance_monitor(params = {}, options = {})
|
|
2445
|
+
req = build_request(:update_performance_monitor, params)
|
|
2446
|
+
req.send_request(options)
|
|
2447
|
+
end
|
|
2448
|
+
|
|
1881
2449
|
# Update a scope to add or remove resources that you want to be
|
|
1882
2450
|
# available for Network Flow Monitor to generate metrics for, when you
|
|
1883
2451
|
# have active agents on those resources sending metrics reports to the
|
|
@@ -1964,7 +2532,7 @@ module Aws::NetworkFlowMonitor
|
|
|
1964
2532
|
tracer: tracer
|
|
1965
2533
|
)
|
|
1966
2534
|
context[:gem_name] = 'aws-sdk-networkflowmonitor'
|
|
1967
|
-
context[:gem_version] = '1.
|
|
2535
|
+
context[:gem_version] = '1.41.0'
|
|
1968
2536
|
Seahorse::Client::Request.new(handlers, context)
|
|
1969
2537
|
end
|
|
1970
2538
|
|