feat(client-networkflowmonitor): Add ConflictExceptions to UpdateScope and DeleteScope operations for scopes being mutated.

awstools · awstools · commit 417e154554be · 2025-06-30T18:36:46.000Z
diff --git a/clients/client-networkflowmonitor/src/commands/DeleteScopeCommand.ts b/clients/client-networkflowmonitor/src/commands/DeleteScopeCommand.ts
@@ -57,6 +57,9 @@ export interface DeleteScopeCommandOutput extends DeleteScopeOutput, __MetadataB
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You don't have sufficient permission to perform this action.</p>
  *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The requested resource is in use.</p>
+ *
  * @throws {@link InternalServerException} (server fault)
  *  <p>An internal error occurred.</p>
  *
diff --git a/clients/client-networkflowmonitor/src/commands/GetQueryResultsMonitorTopContributorsCommand.ts b/clients/client-networkflowmonitor/src/commands/GetQueryResultsMonitorTopContributorsCommand.ts
@@ -47,7 +47,9 @@ export interface GetQueryResultsMonitorTopContributorsCommandOutput
  *    		<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, related to a scope (for workload insights) or a monitor.</p>
+ *    		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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-networkflowmonitor/src/commands/GetQueryResultsWorkloadInsightsTopContributorsCommand.ts b/clients/client-networkflowmonitor/src/commands/GetQueryResultsWorkloadInsightsTopContributorsCommand.ts
@@ -51,7 +51,9 @@ export interface GetQueryResultsWorkloadInsightsTopContributorsCommandOutput
  *    		<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, related to a scope (for workload insights) or a monitor.</p>
+ *    		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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-networkflowmonitor/src/commands/GetQueryResultsWorkloadInsightsTopContributorsDataCommand.ts b/clients/client-networkflowmonitor/src/commands/GetQueryResultsWorkloadInsightsTopContributorsDataCommand.ts
@@ -51,8 +51,10 @@ export interface GetQueryResultsWorkloadInsightsTopContributorsDataCommandOutput
  *    		<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, related to a scope (for workload insights) or a monitor.</p>
- *          <p>The top contributor network flows overall for a specific metric type, for example, the
+ *    		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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
diff --git a/clients/client-networkflowmonitor/src/commands/GetQueryStatusMonitorTopContributorsCommand.ts b/clients/client-networkflowmonitor/src/commands/GetQueryStatusMonitorTopContributorsCommand.ts
@@ -42,9 +42,9 @@ export interface GetQueryStatusMonitorTopContributorsCommandOutput
 /**
  * <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 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 reviewStartQueryWorkloadInsightsTopContributorsData  the results. Use the same query ID that you used for
- *    		the corresponding API call to start the query, <code>StartQueryMonitorTopContributors</code>.</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>
  * @example
diff --git a/clients/client-networkflowmonitor/src/commands/GetQueryStatusWorkloadInsightsTopContributorsCommand.ts b/clients/client-networkflowmonitor/src/commands/GetQueryStatusWorkloadInsightsTopContributorsCommand.ts
@@ -48,7 +48,9 @@ export interface GetQueryStatusWorkloadInsightsTopContributorsCommandOutput
  *    		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, related to a scope (for workload insights) or a monitor.</p>
+ *    		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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-networkflowmonitor/src/commands/GetQueryStatusWorkloadInsightsTopContributorsDataCommand.ts b/clients/client-networkflowmonitor/src/commands/GetQueryStatusWorkloadInsightsTopContributorsDataCommand.ts
@@ -47,8 +47,10 @@ export interface GetQueryStatusWorkloadInsightsTopContributorsDataCommandOutput
  *    		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, related to a scope (for workload insights) or a monitor.</p>
- *          <p>The top contributor network flows overall for a specific metric type, for example, the
+ *    		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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
diff --git a/clients/client-networkflowmonitor/src/commands/StartQueryMonitorTopContributorsCommand.ts b/clients/client-networkflowmonitor/src/commands/StartQueryMonitorTopContributorsCommand.ts
@@ -37,11 +37,16 @@ export interface StartQueryMonitorTopContributorsCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Start a query to return the data 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 a specific monitor.</p>
+ * <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, related to a scope (for workload insights) or a monitor.</p>
+ *    		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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-networkflowmonitor/src/commands/StartQueryWorkloadInsightsTopContributorsCommand.ts b/clients/client-networkflowmonitor/src/commands/StartQueryWorkloadInsightsTopContributorsCommand.ts
@@ -41,11 +41,16 @@ export interface StartQueryWorkloadInsightsTopContributorsCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Start a query to return the data with the Network Flow Monitor query interface.
- *    		Specify the query that you want to start by providing a query ID
- *    		and a monitor name. This query returns the top contributors for a specific monitor.</p>
+ * <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, related to a scope (for workload insights) or a monitor.</p>
+ *    		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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-networkflowmonitor/src/commands/StartQueryWorkloadInsightsTopContributorsDataCommand.ts b/clients/client-networkflowmonitor/src/commands/StartQueryWorkloadInsightsTopContributorsDataCommand.ts
@@ -41,11 +41,16 @@ export interface StartQueryWorkloadInsightsTopContributorsDataCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Start a query to return the with the Network Flow Monitor query interface.
- *    		Specify the query that you want to start by providing a query ID
- *    		and a monitor name. This query returns the data for top contributors for workload insights.</p>
+ * <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, related to a scope (for workload insights) or a monitor.</p>
+ *    		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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-networkflowmonitor/src/commands/StopQueryMonitorTopContributorsCommand.ts b/clients/client-networkflowmonitor/src/commands/StopQueryMonitorTopContributorsCommand.ts
@@ -37,11 +37,13 @@ export interface StopQueryMonitorTopContributorsCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Stop a query with the Network Flow Monitor query interface.
+ * <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. This query returns the top contributors for a specific monitor.</p>
+ *    		and a monitor name. </p>
  *          <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
- *    		metric type, related to a scope (for workload insights) or a monitor.</p>
+ *    		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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-networkflowmonitor/src/commands/StopQueryWorkloadInsightsTopContributorsCommand.ts b/clients/client-networkflowmonitor/src/commands/StopQueryWorkloadInsightsTopContributorsCommand.ts
@@ -41,11 +41,13 @@ export interface StopQueryWorkloadInsightsTopContributorsCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Stop a query with the Network Flow Monitor query interface.
+ * <p>Stop a top contributors query for workload insights.
  *    		Specify the query that you want to stop by providing a query ID
- *    		and a monitor name. This query returns the top contributors for a specific monitor.</p>
+ *    		and a scope ID. </p>
  *          <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
- *    		metric type, related to a scope (for workload insights) or a monitor.</p>
+ *    		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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-networkflowmonitor/src/commands/StopQueryWorkloadInsightsTopContributorsDataCommand.ts b/clients/client-networkflowmonitor/src/commands/StopQueryWorkloadInsightsTopContributorsDataCommand.ts
@@ -41,15 +41,13 @@ export interface StopQueryWorkloadInsightsTopContributorsDataCommandOutput
     __MetadataBearer {}
 
 /**
- * <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. This query returns data for the top contributors for workload insights.
- *    		Workload insights provide a high level view of network flow performance data collected by agents
- *    		for a scope.</p>
+ * <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, related to a scope (for workload insights) or a monitor.</p>
- *          <p>The top contributor network flows overall for a specific metric type, for example, the
- *    		number of retransmissions.</p>
+ *    		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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-networkflowmonitor/src/commands/UpdateScopeCommand.ts b/clients/client-networkflowmonitor/src/commands/UpdateScopeCommand.ts
@@ -87,6 +87,9 @@ export interface UpdateScopeCommandOutput extends UpdateScopeOutput, __MetadataB
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You don't have sufficient permission to perform this action.</p>
  *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The requested resource is in use.</p>
+ *
  * @throws {@link InternalServerException} (server fault)
  *  <p>An internal error occurred.</p>
  *
diff --git a/clients/client-networkflowmonitor/src/models/models_0.ts b/clients/client-networkflowmonitor/src/models/models_0.ts
@@ -677,7 +677,7 @@ export interface GetQueryResultsMonitorTopContributorsInput {
 
   /**
    * <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>
+   *    		identifier for a specific query returned from an API call to create a query.</p>
    * @public
    */
   queryId: string | undefined;
