@aws-sdk/client-networkflowmonitor 3.1169.0 → 3.1171.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.
Files changed (65) hide show
  1. package/README.md +70 -0
  2. package/dist-cjs/index.js +404 -9
  3. package/dist-es/NetworkFlowMonitor.js +26 -0
  4. package/dist-es/commands/CreatePerformanceMonitorCommand.js +4 -0
  5. package/dist-es/commands/DeletePerformanceMonitorCommand.js +4 -0
  6. package/dist-es/commands/GetMonitorScopeSuggestionsCommand.js +4 -0
  7. package/dist-es/commands/GetPerformanceMonitorCommand.js +4 -0
  8. package/dist-es/commands/GetQueryResultsPerformanceMonitorCommand.js +4 -0
  9. package/dist-es/commands/GetQueryStatusPerformanceMonitorCommand.js +4 -0
  10. package/dist-es/commands/ListPerformanceMonitorsCommand.js +4 -0
  11. package/dist-es/commands/StartQueryPerformanceMonitorCommand.js +4 -0
  12. package/dist-es/commands/StopQueryPerformanceMonitorCommand.js +4 -0
  13. package/dist-es/commands/UpdatePerformanceMonitorCommand.js +4 -0
  14. package/dist-es/commands/index.js +10 -0
  15. package/dist-es/models/enums.js +30 -0
  16. package/dist-es/pagination/GetMonitorScopeSuggestionsPaginator.js +4 -0
  17. package/dist-es/pagination/GetQueryResultsPerformanceMonitorPaginator.js +4 -0
  18. package/dist-es/pagination/ListPerformanceMonitorsPaginator.js +4 -0
  19. package/dist-es/pagination/index.js +3 -0
  20. package/dist-es/schemas/schemas_0.js +268 -8
  21. package/dist-types/NetworkFlowMonitor.d.ts +92 -0
  22. package/dist-types/NetworkFlowMonitorClient.d.ts +12 -2
  23. package/dist-types/commands/CreatePerformanceMonitorCommand.d.ts +114 -0
  24. package/dist-types/commands/DeletePerformanceMonitorCommand.d.ts +87 -0
  25. package/dist-types/commands/GetMonitorScopeSuggestionsCommand.d.ts +97 -0
  26. package/dist-types/commands/GetPerformanceMonitorCommand.d.ts +100 -0
  27. package/dist-types/commands/GetQueryResultsMonitorTopContributorsCommand.d.ts +12 -1
  28. package/dist-types/commands/GetQueryResultsPerformanceMonitorCommand.d.ts +103 -0
  29. package/dist-types/commands/GetQueryStatusPerformanceMonitorCommand.d.ts +90 -0
  30. package/dist-types/commands/ListPerformanceMonitorsCommand.d.ts +100 -0
  31. package/dist-types/commands/StartQueryMonitorTopContributorsCommand.d.ts +1 -1
  32. package/dist-types/commands/StartQueryPerformanceMonitorCommand.d.ts +102 -0
  33. package/dist-types/commands/StartQueryWorkloadInsightsTopContributorsCommand.d.ts +1 -1
  34. package/dist-types/commands/StartQueryWorkloadInsightsTopContributorsDataCommand.d.ts +1 -1
  35. package/dist-types/commands/StopQueryPerformanceMonitorCommand.d.ts +88 -0
  36. package/dist-types/commands/UpdatePerformanceMonitorCommand.d.ts +119 -0
  37. package/dist-types/commands/index.d.ts +10 -0
  38. package/dist-types/models/enums.d.ts +78 -0
  39. package/dist-types/models/models_0.d.ts +599 -1
  40. package/dist-types/pagination/GetMonitorScopeSuggestionsPaginator.d.ts +7 -0
  41. package/dist-types/pagination/GetQueryResultsPerformanceMonitorPaginator.d.ts +7 -0
  42. package/dist-types/pagination/ListPerformanceMonitorsPaginator.d.ts +7 -0
  43. package/dist-types/pagination/index.d.ts +3 -0
  44. package/dist-types/schemas/schemas_0.d.ts +38 -0
  45. package/dist-types/ts3.4/NetworkFlowMonitor.d.ts +192 -0
  46. package/dist-types/ts3.4/NetworkFlowMonitorClient.d.ts +60 -0
  47. package/dist-types/ts3.4/commands/CreatePerformanceMonitorCommand.d.ts +39 -0
  48. package/dist-types/ts3.4/commands/DeletePerformanceMonitorCommand.d.ts +39 -0
  49. package/dist-types/ts3.4/commands/GetMonitorScopeSuggestionsCommand.d.ts +42 -0
  50. package/dist-types/ts3.4/commands/GetPerformanceMonitorCommand.d.ts +39 -0
  51. package/dist-types/ts3.4/commands/GetQueryResultsPerformanceMonitorCommand.d.ts +42 -0
  52. package/dist-types/ts3.4/commands/GetQueryStatusPerformanceMonitorCommand.d.ts +42 -0
  53. package/dist-types/ts3.4/commands/ListPerformanceMonitorsCommand.d.ts +39 -0
  54. package/dist-types/ts3.4/commands/StartQueryPerformanceMonitorCommand.d.ts +42 -0
  55. package/dist-types/ts3.4/commands/StopQueryPerformanceMonitorCommand.d.ts +42 -0
  56. package/dist-types/ts3.4/commands/UpdatePerformanceMonitorCommand.d.ts +39 -0
  57. package/dist-types/ts3.4/commands/index.d.ts +10 -0
  58. package/dist-types/ts3.4/models/enums.d.ts +39 -0
  59. package/dist-types/ts3.4/models/models_0.d.ts +150 -0
  60. package/dist-types/ts3.4/pagination/GetMonitorScopeSuggestionsPaginator.d.ts +11 -0
  61. package/dist-types/ts3.4/pagination/GetQueryResultsPerformanceMonitorPaginator.d.ts +11 -0
  62. package/dist-types/ts3.4/pagination/ListPerformanceMonitorsPaginator.d.ts +11 -0
  63. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  64. package/dist-types/ts3.4/schemas/schemas_0.d.ts +38 -0
  65. package/package.json +1 -1
