Skip to content

Commit 0838059

Browse files
author
awstools
committed
feat(client-networkflowmonitor): Added new enum value (AWS::Region) for type field under MonitorLocalResource and MonitorRemoteResource. Workload Insights and Monitor top contributors queries now support a new DestinationCategory (INTER_REGION).
1 parent ac324bb commit 0838059

11 files changed

+119
-92
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface CreateMonitorCommandInput extends CreateMonitorInput {}
3232
export interface CreateMonitorCommandOutput extends CreateMonitorOutput, __MetadataBearer {}
3333

3434
/**
35-
* <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+
* <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 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. </p>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.
3838
* ```javascript
@@ -43,13 +43,13 @@ export interface CreateMonitorCommandOutput extends CreateMonitorOutput, __Metad
4343
* monitorName: "STRING_VALUE", // required
4444
* localResources: [ // MonitorLocalResources // required
4545
* { // MonitorLocalResource
46-
* type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet", // required
46+
* type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::Region", // required
4747
* identifier: "STRING_VALUE", // required
4848
* },
4949
* ],
5050
* remoteResources: [ // MonitorRemoteResources
5151
* { // MonitorRemoteResource
52-
* type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService", // required
52+
* type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService" || "AWS::Region", // required
5353
* identifier: "STRING_VALUE", // required
5454
* },
5555
* ],
@@ -67,13 +67,13 @@ export interface CreateMonitorCommandOutput extends CreateMonitorOutput, __Metad
6767
* // monitorStatus: "PENDING" || "ACTIVE" || "INACTIVE" || "ERROR" || "DELETING", // required
6868
* // localResources: [ // MonitorLocalResources // required
6969
* // { // MonitorLocalResource
70-
* // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet", // required
70+
* // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::Region", // required
7171
* // identifier: "STRING_VALUE", // required
7272
* // },
7373
* // ],
7474
* // remoteResources: [ // MonitorRemoteResources // required
7575
* // { // MonitorRemoteResource
76-
* // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService", // required
76+
* // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService" || "AWS::Region", // required
7777
* // identifier: "STRING_VALUE", // required
7878
* // },
7979
* // ],

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface CreateScopeCommandInput extends CreateScopeInput {}
3232
export interface CreateScopeCommandOutput extends CreateScopeOutput, __MetadataBearer {}
3333

3434
/**
35-
* <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+
* <p>In Network Flow Monitor, you specify a scope for the service to generate metrics for. By using the scope, Network Flow Monitor can generate a topology of all the resources to measure performance metrics for. When you create a scope, you enable permissions for Network Flow Monitor.</p> <p>A scope is a Region-account pair or multiple Region-account pairs. Network Flow Monitor uses your scope to determine all the resources (the topology) where Network Flow Monitor will gather network flow performance metrics for you. To provide performance metrics, Network Flow Monitor uses the data that is sent by the Network Flow Monitor agents you install on the resources.</p> <p>To define the Region-account pairs for your scope, the Network Flow Monitor API uses the following constucts, which allow for future flexibility in defining scopes:</p> <ul> <li> <p> <i>Targets</i>, which are arrays of targetResources.</p> </li> <li> <p> <i>Target resources</i>, which are Region-targetIdentifier pairs.</p> </li> <li> <p> <i>Target identifiers</i>, made up of a targetID (currently always an account ID) and a targetType (currently always an account). </p> </li> </ul>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.
3838
* ```javascript

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@ export interface DeleteMonitorCommandOutput extends DeleteMonitorOutput, __Metad
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/GetMonitorCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,13 @@ export interface GetMonitorCommandOutput extends GetMonitorOutput, __MetadataBea
5050
* // monitorStatus: "PENDING" || "ACTIVE" || "INACTIVE" || "ERROR" || "DELETING", // required
5151
* // localResources: [ // MonitorLocalResources // required
5252
* // { // MonitorLocalResource
53-
* // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet", // required
53+
* // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::Region", // required
5454
* // identifier: "STRING_VALUE", // required
5555
* // },
5656
* // ],
5757
* // remoteResources: [ // MonitorRemoteResources // required
5858
* // { // MonitorRemoteResource
59-
* // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService", // required
59+
* // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService" || "AWS::Region", // required
6060
* // identifier: "STRING_VALUE", // required
6161
* // },
6262
* // ],

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ export interface GetQueryResultsMonitorTopContributorsCommandOutput
6767
* // localAz: "STRING_VALUE",
6868
* // localSubnetId: "STRING_VALUE",
6969
* // targetPort: Number("int"),
70-
* // destinationCategory: "INTRA_AZ" || "INTER_AZ" || "INTER_VPC" || "UNCLASSIFIED" || "AMAZON_S3" || "AMAZON_DYNAMODB",
70+
* // destinationCategory: "INTRA_AZ" || "INTER_AZ" || "INTER_VPC" || "UNCLASSIFIED" || "AMAZON_S3" || "AMAZON_DYNAMODB" || "INTER_REGION",
7171
* // remoteVpcId: "STRING_VALUE",
7272
* // remoteRegion: "STRING_VALUE",
7373
* // remoteAz: "STRING_VALUE",

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ export interface StartQueryMonitorTopContributorsCommandOutput
4949
* startTime: new Date("TIMESTAMP"), // required
5050
* endTime: new Date("TIMESTAMP"), // required
5151
* metricName: "ROUND_TRIP_TIME" || "TIMEOUTS" || "RETRANSMISSIONS" || "DATA_TRANSFERRED", // required
52-
* destinationCategory: "INTRA_AZ" || "INTER_AZ" || "INTER_VPC" || "UNCLASSIFIED" || "AMAZON_S3" || "AMAZON_DYNAMODB", // required
52+
* destinationCategory: "INTRA_AZ" || "INTER_AZ" || "INTER_VPC" || "UNCLASSIFIED" || "AMAZON_S3" || "AMAZON_DYNAMODB" || "INTER_REGION", // required
5353
* limit: Number("int"),
5454
* };
5555
* const command = new StartQueryMonitorTopContributorsCommand(input);

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ export interface StartQueryWorkloadInsightsTopContributorsCommandOutput
5353
* startTime: new Date("TIMESTAMP"), // required
5454
* endTime: new Date("TIMESTAMP"), // required
5555
* metricName: "TIMEOUTS" || "RETRANSMISSIONS" || "DATA_TRANSFERRED", // required
56-
* destinationCategory: "INTRA_AZ" || "INTER_AZ" || "INTER_VPC" || "UNCLASSIFIED" || "AMAZON_S3" || "AMAZON_DYNAMODB", // required
56+
* destinationCategory: "INTRA_AZ" || "INTER_AZ" || "INTER_VPC" || "UNCLASSIFIED" || "AMAZON_S3" || "AMAZON_DYNAMODB" || "INTER_REGION", // required
5757
* limit: Number("int"),
5858
* };
5959
* const command = new StartQueryWorkloadInsightsTopContributorsCommand(input);

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ export interface StartQueryWorkloadInsightsTopContributorsDataCommandOutput
5353
* startTime: new Date("TIMESTAMP"), // required
5454
* endTime: new Date("TIMESTAMP"), // required
5555
* metricName: "TIMEOUTS" || "RETRANSMISSIONS" || "DATA_TRANSFERRED", // required
56-
* destinationCategory: "INTRA_AZ" || "INTER_AZ" || "INTER_VPC" || "UNCLASSIFIED" || "AMAZON_S3" || "AMAZON_DYNAMODB", // required
56+
* destinationCategory: "INTRA_AZ" || "INTER_AZ" || "INTER_VPC" || "UNCLASSIFIED" || "AMAZON_S3" || "AMAZON_DYNAMODB" || "INTER_REGION", // required
5757
* };
5858
* const command = new StartQueryWorkloadInsightsTopContributorsDataCommand(input);
5959
* const response = await client.send(command);

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,25 +43,25 @@ export interface UpdateMonitorCommandOutput extends UpdateMonitorOutput, __Metad
4343
* monitorName: "STRING_VALUE", // required
4444
* localResourcesToAdd: [ // MonitorLocalResources
4545
* { // MonitorLocalResource
46-
* type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet", // required
46+
* type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::Region", // required
4747
* identifier: "STRING_VALUE", // required
4848
* },
4949
* ],
5050
* localResourcesToRemove: [
5151
* {
52-
* type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet", // required
52+
* type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::Region", // required
5353
* identifier: "STRING_VALUE", // required
5454
* },
5555
* ],
5656
* remoteResourcesToAdd: [ // MonitorRemoteResources
5757
* { // MonitorRemoteResource
58-
* type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService", // required
58+
* type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService" || "AWS::Region", // required
5959
* identifier: "STRING_VALUE", // required
6060
* },
6161
* ],
6262
* remoteResourcesToRemove: [
6363
* {
64-
* type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService", // required
64+
* type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService" || "AWS::Region", // required
6565
* identifier: "STRING_VALUE", // required
6666
* },
6767
* ],
@@ -75,13 +75,13 @@ export interface UpdateMonitorCommandOutput extends UpdateMonitorOutput, __Metad
7575
* // monitorStatus: "PENDING" || "ACTIVE" || "INACTIVE" || "ERROR" || "DELETING", // required
7676
* // localResources: [ // MonitorLocalResources // required
7777
* // { // MonitorLocalResource
78-
* // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet", // required
78+
* // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::Region", // required
7979
* // identifier: "STRING_VALUE", // required
8080
* // },
8181
* // ],
8282
* // remoteResources: [ // MonitorRemoteResources // required
8383
* // { // MonitorRemoteResource
84-
* // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService", // required
84+
* // type: "AWS::EC2::VPC" || "AWS::AvailabilityZone" || "AWS::EC2::Subnet" || "AWS::AWSService" || "AWS::Region", // required
8585
* // identifier: "STRING_VALUE", // required
8686
* // },
8787
* // ],

0 commit comments

Comments
 (0)