@@ -1025,7 +1025,7 @@ export interface GetQueryResultsWorkloadInsightsTopContributorsInput {
 
   /**
    * <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>
+   *    		identifier for a specific query returned from an API call to create a query.</p>
    * @public
    */
   queryId: string | undefined;
@@ -1135,7 +1135,7 @@ export interface GetQueryResultsWorkloadInsightsTopContributorsDataInput {
 
   /**
    * <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>
+   *    		identifier for a specific query returned from an API call to create a query.</p>
    * @public
    */
   queryId: string | undefined;
@@ -1662,9 +1662,9 @@ export interface StartQueryMonitorTopContributorsInput {
   endTime: Date | undefined;
 
   /**
-   * <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>
+   * <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>
    * @public
    */
   metricName: MonitorMetric | undefined;
@@ -1733,7 +1733,7 @@ export interface StopQueryMonitorTopContributorsInput {
 
   /**
    * <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>
+   *    		identifier for a specific query returned from an API call to create a query.</p>
    * @public
    */
   queryId: string | undefined;
@@ -2046,7 +2046,7 @@ export interface StopQueryWorkloadInsightsTopContributorsInput {
 
   /**
    * <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>
+   *    		identifier for a specific query returned from an API call to create a query.</p>
    * @public
    */
   queryId: string | undefined;
@@ -2071,7 +2071,7 @@ export interface StopQueryWorkloadInsightsTopContributorsDataInput {
 
   /**
    * <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>
+   *    		identifier for a specific query returned from an API call to create a query.</p>
    * @public
    */
   queryId: string | undefined;
diff --git a/codegen/sdk-codegen/aws-models/networkflowmonitor.json b/codegen/sdk-codegen/aws-models/networkflowmonitor.json

Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,9 @@ export interface DeleteScopeCommandOutput extends DeleteScopeOutput, __MetadataB`
`57`	`57`	`* @throws {@link AccessDeniedException} (client fault)`
`58`	`58`	`* <p>You don't have sufficient permission to perform this action.</p>`
`59`	`59`	`*`
	`60`	`+ * @throws {@link ConflictException} (client fault)`
	`61`	`+ * <p>The requested resource is in use.</p>`
	`62`	`+ *`
`60`	`63`	`* @throws {@link InternalServerException} (server fault)`
`61`	`64`	`* <p>An internal error occurred.</p>`
`62`	`65`	`*`