@@ -1,4 +1,78 @@
1
- import type { DestinationCategory, MetricUnit, MonitorLocalResourceType, MonitorMetric, MonitorRemoteResourceType, MonitorStatus, QueryStatus, ScopeStatus, TargetType, WorkloadInsightsMetric } from "./enums";
1
+ import type { DestinationCategory, FilterOperator, MetricUnit, MonitorLocalResourceType, MonitorMetric, MonitorRemoteResourceType, MonitorStatus, OrgMembershipStatus, PerformanceMonitorQueryType, PerformanceMonitorTargetType, PerformanceMonitorType, QueryStatus, ScopeCoverageStatus, ScopeStatus, TargetType, WorkloadInsightsMetric } from "./enums";
2
+ /**
3
+ * <p>An account that you can add to the monitoring scope for a monitor, so that Network Flow Monitor can resolve the network paths for traffic to and from resources in the account.</p>
4
+ * @public
5
+ */
6
+ export interface AccountToAdd {
7
+ /**
8
+ * <p>The ID of the account that you can add to the monitoring scope.</p>
9
+ * @public
10
+ */
11
+ accountId: string | undefined;
12
+ /**
13
+ * <p>The Amazon Web Services Region of the traffic that Network Flow Monitor identified for the account.</p>
14
+ * @public
15
+ */
16
+ region: string | undefined;
17
+ /**
18
+ * <p>Whether the account is a member of the same organization as the account that owns the monitor. The membership status can be one of the following</p> <ul> <li> <p> <code>IN_ORG</code>: The account is a member of the same organization.</p> </li> <li> <p> <code>NOT_IN_ORG</code>: The account isn't a member of the same organization.</p> </li> <li> <p> <code>UNKNOWN</code>: Network Flow Monitor can't determine the organization membership of the account.</p> </li> </ul>
19
+ * @public
20
+ */
21
+ membership: OrgMembershipStatus | undefined;
22
+ }
23
+ /**
24
+ * <p>The geographic location of the client for a network flow.</p>
25
+ * @public
26
+ */
27
+ export interface ClientLocation {
28
+ /**
29
+ * <p>The city where the client is located.</p>
30
+ * @public
31
+ */
32
+ city?: string | undefined;
33
+ /**
34
+ * <p>The subdivision, such as a state or province, where the client is located.</p>
35
+ * @public
36
+ */
37
+ subdivision?: string | undefined;
38
+ /**
39
+ * <p>The country where the client is located.</p>
40
+ * @public
41
+ */
42
+ country?: string | undefined;
43
+ }
44
+ /**
45
+ * <p>The network that an address in a network flow belongs to.</p>
46
+ * @public
47
+ */
48
+ export interface Network {
49
+ /**
50
+ * <p>The name of the autonomous system that the network belongs to.</p>
51
+ * @public
52
+ */
53
+ asName?: string | undefined;
54
+ /**
55
+ * <p>The autonomous system number (ASN) of the autonomous system that the network belongs to.</p>
56
+ * @public
57
+ */
58
+ asNumber?: number | undefined;
59
+ }
60
+ /**
61
+ * <p>Additional information about a network flow, such as the network that the remote address belongs to and the location of the client.</p>
62
+ * @public
63
+ */
64
+ export interface AdditionalFlowInfo {
65
+ /**
66
+ * <p>The network that the remote address of the network flow belongs to.</p>
67
+ * @public
68
+ */
69
+ network?: Network | undefined;
70
+ /**
71
+ * <p>The location of the client for the network flow.</p>
72
+ * @public
73
+ */
74
+ clientLocation?: ClientLocation | undefined;
75
+ }
2
76
  /**
3
77
  * <p>A local resource is the host where the agent is installed. Local resources can be a a subnet, a VPC, an Availability Zone, an EKS cluster or an Amazon Web Services Region.</p>
4
78
  * @public
@@ -111,6 +185,97 @@ export interface CreateMonitorOutput {
111
185
  */
