@aws-sdk/client-networkflowmonitor 3.839.0 → 3.840.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.
- package/dist-types/commands/DeleteScopeCommand.d.ts +3 -0
- package/dist-types/commands/GetQueryResultsMonitorTopContributorsCommand.d.ts +3 -1
- package/dist-types/commands/GetQueryResultsWorkloadInsightsTopContributorsCommand.d.ts +3 -1
- package/dist-types/commands/GetQueryResultsWorkloadInsightsTopContributorsDataCommand.d.ts +4 -2
- package/dist-types/commands/GetQueryStatusMonitorTopContributorsCommand.d.ts +3 -3
- package/dist-types/commands/GetQueryStatusWorkloadInsightsTopContributorsCommand.d.ts +3 -1
- package/dist-types/commands/GetQueryStatusWorkloadInsightsTopContributorsDataCommand.d.ts +4 -2
- package/dist-types/commands/StartQueryMonitorTopContributorsCommand.d.ts +9 -4
- package/dist-types/commands/StartQueryWorkloadInsightsTopContributorsCommand.d.ts +9 -4
- package/dist-types/commands/StartQueryWorkloadInsightsTopContributorsDataCommand.d.ts +9 -4
- package/dist-types/commands/StopQueryMonitorTopContributorsCommand.d.ts +5 -3
- package/dist-types/commands/StopQueryWorkloadInsightsTopContributorsCommand.d.ts +5 -3
- package/dist-types/commands/StopQueryWorkloadInsightsTopContributorsDataCommand.d.ts +6 -8
- package/dist-types/commands/UpdateScopeCommand.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +9 -9
- package/package.json +12 -12
|
@@ -52,6 +52,9 @@ declare const DeleteScopeCommand_base: {
|
|
|
52
52
|
* @throws {@link AccessDeniedException} (client fault)
|
|
53
53
|
* <p>You don't have sufficient permission to perform this action.</p>
|
|
54
54
|
*
|
|
55
|
+
* @throws {@link ConflictException} (client fault)
|
|
56
|
+
* <p>The requested resource is in use.</p>
|
|
57
|
+
*
|
|
55
58
|
* @throws {@link InternalServerException} (server fault)
|
|
56
59
|
* <p>An internal error occurred.</p>
|
|
57
60
|
*
|
|
@@ -34,7 +34,9 @@ declare const GetQueryResultsMonitorTopContributorsCommand_base: {
|
|
|
34
34
|
* <code>StartQueryMonitorTopContributors</code>. Use the scope ID that was returned
|
|
35
35
|
* for your account by <code>CreateScope</code>.</p>
|
|
36
36
|
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
|
|
37
|
-
* metric type
|
|
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>
|
|
38
40
|
* @example
|
|
39
41
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
42
|
* ```javascript
|
|
@@ -37,7 +37,9 @@ declare const GetQueryResultsWorkloadInsightsTopContributorsCommand_base: {
|
|
|
37
37
|
* <code>StartQueryWorkloadInsightsTopContributors</code>. Use the scope ID that was returned
|
|
38
38
|
* for your account by <code>CreateScope</code>.</p>
|
|
39
39
|
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
|
|
40
|
-
* metric type
|
|
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>
|
|
41
43
|
* @example
|
|
42
44
|
* Use a bare-bones client and the command you need to make an API call.
|
|
43
45
|
* ```javascript
|
|
@@ -37,8 +37,10 @@ declare const GetQueryResultsWorkloadInsightsTopContributorsDataCommand_base: {
|
|
|
37
37
|
* <code>StartQueryWorkloadInsightsTopContributorsData</code>. Use the scope ID that was returned
|
|
38
38
|
* for your account by <code>CreateScope</code>.</p>
|
|
39
39
|
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
|
|
40
|
-
* metric type
|
|
41
|
-
*
|
|
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
|
|
42
44
|
* number of retransmissions.</p>
|
|
43
45
|
* @example
|
|
44
46
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,9 +29,9 @@ declare const GetQueryStatusMonitorTopContributorsCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor.
|
|
31
31
|
* This call returns the query status for the top contributors for a monitor.</p>
|
|
32
|
-
* <p>When you
|
|
33
|
-
* has <code>SUCCEEDED</code> before you
|
|
34
|
-
* the corresponding API call to start the query, <code>StartQueryMonitorTopContributors</code>.</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
35
|
* <p>When you run a query, use this call to check the status of the query to make sure that the query
|
|
36
36
|
* has <code>SUCCEEDED</code> before you review the results.</p>
|
|
37
37
|
* @example
|
|
@@ -34,7 +34,9 @@ declare const GetQueryStatusWorkloadInsightsTopContributorsCommand_base: {
|
|
|
34
34
|
* has <code>SUCCEEDED</code> before you review the results. Use the same query ID that you used for
|
|
35
35
|
* the corresponding API call to start the query, <code>StartQueryWorkloadInsightsTopContributors</code>.</p>
|
|
36
36
|
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
|
|
37
|
-
* metric type
|
|
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>
|
|
38
40
|
* @example
|
|
39
41
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
42
|
* ```javascript
|
|
@@ -33,8 +33,10 @@ declare const GetQueryStatusWorkloadInsightsTopContributorsDataCommand_base: {
|
|
|
33
33
|
* has <code>SUCCEEDED</code> before you review the results. Use the same query ID that you used for
|
|
34
34
|
* the corresponding API call to start the query, <code>StartQueryWorkloadInsightsTopContributorsData</code>.</p>
|
|
35
35
|
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
|
|
36
|
-
* metric type
|
|
37
|
-
*
|
|
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
|
|
38
40
|
* number of retransmissions.</p>
|
|
39
41
|
* @example
|
|
40
42
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -27,11 +27,16 @@ declare const StartQueryMonitorTopContributorsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* Specify the
|
|
32
|
-
*
|
|
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>
|
|
33
36
|
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
|
|
34
|
-
* metric type
|
|
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>
|
|
35
40
|
* @example
|
|
36
41
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
42
|
* ```javascript
|
|
@@ -27,11 +27,16 @@ declare const StartQueryWorkloadInsightsTopContributorsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* Specify the
|
|
32
|
-
*
|
|
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>
|
|
33
36
|
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
|
|
34
|
-
* metric type
|
|
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>
|
|
35
40
|
* @example
|
|
36
41
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
42
|
* ```javascript
|
|
@@ -27,11 +27,16 @@ declare const StartQueryWorkloadInsightsTopContributorsDataCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* Specify the
|
|
32
|
-
*
|
|
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>
|
|
33
36
|
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
|
|
34
|
-
* metric type
|
|
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>
|
|
35
40
|
* @example
|
|
36
41
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
42
|
* ```javascript
|
|
@@ -27,11 +27,13 @@ declare const StopQueryMonitorTopContributorsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Stop a
|
|
30
|
+
* <p>Stop a top contributors query for a monitor.
|
|
31
31
|
* Specify the query that you want to stop by providing a query ID
|
|
32
|
-
* and a monitor name.
|
|
32
|
+
* and a monitor name. </p>
|
|
33
33
|
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
|
|
34
|
-
* metric type
|
|
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>
|
|
35
37
|
* @example
|
|
36
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
39
|
* ```javascript
|
|
@@ -27,11 +27,13 @@ declare const StopQueryWorkloadInsightsTopContributorsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Stop a
|
|
30
|
+
* <p>Stop a top contributors query for workload insights.
|
|
31
31
|
* Specify the query that you want to stop by providing a query ID
|
|
32
|
-
* and a
|
|
32
|
+
* and a scope ID. </p>
|
|
33
33
|
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
|
|
34
|
-
* metric type
|
|
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>
|
|
35
37
|
* @example
|
|
36
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
39
|
* ```javascript
|
|
@@ -27,15 +27,13 @@ declare const StopQueryWorkloadInsightsTopContributorsDataCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* Specify the query that you want to
|
|
32
|
-
* and a scope ID.
|
|
33
|
-
* Workload insights provide a high level view of network flow performance data collected by agents
|
|
34
|
-
* for a scope.</p>
|
|
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>
|
|
35
33
|
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
|
|
36
|
-
* metric type
|
|
37
|
-
*
|
|
38
|
-
*
|
|
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>
|
|
39
37
|
* @example
|
|
40
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
39
|
* ```javascript
|
|
@@ -82,6 +82,9 @@ declare const UpdateScopeCommand_base: {
|
|
|
82
82
|
* @throws {@link AccessDeniedException} (client fault)
|
|
83
83
|
* <p>You don't have sufficient permission to perform this action.</p>
|
|
84
84
|
*
|
|
85
|
+
* @throws {@link ConflictException} (client fault)
|
|
86
|
+
* <p>The requested resource is in use.</p>
|
|
87
|
+
*
|
|
85
88
|
* @throws {@link InternalServerException} (server fault)
|
|
86
89
|
* <p>An internal error occurred.</p>
|
|
87
90
|
*
|
|
@@ -557,7 +557,7 @@ export interface GetQueryResultsMonitorTopContributorsInput {
|
|
|
557
557
|
monitorName: string | undefined;
|
|
558
558
|
/**
|
|
559
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
|
|
560
|
+
* identifier for a specific query returned from an API call to create a query.</p>
|
|
561
561
|
* @public
|
|
562
562
|
*/
|
|
563
563
|
queryId: string | undefined;
|
|
@@ -861,7 +861,7 @@ export interface GetQueryResultsWorkloadInsightsTopContributorsInput {
|
|
|
861
861
|
scopeId: string | undefined;
|
|
862
862
|
/**
|
|
863
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
|
|
864
|
+
* identifier for a specific query returned from an API call to create a query.</p>
|
|
865
865
|
* @public
|
|
866
866
|
*/
|
|
867
867
|
queryId: string | undefined;
|
|
@@ -956,7 +956,7 @@ export interface GetQueryResultsWorkloadInsightsTopContributorsDataInput {
|
|
|
956
956
|
scopeId: string | undefined;
|
|
957
957
|
/**
|
|
958
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
|
|
959
|
+
* identifier for a specific query returned from an API call to create a query.</p>
|
|
960
960
|
* @public
|
|
961
961
|
*/
|
|
962
962
|
queryId: string | undefined;
|
|
@@ -1435,9 +1435,9 @@ export interface StartQueryMonitorTopContributorsInput {
|
|
|
1435
1435
|
*/
|
|
1436
1436
|
endTime: Date | undefined;
|
|
1437
1437
|
/**
|
|
1438
|
-
* <p>The metric that you want to query top contributors for. That is, you can specify
|
|
1439
|
-
* return the top contributor network flows, for
|
|
1440
|
-
* a specific category, such as network flows between Availability Zones.</p>
|
|
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>
|
|
1441
1441
|
* @public
|
|
1442
1442
|
*/
|
|
1443
1443
|
metricName: MonitorMetric | undefined;
|
|
@@ -1501,7 +1501,7 @@ export interface StopQueryMonitorTopContributorsInput {
|
|
|
1501
1501
|
monitorName: string | undefined;
|
|
1502
1502
|
/**
|
|
1503
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
|
|
1504
|
+
* identifier for a specific query returned from an API call to create a query.</p>
|
|
1505
1505
|
* @public
|
|
1506
1506
|
*/
|
|
1507
1507
|
queryId: string | undefined;
|
|
@@ -1783,7 +1783,7 @@ export interface StopQueryWorkloadInsightsTopContributorsInput {
|
|
|
1783
1783
|
scopeId: string | undefined;
|
|
1784
1784
|
/**
|
|
1785
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
|
|
1786
|
+
* identifier for a specific query returned from an API call to create a query.</p>
|
|
1787
1787
|
* @public
|
|
1788
1788
|
*/
|
|
1789
1789
|
queryId: string | undefined;
|
|
@@ -1806,7 +1806,7 @@ export interface StopQueryWorkloadInsightsTopContributorsDataInput {
|
|
|
1806
1806
|
scopeId: string | undefined;
|
|
1807
1807
|
/**
|
|
1808
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
|
|
1809
|
+
* identifier for a specific query returned from an API call to create a query.</p>
|
|
1810
1810
|
* @public
|
|
1811
1811
|
*/
|
|
1812
1812
|
queryId: string | undefined;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-networkflowmonitor",
|
|
3
3
|
"description": "AWS SDK for JavaScript Networkflowmonitor Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.840.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -20,17 +20,17 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
23
|
-
"@aws-sdk/core": "3.
|
|
24
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
25
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
26
|
-
"@aws-sdk/middleware-logger": "3.
|
|
27
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
28
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
29
|
-
"@aws-sdk/region-config-resolver": "3.
|
|
30
|
-
"@aws-sdk/types": "3.
|
|
31
|
-
"@aws-sdk/util-endpoints": "3.
|
|
32
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
33
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
23
|
+
"@aws-sdk/core": "3.840.0",
|
|
24
|
+
"@aws-sdk/credential-provider-node": "3.840.0",
|
|
25
|
+
"@aws-sdk/middleware-host-header": "3.840.0",
|
|
26
|
+
"@aws-sdk/middleware-logger": "3.840.0",
|
|
27
|
+
"@aws-sdk/middleware-recursion-detection": "3.840.0",
|
|
28
|
+
"@aws-sdk/middleware-user-agent": "3.840.0",
|
|
29
|
+
"@aws-sdk/region-config-resolver": "3.840.0",
|
|
30
|
+
"@aws-sdk/types": "3.840.0",
|
|
31
|
+
"@aws-sdk/util-endpoints": "3.840.0",
|
|
32
|
+
"@aws-sdk/util-user-agent-browser": "3.840.0",
|
|
33
|
+
"@aws-sdk/util-user-agent-node": "3.840.0",
|
|
34
34
|
"@smithy/config-resolver": "^4.1.4",
|
|
35
35
|
"@smithy/core": "^3.6.0",
|
|
36
36
|
"@smithy/fetch-http-handler": "^5.0.4",
|