@aws-sdk/client-networkflowmonitor 3.846.0 → 3.847.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 (28) hide show
  1. package/README.md +1 -13
  2. package/dist-cjs/models/models_0.js +2 -0
  3. package/dist-es/models/models_0.js +2 -0
  4. package/dist-types/NetworkFlowMonitor.d.ts +1 -13
  5. package/dist-types/NetworkFlowMonitorClient.d.ts +1 -13
  6. package/dist-types/commands/CreateMonitorCommand.d.ts +1 -5
  7. package/dist-types/commands/CreateScopeCommand.d.ts +2 -6
  8. package/dist-types/commands/GetMonitorCommand.d.ts +1 -2
  9. package/dist-types/commands/GetQueryResultsMonitorTopContributorsCommand.d.ts +1 -10
  10. package/dist-types/commands/GetQueryResultsWorkloadInsightsTopContributorsCommand.d.ts +1 -13
  11. package/dist-types/commands/GetQueryResultsWorkloadInsightsTopContributorsDataCommand.d.ts +1 -15
  12. package/dist-types/commands/GetQueryStatusMonitorTopContributorsCommand.d.ts +1 -7
  13. package/dist-types/commands/GetQueryStatusWorkloadInsightsTopContributorsCommand.d.ts +1 -10
  14. package/dist-types/commands/GetQueryStatusWorkloadInsightsTopContributorsDataCommand.d.ts +1 -11
  15. package/dist-types/commands/GetScopeCommand.d.ts +2 -3
  16. package/dist-types/commands/ListMonitorsCommand.d.ts +1 -2
  17. package/dist-types/commands/ListScopesCommand.d.ts +1 -1
  18. package/dist-types/commands/StartQueryMonitorTopContributorsCommand.d.ts +1 -10
  19. package/dist-types/commands/StartQueryWorkloadInsightsTopContributorsCommand.d.ts +1 -10
  20. package/dist-types/commands/StartQueryWorkloadInsightsTopContributorsDataCommand.d.ts +1 -10
  21. package/dist-types/commands/StopQueryMonitorTopContributorsCommand.d.ts +1 -7
  22. package/dist-types/commands/StopQueryWorkloadInsightsTopContributorsCommand.d.ts +1 -7
  23. package/dist-types/commands/StopQueryWorkloadInsightsTopContributorsDataCommand.d.ts +1 -7
  24. package/dist-types/commands/UpdateScopeCommand.d.ts +2 -3
  25. package/dist-types/index.d.ts +1 -13
  26. package/dist-types/models/models_0.d.ts +75 -434
  27. package/dist-types/ts3.4/models/models_0.d.ts +2 -0
  28. package/package.json +1 -1