112
186
  tags?: Record<string, string> | undefined;
113
187
  }
188
+ /**
189
+ * <p>A resource that a performance monitor tracks network performance for.</p>
190
+ * @public
191
+ */
192
+ export interface PerformanceMonitorTarget {
193
+ /**
194
+ * <p>The type of the resource that you want Network Flow Monitor to track network performance for. Specify <code>AWS::EC2::VPC</code>.</p>
195
+ * @public
196
+ */
197
+ type: PerformanceMonitorTargetType | undefined;
198
+ /**
199
+ * <p>The Amazon Resource Name (ARN) of the resource that you want Network Flow Monitor to track network performance for.</p>
200
+ * @public
201
+ */
202
+ identifier: string | undefined;
203
+ }
204
+ /**
205
+ * @public
206
+ */
207
+ export interface CreatePerformanceMonitorInput {
208
+ /**
209
+ * <p>The name of the performance monitor.</p>
210
+ * @public
211
+ */
212
+ monitorName: string | undefined;
213
+ /**
214
+ * <p>The Amazon Resource Name (ARN) of the scope for the performance monitor.</p>
215
+ * @public
216
+ */
217
+ scopeArn?: string | undefined;
218
+ /**
219
+ * <p>The resources to monitor. Each target identifies a resource, currently a VPC, for which you can track network performance. For a VPC, specify the VPC ARN.</p>
220
+ * @public
221
+ */
222
+ targets: PerformanceMonitorTarget[] | undefined;
223
+ /**
224
+ * <p>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. If the token matches a previous request, the service ignores the request without returning an error. Don't reuse the same client token for other API requests.</p>
225
+ * @public
226
+ */
227
+ clientToken?: string | undefined;
228
+ /**
229
+ * <p>The tags for a performance monitor. You can add a maximum of 200 tags.</p>
230
+ * @public
231
+ */
232
+ tags?: Record<string, string> | undefined;
233
+ }
234
+ /**
235
+ * @public
236
+ */
237
+ export interface CreatePerformanceMonitorOutput {
238
+ /**
239
+ * <p>The Amazon Resource Name (ARN) of the performance monitor.</p>
240
+ * @public
241
+ */
242
+ monitorArn: string | undefined;
243
+ /**
244
+ * <p>The name of the performance monitor.</p>
245
+ * @public
246
+ */
247
+ monitorName: string | undefined;
248
+ /**
249
+ * <p>The status of a performance monitor. The status can be one of the following</p> <ul> <li> <p> <code>PENDING</code>: The performance monitor is in the process of being created.</p> </li> <li> <p> <code>ACTIVE</code>: The performance monitor is active.</p> </li> <li> <p> <code>INACTIVE</code>: The performance monitor is inactive.</p> </li> <li> <p> <code>ERROR</code>: The performance monitor can't be created or updated.</p> </li> <li> <p> <code>DELETING</code>: The performance monitor is in the process of being deleted.</p> </li> </ul>
250
+ * @public
251
+ */
252
+ monitorStatus: MonitorStatus | undefined;
253
+ /**
254
+ * <p>The type of resource that you monitor determines the type of the performance monitor.</p>
255
+ * @public
256
+ */
257
+ monitorType: PerformanceMonitorType | undefined;
258
+ /**
259
+ * <p>The resources that the performance monitor tracks network performance for.</p>
260
+ * @public
261
+ */
262
+ targets: PerformanceMonitorTarget[] | undefined;
263
+ /**
264
+ * <p>The date and time when the performance monitor was created.</p>
265
+ * @public
266
+ */
267
+ createdAt: Date | undefined;
268
+ /**
269
+ * <p>The date and time when the performance monitor was last modified.</p>
270
+ * @public
271
+ */
272
+ modifiedAt: Date | undefined;
273
+ /**
274
+ * <p>The tags for a performance monitor.</p>
275
+ * @public
276
+ */
277
+ tags?: Record<string, string> | undefined;
278
+ }
114
279
  /**
115
280
  * <p>A target ID is an internally-generated identifier for a target. A target allows you to identify all the resources in a Network Flow Monitor scope. Currently, a target is always an Amazon Web Services account.</p>
116
281
  * @public
@@ -236,6 +401,21 @@ export interface DeleteMonitorInput {
236
401
  */
