Skip to content

Commit b81cdfe

Browse files
author
awstools
committed
feat(client-networkflowmonitor): This release contains 2 changes. 1: DeleteScope/GetScope/UpdateScope operations now return 404 instead of 500 when the resource does not exist. 2: Expected string format for clientToken fields of CreateMonitorInput/CreateScopeInput/UpdateMonitorInput have been updated to be an UUID based string.
1 parent bd1ac1d commit b81cdfe

9 files changed

+52
-22
lines changed

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,9 @@ export interface DeleteScopeCommandOutput extends DeleteScopeOutput, __MetadataB
6060
* @throws {@link InternalServerException} (server fault)
6161
* <p>An internal error occurred.</p>
6262
*
63+
* @throws {@link ResourceNotFoundException} (client fault)
64+
* <p>The request specifies a resource that doesn't exist.</p>
65+
*
6366
* @throws {@link ServiceQuotaExceededException} (client fault)
6467
* <p>The request exceeded a service quota.</p>
6568
*

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@ export interface GetQueryResultsWorkloadInsightsTopContributorsCommandOutput
4343
/**
4444
* <p>Return the data for a query with the Network Flow Monitor query interface.
4545
* You specify the query that you want to return results for by providing a query ID
46-
* and a monitor name. This query returns the top contributors for a specific monitor.</p>
46+
* and a monitor name.</p>
47+
* <p>This query returns the top contributors for a scope for workload insights. Workload
48+
* insights provide a high level view of network flow performance data collected by agents.
49+
* To return the data for the top contributors, see <code>GetQueryResultsWorkloadInsightsTopContributorsData</code>.</p>
4750
* <p>Create a query ID for this call by calling the corresponding API call to start the query,
4851
* <code>StartQueryWorkloadInsightsTopContributors</code>. Use the scope ID that was returned
4952
* for your account by <code>CreateScope</code>.</p>

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,10 @@ export interface GetQueryResultsWorkloadInsightsTopContributorsDataCommandOutput
4343
/**
4444
* <p>Return the data for a query with the Network Flow Monitor query interface.
4545
* 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.
46+
* and a scope ID.</p>
47+
* <p>This query returns the data for top contributors for workload insights for a specific scope.
4748
* Workload insights provide a high level view of network flow performance data collected by agents
48-
* for a scope.</p>
49+
* for a scope. To return just the top contributors, see <code>GetQueryResultsWorkloadInsightsTopContributors</code>.</p>
4950
* <p>Create a query ID for this call by calling the corresponding API call to start the query,
5051
* <code>StartQueryWorkloadInsightsTopContributorsData</code>. Use the scope ID that was returned
5152
* for your account by <code>CreateScope</code>.</p>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export interface GetQueryStatusMonitorTopContributorsCommandOutput
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>
4545
* <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 review the results. Use the same query ID that you used for
46+
* has <code>SUCCEEDED</code> before you reviewStartQueryWorkloadInsightsTopContributorsData the results. Use the same query ID that you used for
4747
* the corresponding API call to start 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>

clients/client-networkflowmonitor/src/commands/GetScopeCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,9 @@ export interface GetScopeCommandOutput extends GetScopeOutput, __MetadataBearer
7979
* @throws {@link InternalServerException} (server fault)
8080
* <p>An internal error occurred.</p>
8181
*
82+
* @throws {@link ResourceNotFoundException} (client fault)
83+
* <p>The request specifies a resource that doesn't exist.</p>
84+
*
8285
* @throws {@link ServiceQuotaExceededException} (client fault)
8386
* <p>The request exceeded a service quota.</p>
8487
*

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

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,11 @@ export interface StartQueryWorkloadInsightsTopContributorsDataCommandOutput
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>
49-
* <p>A query ID is returned from an API call to start a query of a specific type; for
50-
* example </p>
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>
5147
* <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific
5248
* metric type, related to a scope (for workload insights) or a monitor.</p>
53-
* <p>The top contributor network flows overall for a specific metric type, for example, the
54-
* number of retransmissions.</p>
5549
* @example
5650
* Use a bare-bones client and the command you need to make an API call.
5751
* ```javascript

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,9 @@ export interface UpdateScopeCommandOutput extends UpdateScopeOutput, __MetadataB
9090
* @throws {@link InternalServerException} (server fault)
9191
* <p>An internal error occurred.</p>
9292
*
93+
* @throws {@link ResourceNotFoundException} (client fault)
94+
* <p>The request specifies a resource that doesn't exist.</p>
95+
*
9396
* @throws {@link ServiceQuotaExceededException} (client fault)
9497
* <p>The request exceeded a service quota.</p>
9598
*

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1687,7 +1687,11 @@ export interface StartQueryMonitorTopContributorsInput {
16871687
* </li>
16881688
* <li>
16891689
* <p>
1690-
* <code>AWS_SERVICES</code>: Top contributor network flows to or from Amazon Web Services services</p>
1690+
* <code>AMAZON_S3</code>: Top contributor network flows to or from Amazon S3</p>
1691+
* </li>
1692+
* <li>
1693+
* <p>
1694+
* <code>AMAZON_DYNAMODB</code>: Top contributor network flows to or from Amazon Dynamo DB</p>
16911695
* </li>
16921696
* <li>
16931697
* <p>

codegen/sdk-codegen/aws-models/networkflowmonitor.json

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@
134134
}
135135
},
136136
"clientToken": {
137-
"target": "smithy.api#String",
137+
"target": "com.amazonaws.networkflowmonitor#UuidString",
138138
"traits": {
139139
"smithy.api#documentation": "<p>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for\n \t\tother API requests.</p>",
140140
"smithy.api#idempotencyToken": {}
@@ -270,7 +270,7 @@
270270
}
271271
},
272272
"clientToken": {
273-
"target": "smithy.api#String",
273+
"target": "com.amazonaws.networkflowmonitor#UuidString",
274274
"traits": {
275275
"smithy.api#documentation": "<p>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent \n \t\tAPI request. Don't reuse the same client token for other API requests.</p>",
276276
"smithy.api#idempotencyToken": {}
@@ -397,6 +397,9 @@
397397
{
398398
"target": "com.amazonaws.networkflowmonitor#InternalServerException"
399399
},
400+
{
401+
"target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException"
402+
},
400403
{
401404
"target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException"
402405
},
@@ -758,7 +761,7 @@
758761
"aws.iam#iamAction": {
759762
"documentation": "Grants permission to get the results of a query that retrieves top contributors for workload insights"
760763
},
761-
"smithy.api#documentation": "<p>Return the data for a query with the Network Flow Monitor query interface. \n \t\tYou specify the query that you want to return results for by providing a query ID \n \t\tand a monitor name. This query returns the top contributors for a specific monitor.</p>\n <p>Create a query ID for this call by calling the corresponding API call to start the query, \n \t\t<code>StartQueryWorkloadInsightsTopContributors</code>. Use the scope ID that was returned\n \t\tfor your account by <code>CreateScope</code>.</p>\n <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific \n \t\tmetric type, related to a scope (for workload insights) or a monitor.</p>",
764+
"smithy.api#documentation": "<p>Return the data for a query with the Network Flow Monitor query interface. \n \t\tYou specify the query that you want to return results for by providing a query ID \n \t\tand a monitor name.</p>\n <p>This query returns the top contributors for a scope for workload insights. Workload \n \t\tinsights provide a high level view of network flow performance data collected by agents.\n \t\tTo return the data for the top contributors, see <code>GetQueryResultsWorkloadInsightsTopContributorsData</code>.</p>\n <p>Create a query ID for this call by calling the corresponding API call to start the query, \n \t\t<code>StartQueryWorkloadInsightsTopContributors</code>. Use the scope ID that was returned\n \t\tfor your account by <code>CreateScope</code>.</p>\n <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific \n \t\tmetric type, related to a scope (for workload insights) or a monitor.</p>",
762765
"smithy.api#http": {
763766
"uri": "/workloadInsights/{scopeId}/topContributorsQueries/{queryId}/results",
764767
"method": "GET"
@@ -805,7 +808,7 @@
805808
"aws.iam#iamAction": {
806809
"documentation": "Grants permission to get the results of a query that retrieves top contributors data points for workload insights"
807810
},
808-
"smithy.api#documentation": "<p>Return the data for a query with the Network Flow Monitor query interface. \n \t\tSpecify the query that you want to return results for by providing a query ID \n \t\tand a scope ID. This query returns data for the top contributors for workload insights.\n \t\tWorkload insights provide a high level view of network flow performance data collected by agents \n \t\tfor a scope.</p>\n <p>Create a query ID for this call by calling the corresponding API call to start the query, \n \t\t<code>StartQueryWorkloadInsightsTopContributorsData</code>. Use the scope ID that was returned\n \t\tfor your account by <code>CreateScope</code>.</p>\n <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific \n \t\tmetric type, related to a scope (for workload insights) or a monitor.</p>\n <p>The top contributor network flows overall for a specific metric type, for example, the \n \t\tnumber of retransmissions.</p>",
811+
"smithy.api#documentation": "<p>Return the data for a query with the Network Flow Monitor query interface. \n \t\tSpecify the query that you want to return results for by providing a query ID \n \t\tand a scope ID.</p>\n <p>This query returns the data for top contributors for workload insights for a specific scope. \n \t\tWorkload insights provide a high level view of network flow performance data collected by agents \n \t\tfor a scope. To return just the top contributors, see <code>GetQueryResultsWorkloadInsightsTopContributors</code>.</p>\n <p>Create a query ID for this call by calling the corresponding API call to start the query, \n \t\t<code>StartQueryWorkloadInsightsTopContributorsData</code>. Use the scope ID that was returned\n \t\tfor your account by <code>CreateScope</code>.</p>\n <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific \n \t\tmetric type, related to a scope (for workload insights) or a monitor.</p>\n <p>The top contributor network flows overall for a specific metric type, for example, the \n \t\tnumber of retransmissions.</p>",
809812
"smithy.api#http": {
810813
"uri": "/workloadInsights/{scopeId}/topContributorsDataQueries/{queryId}/results",
811814
"method": "GET"
@@ -973,7 +976,7 @@
973976
"aws.iam#iamAction": {
974977
"documentation": "Grants permission to get the status of a query that retrieves top contributors data for a monitor"
975978
},
976-
"smithy.api#documentation": "<p>Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. \n \t\tThis call returns the query status for the top contributors for a monitor.</p>\n <p>When you start a query, use this call to check the status of the query to make sure that it has \n \t\thas <code>SUCCEEDED</code> before you review the results. Use the same query ID that you used for \n \t\tthe corresponding API call to start the query, <code>StartQueryMonitorTopContributors</code>.</p>\n <p>When you run a query, use this call to check the status of the query to make sure that the query \n \t\thas <code>SUCCEEDED</code> before you review the results.</p>",
979+
"smithy.api#documentation": "<p>Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. \n \t\tThis call returns the query status for the top contributors for a monitor.</p>\n <p>When you start a query, use this call to check the status of the query to make sure that it has \n \t\thas <code>SUCCEEDED</code> before you reviewStartQueryWorkloadInsightsTopContributorsData the results. Use the same query ID that you used for \n \t\tthe corresponding API call to start the query, <code>StartQueryMonitorTopContributors</code>.</p>\n <p>When you run a query, use this call to check the status of the query to make sure that the query \n \t\thas <code>SUCCEEDED</code> before you review the results.</p>",
977980
"smithy.api#http": {
978981
"uri": "/monitors/{monitorName}/topContributorsQueries/{queryId}/status",
979982
"method": "GET"
@@ -1189,6 +1192,9 @@
11891192
{
11901193
"target": "com.amazonaws.networkflowmonitor#InternalServerException"
11911194
},
1195+
{
1196+
"target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException"
1197+
},
11921198
{
11931199
"target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException"
11941200
},
@@ -2878,7 +2884,7 @@
28782884
"destinationCategory": {
28792885
"target": "com.amazonaws.networkflowmonitor#DestinationCategory",
28802886
"traits": {
2881-
"smithy.api#documentation": "<p>The category that you want to query top contributors for, for a specific monitor. Destination\n \t\tcategories can be one of the following: </p>\n <ul>\n <li>\n <p>\n <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p>\n </li>\n <li>\n <p>\n <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p>\n </li>\n <li>\n <p>\n <code>INTER_VPC</code>: Top contributor network flows between VPCs</p>\n </li>\n <li>\n <p>\n <code>AWS_SERVICES</code>: Top contributor network flows to or from Amazon Web Services services</p>\n </li>\n <li>\n <p>\n <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p>\n </li>\n </ul>",
2887+
"smithy.api#documentation": "<p>The category that you want to query top contributors for, for a specific monitor. Destination\n \t\tcategories can be one of the following: </p>\n <ul>\n <li>\n <p>\n <code>INTRA_AZ</code>: Top contributor network flows within a single Availability Zone</p>\n </li>\n <li>\n <p>\n <code>INTER_AZ</code>: Top contributor network flows between Availability Zones</p>\n </li>\n <li>\n <p>\n <code>INTER_VPC</code>: Top contributor network flows between VPCs</p>\n </li>\n <li>\n <p>\n <code>AMAZON_S3</code>: Top contributor network flows to or from Amazon S3</p>\n </li>\n <li>\n <p>\n <code>AMAZON_DYNAMODB</code>: Top contributor network flows to or from Amazon Dynamo DB</p>\n </li>\n <li>\n <p>\n <code>UNCLASSIFIED</code>: Top contributor network flows that do not have a bucket classification</p>\n </li>\n </ul>",
28822888
"smithy.api#required": {}
28832889
}
28842890
},
@@ -2976,7 +2982,7 @@
29762982
"aws.iam#iamAction": {
29772983
"documentation": "Grants permission to start a query for retrieving top contributors data points for workload insights"
29782984
},
2979-
"smithy.api#documentation": "<p>Return the data for a query with the Network Flow Monitor query interface. \n \t\tSpecify the query that you want to return results for by providing a query ID \n \t\tand a scope ID. This query returns data for the top contributors for workload insights.\n \t\tWorkload insights provide a high level view of network flow performance data collected by agents \n \t\tfor a scope.</p>\n <p>A query ID is returned from an API call to start a query of a specific type; for\n \t\texample </p>\n <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific \n \t\tmetric type, related to a scope (for workload insights) or a monitor.</p>\n <p>The top contributor network flows overall for a specific metric type, for example, the \n \t\tnumber of retransmissions.</p>",
2985+
"smithy.api#documentation": "<p>Start a query to return the with the Network Flow Monitor query interface.\n \t\tSpecify the query that you want to start by providing a query ID \n \t\tand a monitor name. This query returns the data for top contributors for workload insights.</p>\n <p>Top contributors in Network Flow Monitor are network flows with the highest values for a specific \n \t\tmetric type, related to a scope (for workload insights) or a monitor.</p>",
29802986
"smithy.api#http": {
29812987
"uri": "/workloadInsights/{scopeId}/topContributorsDataQueries",
29822988
"method": "POST"
@@ -3748,7 +3754,7 @@
37483754
}
37493755
},
37503756
"clientToken": {
3751-
"target": "smithy.api#String",
3757+
"target": "com.amazonaws.networkflowmonitor#UuidString",
37523758
"traits": {
37533759
"smithy.api#documentation": "<p>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for\n \t\tother API requests.</p>",
37543760
"smithy.api#idempotencyToken": {}
@@ -3837,6 +3843,9 @@
38373843
{
38383844
"target": "com.amazonaws.networkflowmonitor#InternalServerException"
38393845
},
3846+
{
3847+
"target": "com.amazonaws.networkflowmonitor#ResourceNotFoundException"
3848+
},
38403849
{
38413850
"target": "com.amazonaws.networkflowmonitor#ServiceQuotaExceededException"
38423851
},
@@ -3930,6 +3939,16 @@
39303939
"smithy.api#output": {}
39313940
}
39323941
},
3942+
"com.amazonaws.networkflowmonitor#UuidString": {
3943+
"type": "string",
3944+
"traits": {
3945+
"smithy.api#length": {
3946+
"min": 36,
3947+
"max": 36
3948+
},
3949+
"smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$"
3950+
}
3951+
},
39333952
"com.amazonaws.networkflowmonitor#ValidationException": {
39343953
"type": "structure",
39353954
"members": {

0 commit comments

Comments
 (0)