@@ -38,14 +38,12 @@ export declare const MonitorLocalResourceType: {
38
38
  */
39
39
  export type MonitorLocalResourceType = (typeof MonitorLocalResourceType)[keyof typeof MonitorLocalResourceType];
40
40
  /**
41
- * <p>A local resource is the host where the agent is installed. Local resources can be a
42
- * a subnet, a VPC, or an Availability Zone.</p>
41
+ * <p>A local resource is the host where the agent is installed. Local resources can be a a subnet, a VPC, or an Availability Zone.</p>
43
42
  * @public
44
43
  */
45
44
  export interface MonitorLocalResource {
46
45
  /**
47
- * <p>The type of the local resource. Valid values are <code>AWS::EC2::VPC</code>
48
- * <code>AWS::AvailabilityZone</code> or <code>AWS::EC2::Subnet</code>.</p>
46
+ * <p>The type of the local resource. Valid values are <code>AWS::EC2::VPC</code> <code>AWS::AvailabilityZone</code> or <code>AWS::EC2::Subnet</code>.</p>
49
47
  * @public
50
48
  */
51
49
  type: MonitorLocalResourceType | undefined;
@@ -70,16 +68,12 @@ export declare const MonitorRemoteResourceType: {
70
68
  */
71
69
  export type MonitorRemoteResourceType = (typeof MonitorRemoteResourceType)[keyof typeof MonitorRemoteResourceType];
72
70
  /**
73
- * <p>A remote resource is the other endpoint in a network flow. That is, one endpoint
74
- * is the local resource and the other is the remote resource. Remote resources can be a
75
- * a subnet, a VPC, an Availability Zone, or an Amazon Web Services service. </p>
71
+ * <p>A remote resource is the other endpoint in a network flow. That is, one endpoint is the local resource and the other is the remote resource. Remote resources can be a a subnet, a VPC, an Availability Zone, or an Amazon Web Services service. </p>
76
72
  * @public
77
73
  */
78
74
  export interface MonitorRemoteResource {
79
75
  /**
80
- * <p>The type of the remote resource. Valid values are <code>AWS::EC2::VPC</code>
81
- * <code>AWS::AvailabilityZone</code>, <code>AWS::EC2::Subnet</code>, or
82
- * <code>AWS::AWSService</code>.</p>
76
+ * <p>The type of the remote resource. Valid values are <code>AWS::EC2::VPC</code> <code>AWS::AvailabilityZone</code>, <code>AWS::EC2::Subnet</code>, or <code>AWS::AWSService</code>.</p>
83
77
  * @public
84
78
  */
85
79
  type: MonitorRemoteResourceType | undefined;
@@ -99,16 +93,12 @@ export interface CreateMonitorInput {
99
93
  */
100
94
  monitorName: string | undefined;
101
95
  /**
102
- * <p>The local resources to monitor. A local resource, in a bi-directional flow of a workload,
103
- * is the host where the agent is installed. For example, if a workload consists of an interaction
104
- * between a web service and a backend database (for example, Amazon Relational Database Service (RDS)),
105
- * the EC2 instance hosting the web service, which also runs the agent, is the local resource.</p>
96
+ * <p>The local resources to monitor. A local resource, in a bi-directional flow of a workload, is the host where the agent is installed. For example, if a workload consists of an interaction between a web service and a backend database (for example, Amazon Relational Database Service (RDS)), the EC2 instance hosting the web service, which also runs the agent, is the local resource.</p>
106
97
  * @public
107
98
  */
108
99
  localResources: MonitorLocalResource[] | undefined;
109
100
  /**
110
- * <p>The remote resources to monitor. A remote resource is the other endpoint in the bi-directional
111
- * flow of a workload, with a local resource. For example, Amazon Relational Database Service (RDS) can be a remote resource.</p>
101
+ * <p>The remote resources to monitor. A remote resource is the other endpoint in the bi-directional flow of a workload, with a local resource. For example, Amazon Relational Database Service (RDS) can be a remote resource.</p>
112
102
  * @public
113
103
  */
114
104
  remoteResources?: MonitorRemoteResource[] | undefined;
@@ -118,8 +108,7 @@ export interface CreateMonitorInput {
118
108
  */
119
109
  scopeArn: string | undefined;
120
110
  /**
121
- * <p>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for
122
- * other API requests.</p>
111
+ * <p>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.</p>
123
112
  * @public
124
113
  */
125
114
  clientToken?: string | undefined;
@@ -159,42 +148,17 @@ export interface CreateMonitorOutput {
159
148
  */
160
149
  monitorName: string | undefined;
161
150
  /**
162
- * <p>The status of a monitor. The status can be one of the following</p>
163
- * <ul>
164
- * <li>
165
- * <p>
166
- * <code>PENDING</code>: The monitor is in the process of being created.</p>
167
- * </li>
168
- * <li>
169
- * <p>
170
- * <code>ACTIVE</code>: The monitor is active.</p>
171
- * </li>
172
- * <li>
173
- * <p>
174
- * <code>INACTIVE</code>: The monitor is inactive.</p>
175
- * </li>
176
- * <li>
177
- * <p>
178
- * <code>ERROR</code>: Monitor creation failed due to an error.</p>
179
- * </li>
180
- * <li>
181
- * <p>
182
- * <code>DELETING</code>: The monitor is in the process of being deleted.</p>
183
- * </li>
184
- * </ul>
151
+ * <p>The status of a monitor. The status can be one of the following</p> <ul> <li> <p> <code>PENDING</code>: The monitor is in the process of being created.</p> </li> <li> <p> <code>ACTIVE</code>: The monitor is active.</p> </li> <li> <p> <code>INACTIVE</code>: The monitor is inactive.</p> </li> <li> <p> <code>ERROR</code>: Monitor creation failed due to an error.</p> </li> <li> <p> <code>DELETING</code>: The monitor is in the process of being deleted.</p> </li> </ul>
185
152
  * @public
186
153
  */
187
154
  monitorStatus: MonitorStatus | undefined;
188
155
  /**
189
- * <p>The local resources to monitor. A local resource, in a bi-directional flow of a workload,
190
- * is the host where the agent is installed. </p>
156
+ * <p>The local resources to monitor. A local resource, in a bi-directional flow of a workload, is the host where the agent is installed. </p>
191
157
  * @public
192
158
  */
193
159
  localResources: MonitorLocalResource[] | undefined;
194
160
  /**
195
- * <p>The remote resources to monitor. A remote resource is the other endpoint in the bi-directional
196
- * flow of a workload, with a local resource. For example, Amazon Relational Database Service (RDS) can
197
- * be a remote resource. The remote resource is identified by its ARN or an identifier.</p>
161
+ * <p>The remote resources to monitor. A remote resource is the other endpoint in the bi-directional flow of a workload, with a local resource. For example, Amazon Relational Database Service (RDS) can be a remote resource. The remote resource is identified by its ARN or an identifier.</p>
198
162
  * @public
199
163
  */
200
164
  remoteResources: MonitorRemoteResource[] | undefined;
@@ -267,9 +231,7 @@ export declare class ValidationException extends __BaseException {
267
231
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
268
232
  }
269
233
  /**
270
- * <p>A target ID is an internally-generated identifier for a target.
271
- * A target allows you to identify all the resources in a Network Flow Monitor scope. Currently,
272
- * a target is always an Amazon Web Services account.</p>
234
+ * <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>
273
235
  * @public
274
236
  */
275
237
  export type TargetId = TargetId.AccountIdMember | TargetId.$UnknownMember;
@@ -310,9 +272,7 @@ export declare const TargetType: {
310
272
  */
311
273
  export type TargetType = (typeof TargetType)[keyof typeof TargetType];
312
274
  /**
313
- * <p>A target identifier is a pair of identifying information for a resource that
314
- * is included in a target. A target identifier includes the target ID and
315
- * the target type.</p>
275
+ * <p>A target identifier is a pair of identifying information for a resource that is included in a target. A target identifier includes the target ID and the target type.</p>
316
276
  * @public
317
277
  */
318
278
  export interface TargetIdentifier {
@@ -322,22 +282,18 @@ export interface TargetIdentifier {
322
282
  */
323
283
  targetId: TargetId | undefined;
324
284
  /**
325
- * <p>The type of a target. A target type is currently always <code>ACCOUNT</code>
326
- * because a target is currently a single Amazon Web Services account.</p>
285
+ * <p>The type of a target. A target type is currently always <code>ACCOUNT</code> because a target is currently a single Amazon Web Services account.</p>
327
286
  * @public
328
287
  */
329
288
  targetType: TargetType | undefined;
330
289
  }
331
290
  /**
332
- * <p>A target resource in a scope. The resource is identified by a Region and
333
- * a target identifier, which includes a target ID and a target type.</p>
291
+ * <p>A target resource in a scope. The resource is identified by a Region and a target identifier, which includes a target ID and a target type.</p>
334
292
  * @public
335
293
  */
336
294
  export interface TargetResource {
337
295
  /**
338
- * <p>A target identifier is a pair of identifying information for a resource that
339
- * is included in a target. A target identifier includes the target ID and
340
- * the target type.</p>
296
+ * <p>A target identifier is a pair of identifying information for a resource that is included in a target. A target identifier includes the target ID and the target type.</p>
341
297
  * @public
342
298
  */
343
299
  targetIdentifier: TargetIdentifier | undefined;
@@ -357,8 +313,7 @@ export interface CreateScopeInput {
357
313
  */
358
314
  targets: TargetResource[] | undefined;
359
315
  /**
360
- * <p>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent
361
- * API request. Don't reuse the same client token for other API requests.</p>
316
+ * <p>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.</p>
362
317
  * @public
363
318
  */
364
319
  clientToken?: string | undefined;
@@ -373,6 +328,8 @@ export interface CreateScopeInput {
373
328
  * @enum
374
329
  */
375
330
  export declare const ScopeStatus: {
331
+ readonly DEACTIVATED: "DEACTIVATED";
332
+ readonly DEACTIVATING: "DEACTIVATING";
376
333
  readonly FAILED: "FAILED";
377
334
  readonly IN_PROGRESS: "IN_PROGRESS";
378
335
  readonly SUCCEEDED: "SUCCEEDED";
@@ -386,15 +343,12 @@ export type ScopeStatus = (typeof ScopeStatus)[keyof typeof ScopeStatus];
386
343
  */
387
344
  export interface CreateScopeOutput {
388
345
  /**
389
- * <p>The identifier for the scope that includes the resources you want to get metrics for.
390
- * A scope ID is an internally-generated identifier that includes all the resources
391
- * for a specific root account.</p>
346
+ * <p>The identifier for the scope that includes the resources you want to get metrics for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</p>
392
347
  * @public
393
348
  */
394
349
  scopeId: string | undefined;
395
350
  /**
396
- * <p>The status for a call to create a scope. The status can be one of the following:
397
- * <code>SUCCEEDED</code>, <code>IN_PROGRESS</code>, or <code>FAILED</code>.</p>
351
+ * <p>The status for a scope. The status can be one of the following: <code>SUCCEEDED</code>, <code>IN_PROGRESS</code>, <code>FAILED</code>, <code>DEACTIVATING</code>, or <code>DEACTIVATED</code>.</p> <p>A status of <code>DEACTIVATING</code> means that you've requested a scope to be deactivated and Network Flow Monitor is in the process of deactivating the scope. A status of <code>DEACTIVATED</code> means that the deactivating process is complete.</p>
398
352
  * @public
399
353
  */
400
354
  status: ScopeStatus | undefined;
@@ -441,9 +395,7 @@ export declare class ResourceNotFoundException extends __BaseException {
441
395
  */
442
396
  export interface DeleteScopeInput {
443
397
  /**
444
- * <p>The identifier for the scope that includes the resources you want to get data results for.
445
- * A scope ID is an internally-generated identifier that includes all the resources
446
- * for a specific root account.</p>
398
+ * <p>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</p>
447
399
  * @public
448
400
  */
449
401
  scopeId: string | undefined;
@@ -494,29 +446,7 @@ export interface GetMonitorOutput {
494
446
  */
495
447
  monitorName: string | undefined;
496
448
  /**
497
- * <p>The status of a monitor. The status can be one of the following</p>
498
- * <ul>
499
- * <li>
500
- * <p>
501
- * <code>PENDING</code>: The monitor is in the process of being created.</p>
502
- * </li>
503
- * <li>
504
- * <p>
505
- * <code>ACTIVE</code>: The monitor is active.</p>
506
- * </li>
507
- * <li>
508
- * <p>
509
- * <code>INACTIVE</code>: The monitor is inactive.</p>
510
- * </li>
511
- * <li>
512
- * <p>
513
- * <code>ERROR</code>: Monitor creation failed due to an error.</p>
514
- * </li>
515
- * <li>
516
- * <p>
517
- * <code>DELETING</code>: The monitor is in the process of being deleted.</p>
518
- * </li>
519
- * </ul>
449
+ * <p>The status of a monitor. The status can be one of the following</p> <ul> <li> <p> <code>PENDING</code>: The monitor is in the process of being created.</p> </li> <li> <p> <code>ACTIVE</code>: The monitor is active.</p> </li> <li> <p> <code>INACTIVE</code>: The monitor is inactive.</p> </li> <li> <p> <code>ERROR</code>: Monitor creation failed due to an error.</p> </li> <li> <p> <code>DELETING</code>: The monitor is in the process of being deleted.</p> </li> </ul>
520
450
  * @public
521
451
  */
522
452
  monitorStatus: MonitorStatus | undefined;
@@ -556,8 +486,7 @@ export interface GetQueryResultsMonitorTopContributorsInput {
556
486
  */
557
487
  monitorName: string | undefined;
558
488
  /**
559
- * <p>The identifier for the query. A query ID is an internally-generated
560
- * identifier for a specific query returned from an API call to create a query.</p>
489
+ * <p>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.</p>
561
490
  * @public
562
491
  */
563
492
  queryId: string | undefined;
@@ -635,10 +564,7 @@ export interface TraversedComponent {
635
564
  serviceName?: string | undefined;
636
565
  }
637
566
  /**
638
- * <p>A set of information for a top contributor network flow in a monitor.
639
- * In a monitor, Network Flow Monitor returns information about the network flows for top
640
- * contributors for each metric. Top contributors are network flows with
641
- * the top values for each metric type.</p>
567
+ * <p>A set of information for a top contributor network flow in a monitor. In a monitor, Network Flow Monitor returns information about the network flows for top contributors for each metric. Top contributors are network flows with the top values for each metric type.</p>
642
568
  * @public
643
569
  */
644
570
  export interface MonitorTopContributorsRow {
@@ -683,29 +609,7 @@ export interface MonitorTopContributorsRow {
683
609
  */
684
610
  targetPort?: number | undefined;
685
611
  /**
686
- * <p>The destination category for a top contributors row. Destination categories can be one of the following: </p>
687
- * <ul>
688
- * <li>
689
- * <p>
690
- * <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p>
691
- * </li>
692
- * <li>
693
- * <p>
694
- * <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p>
695
- * </li>
696
- * <li>
697
- * <p>
698
- * <code>INTER_VPC</code>: Top contributor network flows between VPCs</p>
699
- * </li>
700
- * <li>
701
- * <p>
702
- * <code>AWS_SERVICES</code>: Top contributor network flows to or from Amazon Web Services services</p>
703
- * </li>
704
- * <li>
705
- * <p>
706
- * <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p>
707
- * </li>
708
- * </ul>
612
+ * <p>The destination category for a top contributors row. Destination categories can be one of the following: </p> <ul> <li> <p> <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p> </li> <li> <p> <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p> </li> <li> <p> <code>INTER_VPC</code>: Top contributor network flows between VPCs</p> </li> <li> <p> <code>AWS_SERVICES</code>: Top contributor network flows to or from Amazon Web Services services</p> </li> <li> <p> <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p> </li> </ul>
709
613
  * @public
710
614
  */
711
615
  destinationCategory?: DestinationCategory | undefined;
@@ -837,8 +741,7 @@ export interface GetQueryResultsMonitorTopContributorsOutput {
837
741
  */
838
742
  unit?: MetricUnit | undefined;
839
743
  /**
840
- * <p>The top contributor network flows overall for a specific metric type, for example, the
841
- * number of retransmissions.</p>
744
+ * <p>The top contributor network flows overall for a specific metric type, for example, the number of retransmissions.</p>
842
745
  * @public
843
746
  */
844
747
  topContributors?: MonitorTopContributorsRow[] | undefined;
@@ -853,15 +756,12 @@ export interface GetQueryResultsMonitorTopContributorsOutput {
853
756
  */
854
757
  export interface GetQueryResultsWorkloadInsightsTopContributorsInput {
855
758
  /**
856
- * <p>The identifier for the scope that includes the resources you want to get data results for.
857
- * A scope ID is an internally-generated identifier that includes all the resources
858
- * for a specific root account.</p>
759
+ * <p>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</p>
859
760
  * @public
860
761
  */
861
762
  scopeId: string | undefined;
862
763
  /**
863
- * <p>The identifier for the query. A query ID is an internally-generated
864
- * identifier for a specific query returned from an API call to create a query.</p>
764
+ * <p>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.</p>
865
765
  * @public
866
766
  */
867
767
  queryId: string | undefined;
@@ -932,8 +832,7 @@ export interface WorkloadInsightsTopContributorsRow {
932
832
  */
933
833
  export interface GetQueryResultsWorkloadInsightsTopContributorsOutput {
934
834
  /**
935
- * <p>The top contributor network flows overall for a specific metric type, for example, the
936
- * number of retransmissions.</p>
835
+ * <p>The top contributor network flows overall for a specific metric type, for example, the number of retransmissions.</p>
937
836
  * @public
938
837
  */
939
838
  topContributors?: WorkloadInsightsTopContributorsRow[] | undefined;
@@ -948,15 +847,12 @@ export interface GetQueryResultsWorkloadInsightsTopContributorsOutput {
948
847
  */
949
848
  export interface GetQueryResultsWorkloadInsightsTopContributorsDataInput {
950
849
  /**
951
- * <p>The identifier for the scope that includes the resources you want to get data results for.
952
- * A scope ID is an internally-generated identifier that includes all the resources
953
- * for a specific root account.</p>
850
+ * <p>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</p>
954
851
  * @public
955
852
  */
956
853
  scopeId: string | undefined;
957
854
  /**
958
- * <p>The identifier for the query. A query ID is an internally-generated
959
- * identifier for a specific query returned from an API call to create a query.</p>
855
+ * <p>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.</p>
960
856
  * @public
961
857
  */
962
858
  queryId: string | undefined;
@@ -972,9 +868,7 @@ export interface GetQueryResultsWorkloadInsightsTopContributorsDataInput {
972
868
  maxResults?: number | undefined;
973
869
  }
974
870
  /**
975
- * <p>A data point for a top contributor network flow in a scope.
976
- * Network Flow Monitor returns information about the network flows with the top values
977
- * for each metric type, which are called top contributors.</p>
871
+ * <p>A data point for a top contributor network flow in a scope. Network Flow Monitor returns information about the network flows with the top values for each metric type, which are called top contributors.</p>
978
872
  * @public
979
873
  */
980
874
  export interface WorkloadInsightsTopContributorsDataPoint {
@@ -1024,8 +918,7 @@ export interface GetQueryStatusMonitorTopContributorsInput {
1024
918
  */
1025
919
  monitorName: string | undefined;
1026
920
  /**
1027
- * <p>The identifier for the query. A query ID is an internally-generated
1028
- * identifier for a specific query returned from an API call to start a query.</p>
921
+ * <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>
1029
922
  * @public
1030
923
  */
1031
924
  queryId: string | undefined;
@@ -1050,30 +943,7 @@ export type QueryStatus = (typeof QueryStatus)[keyof typeof QueryStatus];
1050
943
  */
1051
944
  export interface GetQueryStatusMonitorTopContributorsOutput {
1052
945
  /**
1053
- * <p>When you run a query, use this call to check the status of the query to make sure that the query
1054
- * has <code>SUCCEEDED</code> before you review the results.</p>
1055
- * <ul>
1056
- * <li>
1057
- * <p>
1058
- * <code>QUEUED</code>: The query is scheduled to run.</p>
1059
- * </li>
1060
- * <li>
1061
- * <p>
1062
- * <code>RUNNING</code>: The query is in progress but not complete.</p>
1063
- * </li>
1064
- * <li>
1065
- * <p>
1066
- * <code>SUCCEEDED</code>: The query completed sucessfully.</p>
1067
- * </li>
1068
- * <li>
1069
- * <p>
1070
- * <code>FAILED</code>: The query failed due to an error.</p>
1071
- * </li>
1072
- * <li>
1073
- * <p>
1074
- * <code>CANCELED</code>: The query was canceled.</p>
1075
- * </li>
1076
- * </ul>
946
+ * <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 sucessfully.</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>
1077
947
  * @public
1078
948
  */
1079
949
  status: QueryStatus | undefined;
@@ -1083,15 +953,12 @@ export interface GetQueryStatusMonitorTopContributorsOutput {
1083
953
  */
1084
954
  export interface GetQueryStatusWorkloadInsightsTopContributorsInput {
1085
955
  /**
1086
- * <p>The identifier for the scope that includes the resources you want to get data results for.
1087
- * A scope ID is an internally-generated identifier that includes all the resources
1088
- * for a specific root account.</p>
956
+ * <p>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</p>
1089
957
  * @public
1090
958
  */
1091
959
  scopeId: string | undefined;
1092
960
  /**
1093
- * <p>The identifier for the query. A query ID is an internally-generated
1094
- * identifier for a specific query returned from an API call to start a query.</p>
961
+ * <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>
1095
962
  * @public
1096
963
  */
1097
964
  queryId: string | undefined;
@@ -1101,30 +968,7 @@ export interface GetQueryStatusWorkloadInsightsTopContributorsInput {
1101
968
  */
1102
969
  export interface GetQueryStatusWorkloadInsightsTopContributorsOutput {
1103
970
  /**
1104
- * <p>When you run a query, use this call to check the status of the query to make sure that the query
1105
- * has <code>SUCCEEDED</code> before you review the results.</p>
1106
- * <ul>
1107
- * <li>
1108
- * <p>
1109
- * <code>QUEUED</code>: The query is scheduled to run.</p>
1110
- * </li>
1111
- * <li>
1112
- * <p>
1113
- * <code>RUNNING</code>: The query is in progress but not complete.</p>
1114
- * </li>
1115
- * <li>
1116
- * <p>
1117
- * <code>SUCCEEDED</code>: The query completed sucessfully.</p>
1118
- * </li>
1119
- * <li>
1120
- * <p>
1121
- * <code>FAILED</code>: The query failed due to an error.</p>
1122
- * </li>
1123
- * <li>
1124
- * <p>
1125
- * <code>CANCELED</code>: The query was canceled.</p>
1126
- * </li>
1127
- * </ul>
971
+ * <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 sucessfully.</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>
1128
972
  * @public
1129
973
  */
1130
974
  status: QueryStatus | undefined;
@@ -1134,15 +978,12 @@ export interface GetQueryStatusWorkloadInsightsTopContributorsOutput {
1134
978
  */
1135
979
  export interface GetQueryStatusWorkloadInsightsTopContributorsDataInput {
1136
980
  /**
1137
- * <p>The identifier for the scope that includes the resources you want to get data results for.
1138
- * A scope ID is an internally-generated identifier that includes all the resources
1139
- * for a specific root account. A scope ID is returned from a <code>CreateScope</code> API call.</p>
981
+ * <p>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a <code>CreateScope</code> API call.</p>
1140
982
  * @public
1141
983
  */
1142
984
  scopeId: string | undefined;
1143
985
  /**
1144
- * <p>The identifier for the query. A query ID is an internally-generated
1145
- * identifier for a specific query returned from an API call to start a query.</p>
986
+ * <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>
1146
987
  * @public
1147
988
  */
1148
989
  queryId: string | undefined;
@@ -1152,29 +993,7 @@ export interface GetQueryStatusWorkloadInsightsTopContributorsDataInput {
1152
993
  */
1153
994
  export interface GetQueryStatusWorkloadInsightsTopContributorsDataOutput {
1154
995
  /**
1155
- * <p>The status of a query for top contributors data.</p>
1156
- * <ul>
1157
- * <li>
1158
- * <p>
1159
- * <code>QUEUED</code>: The query is scheduled to run.</p>
1160
- * </li>
1161
- * <li>
1162
- * <p>
1163
- * <code>RUNNING</code>: The query is in progress but not complete.</p>
1164
- * </li>
1165
- * <li>
1166
- * <p>
1167
- * <code>SUCCEEDED</code>: The query completed sucessfully.</p>
1168
- * </li>
1169
- * <li>
1170
- * <p>
1171
- * <code>FAILED</code>: The query failed due to an error.</p>
1172
- * </li>
1173
- * <li>
1174
- * <p>
1175
- * <code>CANCELED</code>: The query was canceled.</p>
1176
- * </li>
1177
- * </ul>
996
+ * <p>The status of a query for top contributors data.</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 sucessfully.</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>
1178
997
  * @public
1179
998
  */
1180
999
  status: QueryStatus | undefined;
@@ -1184,9 +1003,7 @@ export interface GetQueryStatusWorkloadInsightsTopContributorsDataOutput {
1184
1003
  */
1185
1004
  export interface GetScopeInput {
1186
1005
  /**
1187
- * <p>The identifier for the scope that includes the resources you want to get data results for.
1188
- * A scope ID is an internally-generated identifier that includes all the resources
1189
- * for a specific root account. A scope ID is returned from a <code>CreateScope</code> API call.</p>
1006
+ * <p>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a <code>CreateScope</code> API call.</p>
1190
1007
  * @public
1191
1008
  */
1192
1009
  scopeId: string | undefined;
@@ -1196,15 +1013,12 @@ export interface GetScopeInput {
1196
1013
  */
1197
1014
  export interface GetScopeOutput {
1198
1015
  /**
1199
- * <p>The identifier for the scope that includes the resources you want to get data results for.
1200
- * A scope ID is an internally-generated identifier that includes all the resources
1201
- * for a specific root account. A scope ID is returned from a <code>CreateScope</code> API call.</p>
1016
+ * <p>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a <code>CreateScope</code> API call.</p>
1202
1017
  * @public
1203
1018
  */
1204
1019
  scopeId: string | undefined;
1205
1020
  /**
1206
- * <p>The status of a scope. The status can be one of the following:
1207
- * <code>SUCCEEDED</code>, <code>IN_PROGRESS</code>, or <code>FAILED</code>.</p>
1021
+ * <p>The status for a scope. The status can be one of the following: <code>SUCCEEDED</code>, <code>IN_PROGRESS</code>, <code>FAILED</code>, <code>DEACTIVATING</code>, or <code>DEACTIVATED</code>.</p> <p>A status of <code>DEACTIVATING</code> means that you've requested a scope to be deactivated and Network Flow Monitor is in the process of deactivating the scope. A status of <code>DEACTIVATED</code> means that the deactivating process is complete.</p>
1208
1022
  * @public
1209
1023
  */
1210
1024
  status: ScopeStatus | undefined;
@@ -1239,29 +1053,7 @@ export interface ListMonitorsInput {
1239
1053
  */
1240
1054
  maxResults?: number | undefined;
1241
1055
  /**
1242
- * <p>The status of a monitor. The status can be one of the following</p>
1243
- * <ul>
1244
- * <li>
1245
- * <p>
1246
- * <code>PENDING</code>: The monitor is in the process of being created.</p>
1247
- * </li>
1248
- * <li>
1249
- * <p>
1250
- * <code>ACTIVE</code>: The monitor is active.</p>
1251
- * </li>
1252
- * <li>
1253
- * <p>
1254
- * <code>INACTIVE</code>: The monitor is inactive.</p>
1255
- * </li>
1256
- * <li>
1257
- * <p>
1258
- * <code>ERROR</code>: Monitor creation failed due to an error.</p>
1259
- * </li>
1260
- * <li>
1261
- * <p>
1262
- * <code>DELETING</code>: The monitor is in the process of being deleted.</p>
1263
- * </li>
1264
- * </ul>
1056
+ * <p>The status of a monitor. The status can be one of the following</p> <ul> <li> <p> <code>PENDING</code>: The monitor is in the process of being created.</p> </li> <li> <p> <code>ACTIVE</code>: The monitor is active.</p> </li> <li> <p> <code>INACTIVE</code>: The monitor is inactive.</p> </li> <li> <p> <code>ERROR</code>: Monitor creation failed due to an error.</p> </li> <li> <p> <code>DELETING</code>: The monitor is in the process of being deleted.</p> </li> </ul>
1265
1057
  * @public
1266
1058
  */
1267
1059
  monitorStatus?: MonitorStatus | undefined;
@@ -1282,29 +1074,7 @@ export interface MonitorSummary {
1282
1074
  */
1283
1075
  monitorName: string | undefined;
1284
1076
  /**
1285
- * <p>The status of a monitor. The status can be one of the following</p>
1286
- * <ul>
1287
- * <li>
1288
- * <p>
1289
- * <code>PENDING</code>: The monitor is in the process of being created.</p>
1290
- * </li>
1291
- * <li>
1292
- * <p>
1293
- * <code>ACTIVE</code>: The monitor is active.</p>
1294
- * </li>
1295
- * <li>
1296
- * <p>
1297
- * <code>INACTIVE</code>: The monitor is inactive.</p>
1298
- * </li>
1299
- * <li>
1300
- * <p>
1301
- * <code>ERROR</code>: Monitor creation failed due to an error.</p>
1302
- * </li>
1303
- * <li>
1304
- * <p>
1305
- * <code>DELETING</code>: The monitor is in the process of being deleted.</p>
1306
- * </li>
1307
- * </ul>
1077
+ * <p>The status of a monitor. The status can be one of the following</p> <ul> <li> <p> <code>PENDING</code>: The monitor is in the process of being created.</p> </li> <li> <p> <code>ACTIVE</code>: The monitor is active.</p> </li> <li> <p> <code>INACTIVE</code>: The monitor is inactive.</p> </li> <li> <p> <code>ERROR</code>: Monitor creation failed due to an error.</p> </li> <li> <p> <code>DELETING</code>: The monitor is in the process of being deleted.</p> </li> </ul>
1308
1078
  * @public
1309
1079
  */
1310
1080
  monitorStatus: MonitorStatus | undefined;
@@ -1340,21 +1110,17 @@ export interface ListScopesInput {
1340
1110
  maxResults?: number | undefined;
1341
1111
  }
1342
1112
  /**
1343
- * <p>A summary of information about a scope, including the ARN, target ID, and
1344
- * Amazon Web Services Region.</p>
1113
+ * <p>A summary of information about a scope, including the ARN, target ID, and Amazon Web Services Region.</p>
1345
1114
  * @public
1346
1115
  */
1347
1116
  export interface ScopeSummary {
1348
1117
  /**
1349
- * <p>The identifier for the scope that includes the resources you want to get data results for.
1350
- * A scope ID is an internally-generated identifier that includes all the resources
1351
- * for a specific root account.</p>
1118
+ * <p>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</p>
1352
1119
  * @public
1353
1120
  */
1354
1121
  scopeId: string | undefined;
1355
1122
  /**
1356
- * <p>The status of a scope. The status can be one of the following, depending on the
1357
- * state of scope creation: <code>SUCCEEDED</code>, <code>IN_PROGRESS</code>, or <code>FAILED</code>.</p>
1123
+ * <p>The status for a scope. The status can be one of the following: <code>SUCCEEDED</code>, <code>IN_PROGRESS</code>, <code>FAILED</code>, <code>DEACTIVATING</code>, or <code>DEACTIVATED</code>.</p> <p>A status of <code>DEACTIVATING</code> means that you've requested a scope to be deactivated and Network Flow Monitor is in the process of deactivating the scope. A status of <code>DEACTIVATED</code> means that the deactivating process is complete.</p>
1358
1124
  * @public
1359
1125
  */
1360
1126
  status: ScopeStatus | undefined;
@@ -1423,53 +1189,22 @@ export interface StartQueryMonitorTopContributorsInput {
1423
1189
  */
1424
1190
  monitorName: string | undefined;
1425
1191
  /**
1426
- * <p>The timestamp that is the date and time beginning of the period that you want to retrieve
1427
- * results for with your query.</p>
1192
+ * <p>The timestamp that is the date and time beginning of the period that you want to retrieve results for with your query.</p>
1428
1193
  * @public
1429
1194
  */
1430
1195
  startTime: Date | undefined;
1431
1196
  /**
1432
- * <p>The timestamp that is the date and time end of the period that you want to retrieve
1433
- * results for with your query.</p>
1197
+ * <p>The timestamp that is the date and time end of the period that you want to retrieve results for with your query.</p>
1434
1198
  * @public
1435
1199
  */
1436
1200
  endTime: Date | undefined;
1437
1201
  /**
1438
- * <p>The metric that you want to query top contributors for. That is, you can specify a metric
1439
- * with this call and return the top contributor network flows, for that type of metric, for a monitor
1440
- * and (optionally) within a specific category, such as network flows between Availability Zones.</p>
1202
+ * <p>The metric that you want to query top contributors for. That is, you can specify a metric with this call and return the top contributor network flows, for that type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.</p>
1441
1203
  * @public
1442
1204
  */
1443
1205
  metricName: MonitorMetric | undefined;
1444
1206
  /**
1445
- * <p>The category that you want to query top contributors for, for a specific monitor. Destination
1446
- * categories can be one of the following: </p>
1447
- * <ul>
1448
- * <li>
1449
- * <p>
1450
- * <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p>
1451
- * </li>
1452
- * <li>
1453
- * <p>
1454
- * <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p>
1455
- * </li>
1456
- * <li>
1457
- * <p>
1458
- * <code>INTER_VPC</code>: Top contributor network flows between VPCs</p>
1459
- * </li>
1460
- * <li>
1461
- * <p>
1462
- * <code>AMAZON_S3</code>: Top contributor network flows to or from Amazon S3</p>
1463
- * </li>
1464
- * <li>
1465
- * <p>
1466
- * <code>AMAZON_DYNAMODB</code>: Top contributor network flows to or from Amazon Dynamo DB</p>
1467
- * </li>
1468
- * <li>
1469
- * <p>
1470
- * <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p>
1471
- * </li>
1472
- * </ul>
1207
+ * <p>The category that you want to query top contributors for, for a specific monitor. Destination categories can be one of the following: </p> <ul> <li> <p> <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p> </li> <li> <p> <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p> </li> <li> <p> <code>INTER_VPC</code>: Top contributor network flows between VPCs</p> </li> <li> <p> <code>AMAZON_S3</code>: Top contributor network flows to or from Amazon S3</p> </li> <li> <p> <code>AMAZON_DYNAMODB</code>: Top contributor network flows to or from Amazon Dynamo DB</p> </li> <li> <p> <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p> </li> </ul>
1473
1208
  * @public
1474
1209
  */
1475
1210
  destinationCategory: DestinationCategory | undefined;
@@ -1484,8 +1219,7 @@ export interface StartQueryMonitorTopContributorsInput {
1484
1219
  */
1485
1220
  export interface StartQueryMonitorTopContributorsOutput {
1486
1221
  /**
1487
- * <p>The identifier for the query. A query ID is an internally-generated
1488
- * identifier for a specific query returned from an API call to start a query.</p>
1222
+ * <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>
1489
1223
  * @public
1490
1224
  */
1491
1225
  queryId: string | undefined;
@@ -1500,8 +1234,7 @@ export interface StopQueryMonitorTopContributorsInput {
1500
1234
  */
1501
1235
  monitorName: string | undefined;
1502
1236
  /**
1503
- * <p>The identifier for the query. A query ID is an internally-generated
1504
- * identifier for a specific query returned from an API call to create a query.</p>
1237
+ * <p>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.</p>
1505
1238
  * @public
1506
1239
  */
1507
1240
  queryId: string | undefined;
@@ -1541,8 +1274,7 @@ export interface UpdateMonitorInput {
1541
1274
  */
1542
1275
  remoteResourcesToRemove?: MonitorRemoteResource[] | undefined;
1543
1276
  /**
1544
- * <p>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for
1545
- * other API requests.</p>
1277
+ * <p>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.</p>
1546
1278
  * @public
1547
1279
  */
1548
1280
  clientToken?: string | undefined;
@@ -1562,29 +1294,7 @@ export interface UpdateMonitorOutput {
1562
1294
  */
1563
1295
  monitorName: string | undefined;
1564
1296
  /**
1565
- * <p>The status of a monitor. The status can be one of the following</p>
1566
- * <ul>
1567
- * <li>
1568
- * <p>
1569
- * <code>PENDING</code>: The monitor is in the process of being created.</p>
1570
- * </li>
1571
- * <li>
1572
- * <p>
1573
- * <code>ACTIVE</code>: The monitor is active.</p>
1574
- * </li>
1575
- * <li>
1576
- * <p>
1577
- * <code>INACTIVE</code>: The monitor is inactive.</p>
1578
- * </li>
1579
- * <li>
1580
- * <p>
1581
- * <code>ERROR</code>: Monitor creation failed due to an error.</p>
1582
- * </li>
1583
- * <li>
1584
- * <p>
1585
- * <code>DELETING</code>: The monitor is in the process of being deleted.</p>
1586
- * </li>
1587
- * </ul>
1297
+ * <p>The status of a monitor. The status can be one of the following</p> <ul> <li> <p> <code>PENDING</code>: The monitor is in the process of being created.</p> </li> <li> <p> <code>ACTIVE</code>: The monitor is active.</p> </li> <li> <p> <code>INACTIVE</code>: The monitor is inactive.</p> </li> <li> <p> <code>ERROR</code>: Monitor creation failed due to an error.</p> </li> <li> <p> <code>DELETING</code>: The monitor is in the process of being deleted.</p> </li> </ul>
1588
1298
  * @public
1589
1299
  */
1590
1300
  monitorStatus: MonitorStatus | undefined;
@@ -1632,55 +1342,27 @@ export type WorkloadInsightsMetric = (typeof WorkloadInsightsMetric)[keyof typeo
1632
1342
  */
1633
1343
  export interface StartQueryWorkloadInsightsTopContributorsInput {
1634
1344
  /**
1635
- * <p>The identifier for the scope that includes the resources you want to get data results for.
1636
- * A scope ID is an internally-generated identifier that includes all the resources
1637
- * for a specific root account. A scope ID is returned from a <code>CreateScope</code> API call.</p>
1345
+ * <p>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a <code>CreateScope</code> API call.</p>
1638
1346
  * @public
1639
1347
  */
1640
1348
  scopeId: string | undefined;
1641
1349
  /**
1642
- * <p>The timestamp that is the date and time beginning of the period that you want to retrieve
1643
- * results for with your query.</p>
1350
+ * <p>The timestamp that is the date and time beginning of the period that you want to retrieve results for with your query.</p>
1644
1351
  * @public
1645
1352
  */
1646
1353
  startTime: Date | undefined;
1647
1354
  /**
1648
- * <p>The timestamp that is the date and time end of the period that you want to retrieve
1649
- * results for with your query.</p>
1355
+ * <p>The timestamp that is the date and time end of the period that you want to retrieve results for with your query.</p>
1650
1356
  * @public
1651
1357
  */
1652
1358
  endTime: Date | undefined;
1653
1359
  /**
1654
- * <p>The metric that you want to query top contributors for. That is, you can specify this metric to
1655
- * return the top contributor network flows, for this type of metric, for a monitor and (optionally)
1656
- * within a specific category, such as network flows between Availability Zones.</p>
1360
+ * <p>The metric that you want to query top contributors for. That is, you can specify this metric to return the top contributor network flows, for this type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.</p>
1657
1361
  * @public
1658
1362
  */
1659
1363
  metricName: WorkloadInsightsMetric | undefined;
1660
1364
  /**
1661
- * <p>The destination category for a top contributors row. Destination categories can be one of the following: </p>
1662
- * <ul>
1663
- * <li>
1664
- * <p>
1665
- * <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p>
1666
- * </li>
1667
- * <li>
1668
- * <p>
1669
- * <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p>
1670
- * </li>
1671
- * <li>
1672
- * <p>
1673
- * <code>INTER_VPC</code>: Top contributor network flows between VPCs</p>
1674
- * </li>
1675
- * <li>
1676
- * <p>
1677
- * <code>AWS_SERVICES</code>: Top contributor network flows to or from Amazon Web Services services</p>
1678
- * </li>
1679
- * <li>
1680
- * <p>
1681
- * <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p>
1682
- * </li>
1683
- * </ul>
1365
+ * <p>The destination category for a top contributors row. Destination categories can be one of the following: </p> <ul> <li> <p> <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p> </li> <li> <p> <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p> </li> <li> <p> <code>INTER_VPC</code>: Top contributor network flows between VPCs</p> </li> <li> <p> <code>AWS_SERVICES</code>: Top contributor network flows to or from Amazon Web Services services</p> </li> <li> <p> <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p> </li> </ul>
1684
1366
  * @public
1685
1367
  */
1686
1368
  destinationCategory: DestinationCategory | undefined;
@@ -1695,8 +1377,7 @@ export interface StartQueryWorkloadInsightsTopContributorsInput {
1695
1377
  */
1696
1378
  export interface StartQueryWorkloadInsightsTopContributorsOutput {
1697
1379
  /**
1698
- * <p>The identifier for the query. A query ID is an internally-generated
1699
- * identifier for a specific query returned from an API call to start a query.</p>
1380
+ * <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>
1700
1381
  * @public
1701
1382
  */
1702
1383
  queryId: string | undefined;
@@ -1706,55 +1387,27 @@ export interface StartQueryWorkloadInsightsTopContributorsOutput {
1706
1387
  */
1707
1388
  export interface StartQueryWorkloadInsightsTopContributorsDataInput {
1708
1389
  /**
1709
- * <p>The identifier for the scope that includes the resources you want to get data results for.
1710
- * A scope ID is an internally-generated identifier that includes all the resources
1711
- * for a specific root account.</p>
1390
+ * <p>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</p>
1712
1391
  * @public
1713
1392
  */
1714
1393
  scopeId: string | undefined;
1715
1394
  /**
1716
- * <p>The timestamp that is the date and time beginning of the period that you want to retrieve
1717
- * results for with your query.</p>
1395
+ * <p>The timestamp that is the date and time beginning of the period that you want to retrieve results for with your query.</p>
1718
1396
  * @public
1719
1397
  */
1720
1398
  startTime: Date | undefined;
1721
1399
  /**
1722
- * <p>The timestamp that is the date and time end of the period that you want to retrieve
1723
- * results for with your query.</p>
1400
+ * <p>The timestamp that is the date and time end of the period that you want to retrieve results for with your query.</p>
1724
1401
  * @public
1725
1402
  */
1726
1403
  endTime: Date | undefined;
1727
1404
  /**
1728
- * <p>The metric that you want to query top contributors for. That is, you can specify this metric to
1729
- * return the top contributor network flows, for this type of metric, for a monitor and (optionally)
1730
- * within a specific category, such as network flows between Availability Zones.</p>
1405
+ * <p>The metric that you want to query top contributors for. That is, you can specify this metric to return the top contributor network flows, for this type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.</p>
1731
1406
  * @public
1732
1407
  */
1733
1408
  metricName: WorkloadInsightsMetric | undefined;
1734
1409
  /**
1735
- * <p>The destination category for a top contributors. Destination categories can be one of the following: </p>
1736
- * <ul>
1737
- * <li>
1738
- * <p>
1739
- * <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p>
1740
- * </li>
1741
- * <li>
1742
- * <p>
1743
- * <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p>
1744
- * </li>
1745
- * <li>
1746
- * <p>
1747
- * <code>INTER_VPC</code>: Top contributor network flows between VPCs</p>
1748
- * </li>
1749
- * <li>
1750
- * <p>
1751
- * <code>AWS_SERVICES</code>: Top contributor network flows to or from Amazon Web Services services</p>
1752
- * </li>
1753
- * <li>
1754
- * <p>
1755
- * <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p>
1756
- * </li>
1757
- * </ul>
1410
+ * <p>The destination category for a top contributors. Destination categories can be one of the following: </p> <ul> <li> <p> <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p> </li> <li> <p> <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p> </li> <li> <p> <code>INTER_VPC</code>: Top contributor network flows between VPCs</p> </li> <li> <p> <code>AWS_SERVICES</code>: Top contributor network flows to or from Amazon Web Services services</p> </li> <li> <p> <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p> </li> </ul>
1758
1411
  * @public
1759
1412
  */
1760
1413
  destinationCategory: DestinationCategory | undefined;
@@ -1764,8 +1417,7 @@ export interface StartQueryWorkloadInsightsTopContributorsDataInput {
1764
1417
  */
1765
1418
  export interface StartQueryWorkloadInsightsTopContributorsDataOutput {
1766
1419
  /**
1767
- * <p>The identifier for the query. A query ID is an internally-generated
1768
- * identifier for a specific query returned from an API call to start a query.</p>
1420
+ * <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>
1769
1421
  * @public
1770
1422
  */
1771
1423
  queryId: string | undefined;
@@ -1775,15 +1427,12 @@ export interface StartQueryWorkloadInsightsTopContributorsDataOutput {
1775
1427
  */
1776
1428
  export interface StopQueryWorkloadInsightsTopContributorsInput {
1777
1429
  /**
1778
- * <p>The identifier for the scope that includes the resources you want to get data results for.
1779
- * A scope ID is an internally-generated identifier that includes all the resources
1780
- * for a specific root account.</p>
1430
+ * <p>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</p>
1781
1431
  * @public
1782
1432
  */
1783
1433
  scopeId: string | undefined;
1784
1434
  /**
1785
- * <p>The identifier for the query. A query ID is an internally-generated
1786
- * identifier for a specific query returned from an API call to create a query.</p>
1435
+ * <p>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.</p>
1787
1436
  * @public
1788
1437
  */
1789
1438
  queryId: string | undefined;
@@ -1798,15 +1447,12 @@ export interface StopQueryWorkloadInsightsTopContributorsOutput {
1798
1447
  */
1799
1448
  export interface StopQueryWorkloadInsightsTopContributorsDataInput {
1800
1449
  /**
1801
- * <p>The identifier for the scope that includes the resources you want to get data results for.
1802
- * A scope ID is an internally-generated identifier that includes all the resources
1803
- * for a specific root account.</p>
1450
+ * <p>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</p>
1804
1451
  * @public
1805
1452
  */
1806
1453
  scopeId: string | undefined;
1807
1454
  /**
1808
- * <p>The identifier for the query. A query ID is an internally-generated
1809
- * identifier for a specific query returned from an API call to create a query.</p>
1455
+ * <p>The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.</p>
1810
1456
  * @public
1811
1457
  */
1812
1458
  queryId: string | undefined;
@@ -1821,9 +1467,7 @@ export interface StopQueryWorkloadInsightsTopContributorsDataOutput {
1821
1467
  */
1822
1468
  export interface UpdateScopeInput {
1823
1469
  /**
1824
- * <p>The identifier for the scope that includes the resources you want to get data results for.
1825
- * A scope ID is an internally-generated identifier that includes all the resources
1826
- * for a specific root account.</p>
1470
+ * <p>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</p>
1827
1471
  * @public
1828
1472
  */
1829
1473
  scopeId: string | undefined;
@@ -1843,15 +1487,12 @@ export interface UpdateScopeInput {
1843
1487
  */
1844
1488
  export interface UpdateScopeOutput {
1845
1489
  /**
1846
- * <p>The identifier for the scope that includes the resources you want to get data results for.
1847
- * A scope ID is an internally-generated identifier that includes all the resources
1848
- * for a specific root account.</p>
1490
+ * <p>The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.</p>
1849
1491
  * @public
1850
1492
  */
1851
1493
  scopeId: string | undefined;
1852
1494
  /**
1853
- * <p>The status for a call to update a scope. The status can be one of the following:
1854
- * <code>SUCCEEDED</code>, <code>IN_PROGRESS</code>, or <code>FAILED</code>.</p>
1495
+ * <p>The status for a scope. The status can be one of the following: <code>SUCCEEDED</code>, <code>IN_PROGRESS</code>, <code>FAILED</code>, <code>DEACTIVATING</code>, or <code>DEACTIVATED</code>.</p> <p>A status of <code>DEACTIVATING</code> means that you've requested a scope to be deactivated and Network Flow Monitor is in the process of deactivating the scope. A status of <code>DEACTIVATED</code> means that the deactivating process is complete.</p>
1855
1496
  * @public
1856
1497
  */
1857
1498
  status: ScopeStatus | undefined;