237
402
  export interface DeleteMonitorOutput {
238
403
  }
404
+ /**
405
+ * @public
406
+ */
407
+ export interface DeletePerformanceMonitorInput {
408
+ /**
409
+ * <p>The name of the performance monitor.</p>
410
+ * @public
411
+ */
412
+ monitorName: string | undefined;
413
+ }
414
+ /**
415
+ * @public
416
+ */
417
+ export interface DeletePerformanceMonitorOutput {
418
+ }
239
419
  /**
240
420
  * @public
241
421
  */
@@ -251,6 +431,27 @@ export interface DeleteScopeInput {
251
431
  */
252
432
  export interface DeleteScopeOutput {
253
433
  }
434
+ /**
435
+ * <p>A filter for a query, to return a subset of the results.</p>
436
+ * @public
437
+ */
438
+ export interface FilterParameter {
439
+ /**
440
+ * <p>The name of the field that you want to filter on. The fields that you can specify depend on the type of query.</p>
441
+ * @public
442
+ */
443
+ field: string | undefined;
444
+ /**
445
+ * <p>The operator to use to compare the field with the values that you specify. The operator can be one of the following</p> <ul> <li> <p> <code>EQUALS</code>: The field matches a single value.</p> </li> <li> <p> <code>NOT_EQUALS</code>: The field doesn't match a single value.</p> </li> <li> <p> <code>IN</code>: The field matches any one of several values.</p> </li> <li> <p> <code>CONTAINS</code>: The field contains a value.</p> </li> </ul>
446
+ * @public
447
+ */
448
+ operator: FilterOperator | undefined;
449
+ /**
450
+ * <p>The values to compare the field with.</p>
451
+ * @public
452
+ */
453
+ values: string[] | undefined;
454
+ }
254
455
  /**
255
456
  * @public
256
457
  */
@@ -306,6 +507,106 @@ export interface GetMonitorOutput {
306
507
  */
307
508
  tags?: Record<string, string> | undefined;
308
509
  }
510
+ /**
511
+ * @public
512
+ */
513
+ export interface GetMonitorScopeSuggestionsInput {
514
+ /**
515
+ * <p>The Amazon Resource Name (ARN) of the monitor that you want to return scope suggestions for.</p>
516
+ * @public
517
+ */
518
+ monitorArn: string | undefined;
519
+ /**
520
+ * <p>The number of query results that you want to return with this call.</p>
521
+ * @public
522
+ */
523
+ maxResults?: number | undefined;
524
+ /**
525
+ * <p>The token for the next set of results. You receive this token from a previous call.</p>
526
+ * @public
527
+ */
528
+ nextToken?: string | undefined;
529
+ }
530
+ /**
531
+ * @public
532
+ */
533
+ export interface GetMonitorScopeSuggestionsOutput {
534
+ /**
535
+ * <p>The coverage status of the monitoring scope for the monitor. The status can be one of the following</p> <ul> <li> <p> <code>COMPLETE</code>: The scope includes every account that sends traffic to, or receives traffic from, resources in the monitor.</p> </li> <li> <p> <code>INCOMPLETE</code>: There are accounts that you can add to the scope.</p> </li> <li> <p> <code>PENDING</code>: Network Flow Monitor is determining the coverage of the scope.</p> </li> <li> <p> <code>STALE</code>: The coverage of the scope was last determined too long ago to be current.</p> </li> </ul>
536
+ * @public
537
+ */
538
+ status: ScopeCoverageStatus | undefined;
539
+ /**
540
+ * <p>The accounts that you can add to the monitoring scope, so that Network Flow Monitor can resolve the network paths for traffic to and from resources in those accounts.</p>
541
+ * @public
542
+ */
543
+ accountsToAdd: AccountToAdd[] | undefined;
544
+ /**
545
+ * <p>The token for the next set of results. You receive this token from a previous call.</p>
546
+ * @public
547
+ */
548
+ nextToken?: string | undefined;
549
+ /**
550
+ * <p>The date and time when Network Flow Monitor last determined the coverage of the monitoring scope.</p>
551
+ * @public
552
+ */
553
+ updatedAt?: Date | undefined;
554
+ }
555
+ /**
556
+ * @public
557
+ */
558
+ export interface GetPerformanceMonitorInput {
559
+ /**
560
+ * <p>The name of the performance monitor.</p>
561
+ * @public
562
+ */
563
+ monitorName: string | undefined;
564
+ }
565
+ /**
566
+ * @public
567
+ */
568
+ export interface GetPerformanceMonitorOutput {
569
+ /**
570
+ * <p>The Amazon Resource Name (ARN) of the performance monitor.</p>
571
+ * @public
572
+ */
573
+ monitorArn: string | undefined;
574
+ /**
575
+ * <p>The name of the performance monitor.</p>
576
+ * @public
577
+ */
578
+ monitorName: string | undefined;
579
+ /**
580
+ * <p>The status of a performance monitor. The status can be one of the following</p> <ul> <li> <p> <code>PENDING</code>: The performance monitor is in the process of being created.</p> </li> <li> <p> <code>ACTIVE</code>: The performance monitor is active.</p> </li> <li> <p> <code>INACTIVE</code>: The performance monitor is inactive.</p> </li> <li> <p> <code>ERROR</code>: The performance monitor can't be created or updated.</p> </li> <li> <p> <code>DELETING</code>: The performance monitor is in the process of being deleted.</p> </li> </ul>
581
+ * @public
582
+ */
583
+ monitorStatus: MonitorStatus | undefined;
584
+ /**
585
+ * <p>The type of resource that you monitor determines the type of the performance monitor.</p>
586
+ * @public
587
+ */
588
+ monitorType: PerformanceMonitorType | undefined;
589
+ /**
590
+ * <p>The resources that the performance monitor tracks network performance for.</p>
591
+ * @public
592
+ */
593
+ targets: PerformanceMonitorTarget[] | undefined;
594
+ /**
595
+ * <p>The date and time when the performance monitor was created.</p>
596
+ * @public
597
+ */
598
+ createdAt: Date | undefined;
599
+ /**
600
+ * <p>The date and time when the performance monitor was last modified.</p>
601
+ * @public
602
+ */
603
+ modifiedAt: Date | undefined;
604
+ /**
605
+ * <p>The tags for a performance monitor.</p>
606
+ * @public
607
+ */
608
+ tags?: Record<string, string> | undefined;
609
+ }
309
610
  /**
310
611
  * @public
311
612
  */
@@ -523,6 +824,11 @@ export interface MonitorTopContributorsRow {
523
824
  * @public
524
825
  */
525
826
  remoteVpcArn?: string | undefined;
827
+ /**
828
+ * <p>Additional information about the network flow, such as the network that the remote address belongs to and the location of the client.</p>
829
+ * @public
830
+ */
831
+ additionalFlowInfo?: AdditionalFlowInfo | undefined;
526
832
  }
527
833
  /**
528
834
  * @public
@@ -544,6 +850,67 @@ export interface GetQueryResultsMonitorTopContributorsOutput {
544
850
  */
545
851
  nextToken?: string | undefined;
546
852
  }
