Skip to content

Commit 417e154

Browse files
author
awstools
committed
feat(client-networkflowmonitor): Add ConflictExceptions to UpdateScope and DeleteScope operations for scopes being mutated.
1 parent 3e92ce7 commit 417e154

16 files changed

+117
-81
lines changed

‎clients/client-networkflowmonitor/src/commands/DeleteScopeCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@ export interface DeleteScopeCommandOutput extends DeleteScopeOutput, __MetadataB
5757
* @throws {@link AccessDeniedException} (client fault)
5858
* <p>You don't have sufficient permission to perform this action.</p>
5959
*
60+
* @throws {@link ConflictException} (client fault)
61+
* <p>The requested resource is in use.</p>
62+
*
6063
* @throws {@link InternalServerException} (server fault)
6164
* <p>An internal error occurred.</p>
6265
*

‎clients/client-networkflowmonitor/src/commands/GetQueryResultsMonitorTopContributorsCommand.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,9 @@ export interface GetQueryResultsMonitorTopContributorsCommandOutput
4747
* <code>StartQueryMonitorTopContributors</code>. Use the scope ID that was returned
4848
* for your account by <code>CreateScope</code>.</p>
4949
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
50-
* metric type, related to a scope (for workload insights) or a monitor.</p>
50+
* metric type. Top contributors can be across all workload insights, for a given scope, or for
51+
* a specific monitor. Use the applicable call for the top contributors that you want to be
52+
* returned.</p>
5153
* @example
5254
* Use a bare-bones client and the command you need to make an API call.
5355
* ```javascript

‎clients/client-networkflowmonitor/src/commands/GetQueryResultsWorkloadInsightsTopContributorsCommand.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,9 @@ export interface GetQueryResultsWorkloadInsightsTopContributorsCommandOutput
5151
* <code>StartQueryWorkloadInsightsTopContributors</code>. Use the scope ID that was returned
5252
* for your account by <code>CreateScope</code>.</p>
5353
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
54-
* metric type, related to a scope (for workload insights) or a monitor.</p>
54+
* metric type. Top contributors can be across all workload insights, for a given scope, or for
55+
* a specific monitor. Use the applicable call for the top contributors that you want to be
56+
* returned.</p>
5557
* @example
5658
* Use a bare-bones client and the command you need to make an API call.
5759
* ```javascript

