@aws-sdk/client-networkflowmonitor 3.845.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 +5 -5
package/README.md CHANGED
@@ -6,19 +6,7 @@
6
6
 
7
7
  AWS SDK for JavaScript NetworkFlowMonitor Client for Node.js, Browser and React Native.
8
8
 
9
- <p>Network Flow Monitor is a feature of Amazon CloudWatch Network Monitoring that provides visibility into the performance of
10
- network flows for your Amazon Web Services workloads, between instances in subnets, as well as to and
11
- from Amazon Web Services. Lightweight agents that you install on the instances capture performance metrics
12
- for your network flows, such as packet loss and latency, and send them to the Network Flow Monitor backend. Then, you can
13
- view and analyze metrics from the top contributors for each metric type, to help troubleshoot issues.</p>
14
- <p>In addition, when you create a monitor, Network Flow Monitor provides a network health indicator (NHI)
15
- that informs you whether there were Amazon Web Services network issues for one or more of the network flows
16
- tracked by a monitor, during a time period that you choose. By using this value, you can independently determine
17
- if the Amazon Web Services network is impacting your workload during a specific time frame, to help you focus
18
- troubleshooting efforts.</p>
19
- <p>To learn more about Network Flow Monitor, see the
20
- <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor.html">Network Flow Monitor User Guide</a>
21
- in the Amazon CloudWatch User Guide.</p>
9
+ <p>Network Flow Monitor is a feature of Amazon CloudWatch Network Monitoring that provides visibility into the performance of network flows for your Amazon Web Services workloads, between instances in subnets, as well as to and from Amazon Web Services. Lightweight agents that you install on the instances capture performance metrics for your network flows, such as packet loss and latency, and send them to the Network Flow Monitor backend. Then, you can view and analyze metrics from the top contributors for each metric type, to help troubleshoot issues.</p> <p>In addition, when you create a monitor, Network Flow Monitor provides a network health indicator (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose. By using this value, you can independently determine if the Amazon Web Services network is impacting your workload during a specific time frame, to help you focus troubleshooting efforts.</p> <p>To learn more about Network Flow Monitor, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor.html">Network Flow Monitor User Guide</a> in the Amazon CloudWatch User Guide.</p>
22
10
 
23
11
  ## Installing
24
12
 
@@ -114,6 +114,8 @@ exports.TargetType = {
114
114
  ACCOUNT: "ACCOUNT",
115
115
  };
116
116
  exports.ScopeStatus = {
117
+ DEACTIVATED: "DEACTIVATED",
118
+ DEACTIVATING: "DEACTIVATING",
117
119
  FAILED: "FAILED",
118
120
  IN_PROGRESS: "IN_PROGRESS",
119
121
  SUCCEEDED: "SUCCEEDED",
@@ -105,6 +105,8 @@ export const TargetType = {
105
105
  ACCOUNT: "ACCOUNT",
106
106
  };
107
107
  export const ScopeStatus = {
108
+ DEACTIVATED: "DEACTIVATED",
109
+ DEACTIVATING: "DEACTIVATING",
108
110
  FAILED: "FAILED",
109
111
  IN_PROGRESS: "IN_PROGRESS",
110
112
  SUCCEEDED: "SUCCEEDED",
@@ -180,19 +180,7 @@ export interface NetworkFlowMonitor {
180
180
  updateScope(args: UpdateScopeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateScopeCommandOutput) => void): void;
181
181
  }
182
182
  /**
183
- * <p>Network Flow Monitor is a feature of Amazon CloudWatch Network Monitoring that provides visibility into the performance of
184
- * network flows for your Amazon Web Services workloads, between instances in subnets, as well as to and
185
- * from Amazon Web Services. Lightweight agents that you install on the instances capture performance metrics
186
- * for your network flows, such as packet loss and latency, and send them to the Network Flow Monitor backend. Then, you can
187
- * view and analyze metrics from the top contributors for each metric type, to help troubleshoot issues.</p>
188
- * <p>In addition, when you create a monitor, Network Flow Monitor provides a network health indicator (NHI)
189
- * that informs you whether there were Amazon Web Services network issues for one or more of the network flows
190
- * tracked by a monitor, during a time period that you choose. By using this value, you can independently determine
191
- * if the Amazon Web Services network is impacting your workload during a specific time frame, to help you focus
192
- * troubleshooting efforts.</p>
193
- * <p>To learn more about Network Flow Monitor, see the
194
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor.html">Network Flow Monitor User Guide</a>
195
- * in the Amazon CloudWatch User Guide.</p>
183
+ * <p>Network Flow Monitor is a feature of Amazon CloudWatch Network Monitoring that provides visibility into the performance of network flows for your Amazon Web Services workloads, between instances in subnets, as well as to and from Amazon Web Services. Lightweight agents that you install on the instances capture performance metrics for your network flows, such as packet loss and latency, and send them to the Network Flow Monitor backend. Then, you can view and analyze metrics from the top contributors for each metric type, to help troubleshoot issues.</p> <p>In addition, when you create a monitor, Network Flow Monitor provides a network health indicator (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose. By using this value, you can independently determine if the Amazon Web Services network is impacting your workload during a specific time frame, to help you focus troubleshooting efforts.</p> <p>To learn more about Network Flow Monitor, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor.html">Network Flow Monitor User Guide</a> in the Amazon CloudWatch User Guide.</p>
196
184
  * @public
197
185
  */
198
186
  export declare class NetworkFlowMonitor extends NetworkFlowMonitorClient implements NetworkFlowMonitor {
@@ -194,19 +194,7 @@ export type NetworkFlowMonitorClientResolvedConfigType = __SmithyResolvedConfigu
194
194
  export interface NetworkFlowMonitorClientResolvedConfig extends NetworkFlowMonitorClientResolvedConfigType {
195
195
  }
196
196
  /**
197
- * <p>Network Flow Monitor is a feature of Amazon CloudWatch Network Monitoring that provides visibility into the performance of
198
- * network flows for your Amazon Web Services workloads, between instances in subnets, as well as to and
199
- * from Amazon Web Services. Lightweight agents that you install on the instances capture performance metrics
200
- * for your network flows, such as packet loss and latency, and send them to the Network Flow Monitor backend. Then, you can
201
- * view and analyze metrics from the top contributors for each metric type, to help troubleshoot issues.</p>
202
- * <p>In addition, when you create a monitor, Network Flow Monitor provides a network health indicator (NHI)
203
- * that informs you whether there were Amazon Web Services network issues for one or more of the network flows
204
- * tracked by a monitor, during a time period that you choose. By using this value, you can independently determine
205
- * if the Amazon Web Services network is impacting your workload during a specific time frame, to help you focus
206
- * troubleshooting efforts.</p>
207
- * <p>To learn more about Network Flow Monitor, see the
208
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor.html">Network Flow Monitor User Guide</a>
209
- * in the Amazon CloudWatch User Guide.</p>
197
+ * <p>Network Flow Monitor is a feature of Amazon CloudWatch Network Monitoring that provides visibility into the performance of network flows for your Amazon Web Services workloads, between instances in subnets, as well as to and from Amazon Web Services. Lightweight agents that you install on the instances capture performance metrics for your network flows, such as packet loss and latency, and send them to the Network Flow Monitor backend. Then, you can view and analyze metrics from the top contributors for each metric type, to help troubleshoot issues.</p> <p>In addition, when you create a monitor, Network Flow Monitor provides a network health indicator (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose. By using this value, you can independently determine if the Amazon Web Services network is impacting your workload during a specific time frame, to help you focus troubleshooting efforts.</p> <p>To learn more about Network Flow Monitor, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor.html">Network Flow Monitor User Guide</a> in the Amazon CloudWatch User Guide.</p>
210
198
  * @public
211
199
  */
212
200
  export declare class NetworkFlowMonitorClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, NetworkFlowMonitorClientResolvedConfig> {
@@ -27,11 +27,7 @@ declare const CreateMonitorCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Create a monitor for specific network flows between local and remote resources, so that you can monitor
31
- * network performance for one or several of your workloads. For each monitor, Network Flow Monitor publishes detailed
32
- * end-to-end performance metrics and a network health indicators (NHI) that informs you whether there were
33
- * Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose.
34
- * </p>
30
+ * <p>Create a monitor for specific network flows between local and remote resources, so that you can monitor network performance for one or several of your workloads. For each monitor, Network Flow Monitor publishes detailed end-to-end performance metrics and a network health indicators (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose. </p>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -27,11 +27,7 @@ declare const CreateScopeCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Create a scope of resources that you want to be available for Network Flow Monitor to generate metrics for,
31
- * when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend.
32
- * This call returns a scope ID to identify the scope.</p>
33
- * <p>When you create a scope, you enable permissions for Network Flow Monitor. The scope is set to the
34
- * resources for the Amazon Web Services that enables the feature.</p>
30
+ * <p>Create a scope of resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend. This call returns a scope ID to identify the scope.</p> <p>When you create a scope, you enable permissions for Network Flow Monitor. The scope is set to the resources for the Amazon Web Services that enables the feature.</p>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -59,7 +55,7 @@ declare const CreateScopeCommand_base: {
59
55
  * const response = await client.send(command);
60
56
  * // { // CreateScopeOutput
61
57
  * // scopeId: "STRING_VALUE", // required
62
- * // status: "SUCCEEDED" || "IN_PROGRESS" || "FAILED", // required
58
+ * // status: "SUCCEEDED" || "IN_PROGRESS" || "FAILED" || "DEACTIVATING" || "DEACTIVATED", // required
63
59
  * // scopeArn: "STRING_VALUE", // required
64
60
  * // tags: { // TagMap
65
61
  * // "<keys>": "STRING_VALUE",
@@ -27,8 +27,7 @@ declare const GetMonitorCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets information about a monitor in Network Flow Monitor based on a monitor name. The information returned includes
31
- * the Amazon Resource Name (ARN), create time, modified time, resources included in the monitor, and status information.</p>
30
+ * <p>Gets information about a monitor in Network Flow Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time, modified time, resources included in the monitor, and status information.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -27,16 +27,7 @@ declare const GetQueryResultsMonitorTopContributorsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Return the data for a query with the Network Flow Monitor query interface.
31
- * You specify the query that you want to return results for by providing a query ID
32
- * and a monitor name. This query returns the top contributors for a specific monitor.</p>
33
- * <p>Create a query ID for this call by calling the corresponding API call to start the query,
34
- * <code>StartQueryMonitorTopContributors</code>. Use the scope ID that was returned
35
- * for your account by <code>CreateScope</code>.</p>
36
- * <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
37
- * metric type. Top contributors can be across all workload insights, for a given scope, or for
38
- * a specific monitor. Use the applicable call for the top contributors that you want to be
39
- * returned.</p>
30
+ * <p>Return the data for a query with the Network Flow Monitor query interface. You specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors for a specific monitor.</p> <p>Create a query ID for this call by calling the corresponding API call to start the query, <code>StartQueryMonitorTopContributors</code>. Use the scope ID that was returned for your account by <code>CreateScope</code>.</p> <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.</p>
40
31
  * @example
41
32
  * Use a bare-bones client and the command you need to make an API call.
42
33
  * ```javascript
@@ -27,19 +27,7 @@ declare const GetQueryResultsWorkloadInsightsTopContributorsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Return the data for a query with the Network Flow Monitor query interface.
31
- * You specify the query that you want to return results for by providing a query ID
32
- * and a monitor name.</p>
33
- * <p>This query returns the top contributors for a scope for workload insights. Workload
34
- * insights provide a high level view of network flow performance data collected by agents.
35
- * To return the data for the top contributors, see <code>GetQueryResultsWorkloadInsightsTopContributorsData</code>.</p>
36
- * <p>Create a query ID for this call by calling the corresponding API call to start the query,
37
- * <code>StartQueryWorkloadInsightsTopContributors</code>. Use the scope ID that was returned
38
- * for your account by <code>CreateScope</code>.</p>
39
- * <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
40
- * metric type. Top contributors can be across all workload insights, for a given scope, or for
41
- * a specific monitor. Use the applicable call for the top contributors that you want to be
42
- * returned.</p>
30
+ * <p>Return the data for a query with the Network Flow Monitor query interface. You specify the query that you want to return results for by providing a query ID and a monitor name.</p> <p>This query returns the top contributors for a scope for workload insights. Workload insights provide a high level view of network flow performance data collected by agents. To return the data for the top contributors, see <code>GetQueryResultsWorkloadInsightsTopContributorsData</code>.</p> <p>Create a query ID for this call by calling the corresponding API call to start the query, <code>StartQueryWorkloadInsightsTopContributors</code>. Use the scope ID that was returned for your account by <code>CreateScope</code>.</p> <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.</p>
43
31
  * @example
44
32
  * Use a bare-bones client and the command you need to make an API call.
45
33
  * ```javascript
@@ -27,21 +27,7 @@ declare const GetQueryResultsWorkloadInsightsTopContributorsDataCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Return the data for a query with the Network Flow Monitor query interface.
31
- * Specify the query that you want to return results for by providing a query ID
32
- * and a scope ID.</p>
33
- * <p>This query returns the data for top contributors for workload insights for a specific scope.
34
- * Workload insights provide a high level view of network flow performance data collected by agents
35
- * for a scope. To return just the top contributors, see <code>GetQueryResultsWorkloadInsightsTopContributors</code>.</p>
36
- * <p>Create a query ID for this call by calling the corresponding API call to start the query,
37
- * <code>StartQueryWorkloadInsightsTopContributorsData</code>. Use the scope ID that was returned
38
- * for your account by <code>CreateScope</code>.</p>
39
- * <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
40
- * metric type. Top contributors can be across all workload insights, for a given scope, or for
41
- * a specific monitor. Use the applicable call for the top contributors that you want to be
42
- * returned.</p>
43
- * <p>The top contributor network flows overall are for a specific metric type, for example, the
44
- * number of retransmissions.</p>
30
+ * <p>Return the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a scope ID.</p> <p>This query returns the data for top contributors for workload insights for a specific scope. Workload insights provide a high level view of network flow performance data collected by agents for a scope. To return just the top contributors, see <code>GetQueryResultsWorkloadInsightsTopContributors</code>.</p> <p>Create a query ID for this call by calling the corresponding API call to start the query, <code>StartQueryWorkloadInsightsTopContributorsData</code>. Use the scope ID that was returned for your account by <code>CreateScope</code>.</p> <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.</p> <p>The top contributor network flows overall are for a specific metric type, for example, the number of retransmissions.</p>
45
31
  * @example
46
32
  * Use a bare-bones client and the command you need to make an API call.
47
33
  * ```javascript
@@ -27,13 +27,7 @@ declare const GetQueryStatusMonitorTopContributorsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor.
31
- * This call returns the query status for the top contributors for a monitor.</p>
32
- * <p>When you create a query, use this call to check the status of the query to make sure that it has
33
- * has <code>SUCCEEDED</code> before you review the results. Use the same query ID that you used for
34
- * the corresponding API call to start (create) the query, <code>StartQueryMonitorTopContributors</code>.</p>
35
- * <p>When you run a query, use this call to check the status of the query to make sure that the query
36
- * has <code>SUCCEEDED</code> before you review the results.</p>
30
+ * <p>Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status for the top contributors for a monitor.</p> <p>When you create a query, use this call to check the status of the query to make sure that it has has <code>SUCCEEDED</code> before you review the results. Use the same query ID that you used for the corresponding API call to start (create) the query, <code>StartQueryMonitorTopContributors</code>.</p> <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>
37
31
  * @example
38
32
  * Use a bare-bones client and the command you need to make an API call.
39
33
  * ```javascript
@@ -27,16 +27,7 @@ declare const GetQueryStatusWorkloadInsightsTopContributorsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Return the data for a query with the Network Flow Monitor query interface.
31
- * Specify the query that you want to return results for by providing a query ID
32
- * and a monitor name. This query returns the top contributors for workload insights.</p>
33
- * <p>When you start a query, use this call to check the status of the query to make sure that it has
34
- * has <code>SUCCEEDED</code> before you review the results. Use the same query ID that you used for
35
- * the corresponding API call to start the query, <code>StartQueryWorkloadInsightsTopContributors</code>.</p>
36
- * <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
37
- * metric type. Top contributors can be across all workload insights, for a given scope, or for
38
- * a specific monitor. Use the applicable call for the top contributors that you want to be
39
- * returned.</p>
30
+ * <p>Return the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors for workload insights.</p> <p>When you start a query, use this call to check the status of the query to make sure that it has has <code>SUCCEEDED</code> before you review the results. Use the same query ID that you used for the corresponding API call to start the query, <code>StartQueryWorkloadInsightsTopContributors</code>.</p> <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.</p>
40
31
  * @example
41
32
  * Use a bare-bones client and the command you need to make an API call.
42
33
  * ```javascript
@@ -27,17 +27,7 @@ declare const GetQueryStatusWorkloadInsightsTopContributorsDataCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor.
31
- * This call returns the query status for the top contributors data for workload insights.</p>
32
- * <p>When you start a query, use this call to check the status of the query to make sure that it has
33
- * has <code>SUCCEEDED</code> before you review the results. Use the same query ID that you used for
34
- * the corresponding API call to start the query, <code>StartQueryWorkloadInsightsTopContributorsData</code>.</p>
35
- * <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
36
- * metric type. Top contributors can be across all workload insights, for a given scope, or for
37
- * a specific monitor. Use the applicable call for the top contributors that you want to be
38
- * returned.</p>
39
- * <p>The top contributor network flows overall are for a specific metric type, for example, the
40
- * number of retransmissions.</p>
30
+ * <p>Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status for the top contributors data for workload insights.</p> <p>When you start a query, use this call to check the status of the query to make sure that it has has <code>SUCCEEDED</code> before you review the results. Use the same query ID that you used for the corresponding API call to start the query, <code>StartQueryWorkloadInsightsTopContributorsData</code>.</p> <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.</p> <p>The top contributor network flows overall are for a specific metric type, for example, the number of retransmissions.</p>
41
31
  * @example
42
32
  * Use a bare-bones client and the command you need to make an API call.
43
33
  * ```javascript
@@ -27,8 +27,7 @@ declare const GetScopeCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets information about a scope, including the name, status, tags, and target details.
31
- * The scope in Network Flow Monitor is an account.</p>
30
+ * <p>Gets information about a scope, including the name, status, tags, and target details. The scope in Network Flow Monitor is an account.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -42,7 +41,7 @@ declare const GetScopeCommand_base: {
42
41
  * const response = await client.send(command);
43
42
  * // { // GetScopeOutput
44
43
  * // scopeId: "STRING_VALUE", // required
45
- * // status: "SUCCEEDED" || "IN_PROGRESS" || "FAILED", // required
44
+ * // status: "SUCCEEDED" || "IN_PROGRESS" || "FAILED" || "DEACTIVATING" || "DEACTIVATED", // required
46
45
  * // scopeArn: "STRING_VALUE", // required
47
46
  * // targets: [ // TargetResourceList // required
48
47
  * // { // TargetResource
@@ -27,8 +27,7 @@ declare const ListMonitorsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>List all monitors in an account. Optionally, you can list only monitors that have a specific status, by
31
- * using the <code>STATUS</code> parameter.</p>
30
+ * <p>List all monitors in an account. Optionally, you can list only monitors that have a specific status, by using the <code>STATUS</code> parameter.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -44,7 +44,7 @@ declare const ListScopesCommand_base: {
44
44
  * // scopes: [ // ScopeSummaryList // required
45
45
  * // { // ScopeSummary
46
46
  * // scopeId: "STRING_VALUE", // required
47
- * // status: "SUCCEEDED" || "IN_PROGRESS" || "FAILED", // required
47
+ * // status: "SUCCEEDED" || "IN_PROGRESS" || "FAILED" || "DEACTIVATING" || "DEACTIVATED", // required
48
48
  * // scopeArn: "STRING_VALUE", // required
49
49
  * // },
50
50
  * // ],
@@ -27,16 +27,7 @@ declare const StartQueryMonitorTopContributorsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Create a query that you can use with the Network Flow Monitor query interface to return the top
31
- * contributors for a monitor. Specify the monitor that you want to create the query for. </p>
32
- * <p>The call returns a query ID that you can use with
33
- * <a href="https://docs.aws.amazon.com/networkflowmonitor/2.0/APIReference/API_GetQueryResultsMonitorTopContributors.html">
34
- * GetQueryResultsMonitorTopContributors</a>
35
- * to run the query and return the top contributors for a specific monitor.</p>
36
- * <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
37
- * metric type. Top contributors can be across all workload insights, for a given scope, or for
38
- * a specific monitor. Use the applicable APIs for the top contributors that you want to be
39
- * returned.</p>
30
+ * <p>Create a query that you can use with the Network Flow Monitor query interface to return the top contributors for a monitor. Specify the monitor that you want to create the query for. </p> <p>The call returns a query ID that you can use with <a href="https://docs.aws.amazon.com/networkflowmonitor/2.0/APIReference/API_GetQueryResultsMonitorTopContributors.html"> GetQueryResultsMonitorTopContributors</a> to run the query and return the top contributors for a specific monitor.</p> <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable APIs for the top contributors that you want to be returned.</p>
40
31
  * @example
41
32
  * Use a bare-bones client and the command you need to make an API call.
42
33
  * ```javascript
@@ -27,16 +27,7 @@ declare const StartQueryWorkloadInsightsTopContributorsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Create a query with the Network Flow Monitor query interface that you can run to return workload insights top contributors.
31
- * Specify the scope that you want to create a query for.</p>
32
- * <p>The call returns a query ID that you can use with
33
- * <a href="https://docs.aws.amazon.com/networkflowmonitor/2.0/APIReference/API_GetQueryResultsWorkloadInsightsTopContributors.html">
34
- * GetQueryResultsWorkloadInsightsTopContributors</a>
35
- * to run the query and return the top contributors for the workload insights for a scope.</p>
36
- * <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
37
- * metric type. Top contributors can be across all workload insights, for a given scope, or for
38
- * a specific monitor. Use the applicable APIs for the top contributors that you want to be
39
- * returned.</p>
30
+ * <p>Create a query with the Network Flow Monitor query interface that you can run to return workload insights top contributors. Specify the scope that you want to create a query for.</p> <p>The call returns a query ID that you can use with <a href="https://docs.aws.amazon.com/networkflowmonitor/2.0/APIReference/API_GetQueryResultsWorkloadInsightsTopContributors.html"> GetQueryResultsWorkloadInsightsTopContributors</a> to run the query and return the top contributors for the workload insights for a scope.</p> <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable APIs for the top contributors that you want to be returned.</p>
40
31
  * @example
41
32
  * Use a bare-bones client and the command you need to make an API call.
42
33
  * ```javascript
@@ -27,16 +27,7 @@ declare const StartQueryWorkloadInsightsTopContributorsDataCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Create a query with the Network Flow Monitor query interface that you can run to return data for
31
- * workload insights top contributors. Specify the scope that you want to create a query for.</p>
32
- * <p>The call returns a query ID that you can use with
33
- * <a href="https://docs.aws.amazon.com/networkflowmonitor/2.0/APIReference/API_GetQueryResultsWorkloadInsightsTopContributorsData.html">
34
- * GetQueryResultsWorkloadInsightsTopContributorsData</a>
35
- * to run the query and return the data for the top contributors for the workload insights for a scope.</p>
36
- * <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
37
- * metric type. Top contributors can be across all workload insights, for a given scope, or for
38
- * a specific monitor. Use the applicable call for the top contributors that you want to be
39
- * returned.</p>
30
+ * <p>Create a query with the Network Flow Monitor query interface that you can run to return data for workload insights top contributors. Specify the scope that you want to create a query for.</p> <p>The call returns a query ID that you can use with <a href="https://docs.aws.amazon.com/networkflowmonitor/2.0/APIReference/API_GetQueryResultsWorkloadInsightsTopContributorsData.html"> GetQueryResultsWorkloadInsightsTopContributorsData</a> to run the query and return the data for the top contributors for the workload insights for a scope.</p> <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.</p>
40
31
  * @example
41
32
  * Use a bare-bones client and the command you need to make an API call.
42
33
  * ```javascript
@@ -27,13 +27,7 @@ declare const StopQueryMonitorTopContributorsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Stop a top contributors query for a monitor.
31
- * Specify the query that you want to stop by providing a query ID
32
- * and a monitor name. </p>
33
- * <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
34
- * metric type. Top contributors can be across all workload insights, for a given scope, or for
35
- * a specific monitor. Use the applicable call for the top contributors that you want to be
36
- * returned.</p>
30
+ * <p>Stop a top contributors query for a monitor. Specify the query that you want to stop by providing a query ID and a monitor name. </p> <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.</p>
37
31
  * @example
38
32
  * Use a bare-bones client and the command you need to make an API call.
39
33
  * ```javascript
@@ -27,13 +27,7 @@ declare const StopQueryWorkloadInsightsTopContributorsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Stop a top contributors query for workload insights.
31
- * Specify the query that you want to stop by providing a query ID
32
- * and a scope ID. </p>
33
- * <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
34
- * metric type. Top contributors can be across all workload insights, for a given scope, or for
35
- * a specific monitor. Use the applicable call for the top contributors that you want to be
36
- * returned.</p>
30
+ * <p>Stop a top contributors query for workload insights. Specify the query that you want to stop by providing a query ID and a scope ID. </p> <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.</p>
37
31
  * @example
38
32
  * Use a bare-bones client and the command you need to make an API call.
39
33
  * ```javascript
@@ -27,13 +27,7 @@ declare const StopQueryWorkloadInsightsTopContributorsDataCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Stop a top contributors data query for workload insights.
31
- * Specify the query that you want to stop by providing a query ID
32
- * and a scope ID. </p>
33
- * <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
34
- * metric type. Top contributors can be across all workload insights, for a given scope, or for
35
- * a specific monitor. Use the applicable call for the top contributors that you want to be
36
- * returned.</p>
30
+ * <p>Stop a top contributors data query for workload insights. Specify the query that you want to stop by providing a query ID and a scope ID. </p> <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.</p>
37
31
  * @example
38
32
  * Use a bare-bones client and the command you need to make an API call.
39
33
  * ```javascript
@@ -27,8 +27,7 @@ declare const UpdateScopeCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Update a scope to add or remove resources that you want to be available for Network Flow Monitor to generate metrics for,
31
- * when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend.</p>
30
+ * <p>Update a scope to add or remove resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -64,7 +63,7 @@ declare const UpdateScopeCommand_base: {
64
63
  * const response = await client.send(command);
65
64
  * // { // UpdateScopeOutput
66
65
  * // scopeId: "STRING_VALUE", // required
67
- * // status: "SUCCEEDED" || "IN_PROGRESS" || "FAILED", // required
66
+ * // status: "SUCCEEDED" || "IN_PROGRESS" || "FAILED" || "DEACTIVATING" || "DEACTIVATED", // required
68
67
  * // scopeArn: "STRING_VALUE", // required
69
68
  * // tags: { // TagMap
70
69
  * // "<keys>": "STRING_VALUE",
@@ -1,17 +1,5 @@
1
1
  /**
2
- * <p>Network Flow Monitor is a feature of Amazon CloudWatch Network Monitoring that provides visibility into the performance of
3
- * network flows for your Amazon Web Services workloads, between instances in subnets, as well as to and
4
- * from Amazon Web Services. Lightweight agents that you install on the instances capture performance metrics
5
- * for your network flows, such as packet loss and latency, and send them to the Network Flow Monitor backend. Then, you can
6
- * view and analyze metrics from the top contributors for each metric type, to help troubleshoot issues.</p>
7
- * <p>In addition, when you create a monitor, Network Flow Monitor provides a network health indicator (NHI)
8
- * that informs you whether there were Amazon Web Services network issues for one or more of the network flows
9
- * tracked by a monitor, during a time period that you choose. By using this value, you can independently determine
10
- * if the Amazon Web Services network is impacting your workload during a specific time frame, to help you focus
11
- * troubleshooting efforts.</p>
12
- * <p>To learn more about Network Flow Monitor, see the
13
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor.html">Network Flow Monitor User Guide</a>
14
- * in the Amazon CloudWatch User Guide.</p>
2
+ * <p>Network Flow Monitor is a feature of Amazon CloudWatch Network Monitoring that provides visibility into the performance of network flows for your Amazon Web Services workloads, between instances in subnets, as well as to and from Amazon Web Services. Lightweight agents that you install on the instances capture performance metrics for your network flows, such as packet loss and latency, and send them to the Network Flow Monitor backend. Then, you can view and analyze metrics from the top contributors for each metric type, to help troubleshoot issues.</p> <p>In addition, when you create a monitor, Network Flow Monitor provides a network health indicator (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose. By using this value, you can independently determine if the Amazon Web Services network is impacting your workload during a specific time frame, to help you focus troubleshooting efforts.</p> <p>To learn more about Network Flow Monitor, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor.html">Network Flow Monitor User Guide</a> in the Amazon CloudWatch User Guide.</p>
15
3
  *
16
4
  * @packageDocumentation
17
5
  */