853
+ /**
854
+ * @public
855
+ */
856
+ export interface GetQueryResultsPerformanceMonitorInput {
857
+ /**
858
+ * <p>The name of the performance monitor.</p>
859
+ * @public
860
+ */
861
+ monitorName: string | undefined;
862
+ /**
863
+ * <p>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.</p>
864
+ * @public
865
+ */
866
+ queryId: string | undefined;
867
+ /**
868
+ * <p>The token for the next set of results. You receive this token from a previous call.</p>
869
+ * @public
870
+ */
871
+ nextToken?: string | undefined;
872
+ /**
873
+ * <p>The number of query results that you want to return with this call.</p>
874
+ * @public
875
+ */
876
+ maxResults?: number | undefined;
877
+ }
878
+ /**
879
+ * <p>A column that a query returns, with its name and data type.</p>
880
+ * @public
881
+ */
882
+ export interface QueryField {
883
+ /**
884
+ * <p>The name of the column.</p>
885
+ * @public
886
+ */
887
+ name: string | undefined;
888
+ /**
889
+ * <p>The data type of the values in the column.</p>
890
+ * @public
891
+ */
892
+ type: string | undefined;
893
+ }
894
+ /**
895
+ * @public
896
+ */
897
+ export interface GetQueryResultsPerformanceMonitorOutput {
898
+ /**
899
+ * <p>The columns that the query returns, in the order that the values for each row appear in <code>data</code>.</p>
900
+ * @public
901
+ */
902
+ fields: QueryField[] | undefined;
903
+ /**
904
+ * <p>The results of the query. Each row contains the values for the columns that <code>fields</code> describes, in the same order.</p>
905
+ * @public
906
+ */
907
+ data: (string | null)[][] | undefined;
908
+ /**
909
+ * <p>The token for the next set of results. You receive this token from a previous call.</p>
910
+ * @public
911
+ */
912
+ nextToken?: string | undefined;
913
+ }
547
914
  /**
548
915
  * @public
549
916
  */