‎clients/client-networkflowmonitor/src/commands/GetQueryResultsWorkloadInsightsTopContributorsDataCommand.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,10 @@ export interface GetQueryResultsWorkloadInsightsTopContributorsDataCommandOutput
5151
* <code>StartQueryWorkloadInsightsTopContributorsData</code>. Use the scope ID that was returned
5252
* for your account by <code>CreateScope</code>.</p>
5353
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
54-
* metric type, related to a scope (for workload insights) or a monitor.</p>
55-
* <p>The top contributor network flows overall for a specific metric type, for example, the
54+
* metric type. Top contributors can be across all workload insights, for a given scope, or for
55+
* a specific monitor. Use the applicable call for the top contributors that you want to be
56+
* returned.</p>
57+
* <p>The top contributor network flows overall are for a specific metric type, for example, the
5658
* number of retransmissions.</p>
5759
* @example
5860
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-networkflowmonitor/src/commands/GetQueryStatusMonitorTopContributorsCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ export interface GetQueryStatusMonitorTopContributorsCommandOutput
4242
/**
4343
* <p>Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor.
4444
* This call returns the query status for the top contributors for a monitor.</p>
45-
* <p>When you start a query, use this call to check the status of the query to make sure that it has
46-
* has <code>SUCCEEDED</code> before you reviewStartQueryWorkloadInsightsTopContributorsData the results. Use the same query ID that you used for
47-
* the corresponding API call to start the query, <code>StartQueryMonitorTopContributors</code>.</p>
45+
* <p>When you create a query, use this call to check the status of the query to make sure that it has
46+
* has <code>SUCCEEDED</code> before you review the results. Use the same query ID that you used for
47+
* the corresponding API call to start (create) the query, <code>StartQueryMonitorTopContributors</code>.</p>
4848
* <p>When you run a query, use this call to check the status of the query to make sure that the query
4949
* has <code>SUCCEEDED</code> before you review the results.</p>
5050
* @example

‎clients/client-networkflowmonitor/src/commands/GetQueryStatusWorkloadInsightsTopContributorsCommand.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ export interface GetQueryStatusWorkloadInsightsTopContributorsCommandOutput
4848
* has <code>SUCCEEDED</code> before you review the results. Use the same query ID that you used for
4949
* the corresponding API call to start the query, <code>StartQueryWorkloadInsightsTopContributors</code>.</p>
5050
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
51-
* metric type, related to a scope (for workload insights) or a monitor.</p>
51+
* metric type. Top contributors can be across all workload insights, for a given scope, or for
52+
* a specific monitor. Use the applicable call for the top contributors that you want to be
53+
* returned.</p>
5254
* @example
5355
* Use a bare-bones client and the command you need to make an API call.
5456
* ```javascript

‎clients/client-networkflowmonitor/src/commands/GetQueryStatusWorkloadInsightsTopContributorsDataCommand.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,10 @@ export interface GetQueryStatusWorkloadInsightsTopContributorsDataCommandOutput
4747
* has <code>SUCCEEDED</code> before you review the results. Use the same query ID that you used for
4848
* the corresponding API call to start the query, <code>StartQueryWorkloadInsightsTopContributorsData</code>.</p>
4949
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
50-
* metric type, related to a scope (for workload insights) or a monitor.</p>
51-
* <p>The top contributor network flows overall for a specific metric type, for example, the
50+
* metric type. Top contributors can be across all workload insights, for a given scope, or for
51+
* a specific monitor. Use the applicable call for the top contributors that you want to be
52+
* returned.</p>
53+
* <p>The top contributor network flows overall are for a specific metric type, for example, the
5254
* number of retransmissions.</p>
5355
* @example
5456
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-networkflowmonitor/src/commands/StartQueryMonitorTopContributorsCommand.ts

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,16 @@ export interface StartQueryMonitorTopContributorsCommandOutput
3737
__MetadataBearer {}
3838

3939
/**
40-
* <p>Start a query to return the data with the Network Flow Monitor query interface.
41-
* Specify the query that you want to return results for by providing a query ID
42-
* and a monitor name. This query returns the top contributors for a specific monitor.</p>
40+
* <p>Create a query that you can use with the Network Flow Monitor query interface to return the top
41+
* contributors for a monitor. Specify the monitor that you want to create the query for. </p>
42+
* <p>The call returns a query ID that you can use with
43+
* <a href="https://docs.aws.amazon.com/networkflowmonitor/2.0/APIReference/API_GetQueryResultsMonitorTopContributors.html">
44+
* GetQueryResultsMonitorTopContributors</a>
45+
* to run the query and return the top contributors for a specific monitor.</p>
4346
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
44-
* metric type, related to a scope (for workload insights) or a monitor.</p>
47+
* metric type. Top contributors can be across all workload insights, for a given scope, or for
48+
* a specific monitor. Use the applicable APIs for the top contributors that you want to be
49+
* returned.</p>
4550
* @example
4651
* Use a bare-bones client and the command you need to make an API call.
4752
* ```javascript

‎clients/client-networkflowmonitor/src/commands/StartQueryWorkloadInsightsTopContributorsCommand.ts

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,16 @@ export interface StartQueryWorkloadInsightsTopContributorsCommandOutput
4141
__MetadataBearer {}
4242

4343
/**
44-
* <p>Start a query to return the data with the Network Flow Monitor query interface.
45-
* Specify the query that you want to start by providing a query ID
46-
* and a monitor name. This query returns the top contributors for a specific monitor.</p>
44+
* <p>Create a query with the Network Flow Monitor query interface that you can run to return workload insights top contributors.
45+
* Specify the scope that you want to create a query for.</p>
46+
* <p>The call returns a query ID that you can use with
47+
* <a href="https://docs.aws.amazon.com/networkflowmonitor/2.0/APIReference/API_GetQueryResultsWorkloadInsightsTopContributors.html">
48+
* GetQueryResultsWorkloadInsightsTopContributors</a>
49+
* to run the query and return the top contributors for the workload insights for a scope.</p>
4750
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
48-
* metric type, related to a scope (for workload insights) or a monitor.</p>
51+
* metric type. Top contributors can be across all workload insights, for a given scope, or for
52+
* a specific monitor. Use the applicable APIs for the top contributors that you want to be
53+
* returned.</p>
4954
* @example
5055
* Use a bare-bones client and the command you need to make an API call.
5156
* ```javascript

‎clients/client-networkflowmonitor/src/commands/StartQueryWorkloadInsightsTopContributorsDataCommand.ts

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,16 @@ export interface StartQueryWorkloadInsightsTopContributorsDataCommandOutput
4141
__MetadataBearer {}
4242

4343
/**
44-
* <p>Start a query to return the with the Network Flow Monitor query interface.
45-
* Specify the query that you want to start by providing a query ID
46-
* and a monitor name. This query returns the data for top contributors for workload insights.</p>
44+
* <p>Create a query with the Network Flow Monitor query interface that you can run to return data for
45+
* workload insights top contributors. Specify the scope that you want to create a query for.</p>
46+
* <p>The call returns a query ID that you can use with
47+
* <a href="https://docs.aws.amazon.com/networkflowmonitor/2.0/APIReference/API_GetQueryResultsWorkloadInsightsTopContributorsData.html">
48+
* GetQueryResultsWorkloadInsightsTopContributorsData</a>
49+
* to run the query and return the data for the top contributors for the workload insights for a scope.</p>
4750
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
48-
* metric type, related to a scope (for workload insights) or a monitor.</p>
51+
* metric type. Top contributors can be across all workload insights, for a given scope, or for
52+
* a specific monitor. Use the applicable call for the top contributors that you want to be
53+
* returned.</p>
4954
* @example
5055
* Use a bare-bones client and the command you need to make an API call.
5156
* ```javascript

‎clients/client-networkflowmonitor/src/commands/StopQueryMonitorTopContributorsCommand.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,13 @@ export interface StopQueryMonitorTopContributorsCommandOutput
3737
__MetadataBearer {}
3838

3939
/**
40-
* <p>Stop a query with the Network Flow Monitor query interface.
40+
* <p>Stop a top contributors query for a monitor.
4141
* Specify the query that you want to stop by providing a query ID
42-
* and a monitor name. This query returns the top contributors for a specific monitor.</p>
42+
* and a monitor name. </p>
4343
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
44-
* metric type, related to a scope (for workload insights) or a monitor.</p>
44+
* metric type. Top contributors can be across all workload insights, for a given scope, or for
45+
* a specific monitor. Use the applicable call for the top contributors that you want to be
46+
* returned.</p>
4547
* @example
4648
* Use a bare-bones client and the command you need to make an API call.
4749
* ```javascript

‎clients/client-networkflowmonitor/src/commands/StopQueryWorkloadInsightsTopContributorsCommand.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,13 @@ export interface StopQueryWorkloadInsightsTopContributorsCommandOutput
4141
__MetadataBearer {}
4242

4343
/**
44-
* <p>Stop a query with the Network Flow Monitor query interface.
44+
* <p>Stop a top contributors query for workload insights.
4545
* Specify the query that you want to stop by providing a query ID
46-
* and a monitor name. This query returns the top contributors for a specific monitor.</p>
46+
* and a scope ID. </p>
4747
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
48-
* metric type, related to a scope (for workload insights) or a monitor.</p>
48+
* metric type. Top contributors can be across all workload insights, for a given scope, or for
49+
* a specific monitor. Use the applicable call for the top contributors that you want to be
50+
* returned.</p>
4951
* @example
5052
* Use a bare-bones client and the command you need to make an API call.
5153
* ```javascript

‎clients/client-networkflowmonitor/src/commands/StopQueryWorkloadInsightsTopContributorsDataCommand.ts

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,13 @@ export interface StopQueryWorkloadInsightsTopContributorsDataCommandOutput
4141
__MetadataBearer {}
4242

4343
/**
44-
* <p>Return the data for a query with the Network Flow Monitor query interface.
45-
* Specify the query that you want to return results for by providing a query ID
46-
* and a scope ID. This query returns data for the top contributors for workload insights.
47-
* Workload insights provide a high level view of network flow performance data collected by agents
48-
* for a scope.</p>
44+
* <p>Stop a top contributors data query for workload insights.
45+
* Specify the query that you want to stop by providing a query ID
46+
* and a scope ID. </p>
4947
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
50-
* metric type, related to a scope (for workload insights) or a monitor.</p>
51-
* <p>The top contributor network flows overall for a specific metric type, for example, the
52-
* number of retransmissions.</p>
48+
* metric type. Top contributors can be across all workload insights, for a given scope, or for
49+
* a specific monitor. Use the applicable call for the top contributors that you want to be
50+
* returned.</p>
5351
* @example
5452
* Use a bare-bones client and the command you need to make an API call.
5553
* ```javascript

‎clients/client-networkflowmonitor/src/commands/UpdateScopeCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,9 @@ export interface UpdateScopeCommandOutput extends UpdateScopeOutput, __MetadataB
8787
* @throws {@link AccessDeniedException} (client fault)
8888
* <p>You don't have sufficient permission to perform this action.</p>
8989
*
90+
* @throws {@link ConflictException} (client fault)
91+
* <p>The requested resource is in use.</p>
92+
*
9093
* @throws {@link InternalServerException} (server fault)
9194
* <p>An internal error occurred.</p>
9295
*

‎clients/client-networkflowmonitor/src/models/models_0.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -677,7 +677,7 @@ export interface GetQueryResultsMonitorTopContributorsInput {
677677

678678
/**
679679
* <p>The identifier for the query. A query ID is an internally-generated
680-
* identifier for a specific query returned from an API call to start a query.</p>
680+
* identifier for a specific query returned from an API call to create a query.</p>
681681
* @public
682682
*/
683683
queryId: string | undefined;
@@ -1025,7 +1025,7 @@ export interface GetQueryResultsWorkloadInsightsTopContributorsInput {
10251025

10261026
/**
10271027
* <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>
1028+
* identifier for a specific query returned from an API call to create a query.</p>
10291029
* @public
10301030
*/
10311031
queryId: string | undefined;
@@ -1135,7 +1135,7 @@ export interface GetQueryResultsWorkloadInsightsTopContributorsDataInput {
11351135

11361136
/**
11371137
* <p>The identifier for the query. A query ID is an internally-generated
1138-
* identifier for a specific query returned from an API call to start a query.</p>
1138+
* identifier for a specific query returned from an API call to create a query.</p>
11391139
* @public
11401140
*/
11411141
queryId: string | undefined;
@@ -1662,9 +1662,9 @@ export interface StartQueryMonitorTopContributorsInput {
16621662
endTime: Date | undefined;
16631663

16641664
/**
1665-
* <p>The metric that you want to query top contributors for. That is, you can specify this metric to
1666-
* return the top contributor network flows, for this type of metric, for a monitor and (optionally) within
1667-
* a specific category, such as network flows between Availability Zones.</p>
1665+
* <p>The metric that you want to query top contributors for. That is, you can specify a metric
1666+
* with this call and return the top contributor network flows, for that type of metric, for a monitor
1667+
* and (optionally) within a specific category, such as network flows between Availability Zones.</p>
16681668
* @public
16691669
*/
16701670
metricName: MonitorMetric | undefined;
@@ -1733,7 +1733,7 @@ export interface StopQueryMonitorTopContributorsInput {
17331733

17341734
/**
17351735
* <p>The identifier for the query. A query ID is an internally-generated
1736-
* identifier for a specific query returned from an API call to start a query.</p>
1736+
* identifier for a specific query returned from an API call to create a query.</p>
17371737
* @public
17381738
*/
17391739
queryId: string | undefined;
@@ -2046,7 +2046,7 @@ export interface StopQueryWorkloadInsightsTopContributorsInput {
20462046

20472047
/**
20482048
* <p>The identifier for the query. A query ID is an internally-generated
2049-
* identifier for a specific query returned from an API call to start a query.</p>
2049+
* identifier for a specific query returned from an API call to create a query.</p>
20502050
* @public
20512051
*/
20522052
queryId: string | undefined;
@@ -2071,7 +2071,7 @@ export interface StopQueryWorkloadInsightsTopContributorsDataInput {
20712071

20722072
/**
20732073
* <p>The identifier for the query. A query ID is an internally-generated
2074-
* identifier for a specific query returned from an API call to start a query.</p>
2074+
* identifier for a specific query returned from an API call to create a query.</p>
20752075
* @public
20762076
*/
20772077
queryId: string | undefined;

0 commit comments

Comments
 (0)