@@ -726,6 +1093,31 @@ export interface GetQueryStatusMonitorTopContributorsOutput {
726
1093
  */
727
1094
  status: QueryStatus | undefined;
728
1095
  }
1096
+ /**
1097
+ * @public
1098
+ */
1099
+ export interface GetQueryStatusPerformanceMonitorInput {
1100
+ /**
1101
+ * <p>The name of the performance monitor.</p>
1102
+ * @public
1103
+ */
1104
+ monitorName: string | undefined;
1105
+ /**
1106
+ * <p>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.</p>
1107
+ * @public
1108
+ */
1109
+ queryId: string | undefined;
1110
+ }
1111
+ /**
1112
+ * @public
1113
+ */
1114
+ export interface GetQueryStatusPerformanceMonitorOutput {
1115
+ /**
1116
+ * <p>When you run a query, use this call to check the status of the query to make sure that the query has <code>SUCCEEDED</code> before you review the results.</p> <ul> <li> <p> <code>QUEUED</code>: The query is scheduled to run.</p> </li> <li> <p> <code>RUNNING</code>: The query is in progress but not complete.</p> </li> <li> <p> <code>SUCCEEDED</code>: The query completed successfully.</p> </li> <li> <p> <code>FAILED</code>: The query failed due to an error.</p> </li> <li> <p> <code>CANCELED</code>: The query was canceled.</p> </li> </ul>
1117
+ * @public
1118
+ */
1119
+ status: QueryStatus | undefined;
1120
+ }
729
1121
  /**
730
1122
  * @public
731
1123
  */
@@ -872,6 +1264,77 @@ export interface ListMonitorsOutput {
872
1264
  */
873
1265
  nextToken?: string | undefined;
874
1266
  }
1267
+ /**
1268
+ * @public
1269
+ */
1270
+ export interface ListPerformanceMonitorsInput {
1271
+ /**
1272
+ * <p>The token for the next set of results. You receive this token from a previous call.</p>
1273
+ * @public
1274
+ */
1275
+ nextToken?: string | undefined;
1276
+ /**
1277
+ * <p>The number of performance monitors that you want to return with this call. If you don't specify a value, the default is 25.</p>
1278
+ * @public
1279
+ */
1280
+ maxResults?: number | undefined;
1281
+ /**
1282
+ * <p>The status of the performance monitors that you want to return. If you don't specify a status, Network Flow Monitor returns performance monitors with any status.</p>
1283
+ * @public
1284
+ */
1285
+ monitorStatus?: MonitorStatus | undefined;
1286
+ /**
1287
+ * <p>The type of the performance monitors that you want to return. If you don't specify a type, Network Flow Monitor returns performance monitors of any type.</p>
1288
+ * @public
1289
+ */
1290
+ monitorType?: PerformanceMonitorType | undefined;
1291
+ }
1292
+ /**
1293
+ * <p>A summary of information about a performance monitor, including the ARN, the name, the status, and the resources that it tracks network performance for.</p>
1294
+ * @public
1295
+ */
1296
+ export interface PerformanceMonitorSummary {
1297
+ /**
1298
+ * <p>The Amazon Resource Name (ARN) of the performance monitor.</p>
1299
+ * @public
1300
+ */
1301
+ monitorArn: string | undefined;
1302
+ /**
1303
+ * <p>The name of the performance monitor.</p>
1304
+ * @public
1305
+ */
1306
+ monitorName: string | undefined;
1307
+ /**
1308
+ * <p>The status of a performance monitor. The status can be one of the following</p> <ul> <li> <p> <code>PENDING</code>: The performance monitor is in the process of being created.</p> </li> <li> <p> <code>ACTIVE</code>: The performance monitor is active.</p> </li> <li> <p> <code>INACTIVE</code>: The performance monitor is inactive.</p> </li> <li> <p> <code>ERROR</code>: The performance monitor can't be created or updated.</p> </li> <li> <p> <code>DELETING</code>: The performance monitor is in the process of being deleted.</p> </li> </ul>
1309
+ * @public
1310
+ */
1311
+ monitorStatus: MonitorStatus | undefined;
1312
+ /**
1313
+ * <p>The type of resource that you monitor determines the type of the performance monitor.</p>
1314
+ * @public
1315
+ */
1316
+ monitorType: PerformanceMonitorType | undefined;
1317
+ /**
1318
+ * <p>The resources that the performance monitor tracks network performance for.</p>
1319
+ * @public
1320
+ */
1321
+ targets?: PerformanceMonitorTarget[] | undefined;
1322
+ }
1323
+ /**
1324
+ * @public
1325
+ */
1326
+ export interface ListPerformanceMonitorsOutput {
1327
+ /**
1328
+ * <p>The performance monitors in the account.</p>
1329
+ * @public
1330
+ */
1331
+ monitors: PerformanceMonitorSummary[] | undefined;
1332
+ /**
1333
+ * <p>The token for the next set of results. You receive this token from a previous call.</p>
1334
+ * @public
1335
+ */
1336
+ nextToken?: string | undefined;
1337
+ }
875
1338
  /**
876
1339
  * @public
877
1340
  */
@@ -1088,6 +1551,141 @@ export interface UpdateMonitorOutput {
1088
1551
  */
1089
1552
  tags?: Record<string, string> | undefined;
1090
1553
  }
1554
+ /**
1555
+ * @public
1556
+ */
1557
+ export interface StartQueryPerformanceMonitorInput {
1558
+ /**
1559
+ * <p>The name of the performance monitor.</p>
1560
+ * @public
1561
+ */
1562
+ monitorName: string | undefined;
1563
+ /**
1564
+ * <p>The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.</p>
1565
+ * @public
1566
+ */
1567
+ startTime: Date | undefined;
1568
+ /**
1569
+ * <p>The timestamp that is the date and time end of the period that you want to retrieve results for with your query.</p>
1570
+ * @public
1571
+ */
1572
+ endTime: Date | undefined;
1573
+ /**
1574
+ * <p>The type of query that you want to create. Specify <code>TOP_PATHS</code> to return the top paths for the performance monitor.</p>
1575
+ * @public
1576
+ */
1577
+ queryType: PerformanceMonitorQueryType | undefined;
1578
+ /**
1579
+ * <p>The filters for the query, to return a subset of the top paths. For a <code>TOP_PATHS</code> query, you can filter on the following fields:</p> <ul> <li> <p> <code>local_az_id</code>: The Availability Zone ID of the local end of a path</p> </li> <li> <p> <code>remote_az_id</code>: The Availability Zone ID of the remote end of a path</p> </li> <li> <p> <code>impact_level</code>: The impact level of a path</p> </li> </ul> <p>When you filter on <code>impact_level</code>, Network Flow Monitor compares the filter with the most severe impact level for the path over the time period of the query, and the traffic and round-trip time that Network Flow Monitor returns for each path still cover the full time period. Paths that have no impact data don't match an <code>impact_level</code> filter, including a <code>NOT_EQUALS</code> filter. Network Flow Monitor doesn't filter the subnet pairs within a path by impact level.</p>
1580
+ * @public
1581
+ */
1582
+ filterParameters?: FilterParameter[] | undefined;
1583
+ /**
1584
+ * <p>The maximum number of top paths that you want the query to return.</p>
1585
+ * @public
1586
+ */
1587
+ limit?: number | undefined;
1588
+ }
1589
+ /**
1590
+ * @public
1591
+ */
1592
+ export interface StartQueryPerformanceMonitorOutput {
1593
+ /**
1594
+ * <p>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.</p>
1595
+ * @public
1596
+ */
1597
+ queryId: string | undefined;
1598
+ }
1599
+ /**
1600
+ * @public
1601
+ */
1602
+ export interface StopQueryPerformanceMonitorInput {
1603
+ /**
1604
+ * <p>The name of the performance monitor.</p>
1605
+ * @public
1606
+ */
1607
+ monitorName: string | undefined;
1608
+ /**
1609
+ * <p>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.</p>
1610
+ * @public
1611
+ */
1612
+ queryId: string | undefined;
1613
+ }
1614
+ /**
1615
+ * @public
1616
+ */
1617
+ export interface StopQueryPerformanceMonitorOutput {
1618
+ }
1619
+ /**
1620
+ * @public
1621
+ */
1622
+ export interface UpdatePerformanceMonitorInput {
1623
+ /**
1624
+ * <p>The name of the performance monitor.</p>
1625
+ * @public
1626
+ */
1627
+ monitorName: string | undefined;
1628
+ /**
1629
+ * <p>The resources to add to the performance monitor.</p>
1630
+ * @public
1631
+ */
1632
+ targetsToAdd?: PerformanceMonitorTarget[] | undefined;
1633
+ /**
1634
+ * <p>The resources to remove from the performance monitor.</p>
1635
+ * @public
1636
+ */
1637
+ targetsToRemove?: PerformanceMonitorTarget[] | undefined;
1638
+ /**
1639
+ * <p>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. If the token matches a previous request, the service ignores the request without returning an error. Don't reuse the same client token for other API requests.</p>
1640
+ * @public
1641
+ */
1642
+ clientToken?: string | undefined;
1643
+ }
1644
+ /**
1645
+ * @public
1646
+ */
1647
+ export interface UpdatePerformanceMonitorOutput {
1648
+ /**
1649
+ * <p>The Amazon Resource Name (ARN) of the performance monitor.</p>
1650
+ * @public
1651
+ */
1652
+ monitorArn: string | undefined;
1653
+ /**
1654
+ * <p>The name of the performance monitor.</p>
1655
+ * @public
1656
+ */
1657
+ monitorName: string | undefined;
1658
+ /**
1659
+ * <p>The status of a performance monitor. The status can be one of the following</p> <ul> <li> <p> <code>PENDING</code>: The performance monitor is in the process of being created.</p> </li> <li> <p> <code>ACTIVE</code>: The performance monitor is active.</p> </li> <li> <p> <code>INACTIVE</code>: The performance monitor is inactive.</p> </li> <li> <p> <code>ERROR</code>: The performance monitor can't be created or updated.</p> </li> <li> <p> <code>DELETING</code>: The performance monitor is in the process of being deleted.</p> </li> </ul>
1660
+ * @public
1661
+ */
1662
+ monitorStatus: MonitorStatus | undefined;
1663
+ /**
1664
+ * <p>The type of resource that you monitor determines the type of the performance monitor.</p>
1665
+ * @public
1666
+ */
1667
+ monitorType: PerformanceMonitorType | undefined;
1668
+ /**
1669
+ * <p>The resources that the performance monitor tracks network performance for.</p>
1670
+ * @public
1671
+ */
1672
+ targets: PerformanceMonitorTarget[] | undefined;
1673
+ /**
1674
+ * <p>The date and time when the performance monitor was created.</p>
1675
+ * @public
1676
+ */
1677
+ createdAt: Date | undefined;
1678
+ /**
1679
+ * <p>The date and time when the performance monitor was last modified.</p>
1680
+ * @public
1681
+ */
1682
+ modifiedAt: Date | undefined;
1683
+ /**
1684
+ * <p>The tags for a performance monitor.</p>
1685
+ * @public
1686
+ */
1687
+ tags?: Record<string, string> | undefined;
1688
+ }
1091
1689
  /**
1092
1690
  * @public
1093
1691
  */
@@ -0,0 +1,7 @@
1
+ import type { Paginator } from "@smithy/types";
2
+ import { GetMonitorScopeSuggestionsCommandInput, GetMonitorScopeSuggestionsCommandOutput } from "../commands/GetMonitorScopeSuggestionsCommand";
3
+ import type { NetworkFlowMonitorPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
7
+ export declare const paginateGetMonitorScopeSuggestions: (config: NetworkFlowMonitorPaginationConfiguration, input: GetMonitorScopeSuggestionsCommandInput, ...rest: any[]) => Paginator<GetMonitorScopeSuggestionsCommandOutput>;
@@ -0,0 +1,7 @@
1
+ import type { Paginator } from "@smithy/types";
2
+ import { GetQueryResultsPerformanceMonitorCommandInput, GetQueryResultsPerformanceMonitorCommandOutput } from "../commands/GetQueryResultsPerformanceMonitorCommand";
3
+ import type { NetworkFlowMonitorPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
7
+ export declare const paginateGetQueryResultsPerformanceMonitor: (config: NetworkFlowMonitorPaginationConfiguration, input: GetQueryResultsPerformanceMonitorCommandInput, ...rest: any[]) => Paginator<GetQueryResultsPerformanceMonitorCommandOutput>;
@@ -0,0 +1,7 @@
1
+ import type { Paginator } from "@smithy/types";
2
+ import { ListPerformanceMonitorsCommandInput, ListPerformanceMonitorsCommandOutput } from "../commands/ListPerformanceMonitorsCommand";
3
+ import type { NetworkFlowMonitorPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
7
+ export declare const paginateListPerformanceMonitors: (config: NetworkFlowMonitorPaginationConfiguration, input: ListPerformanceMonitorsCommandInput, ...rest: any[]) => Paginator<ListPerformanceMonitorsCommandOutput>;