Skip to content

Commit febd9b9

Browse files
author
AWS
committed
Amazon CloudWatch Network Monitor Update: Examples were added to CloudWatch Network Monitor commands.
1 parent d754d06 commit febd9b9

File tree

2 files changed

+26
-20
lines changed

2 files changed

+26
-20
lines changed

‎.changes/next-release/feature-AmazonCloudWatchNetworkMonitor-4f4411d.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon CloudWatch Network Monitor",
4+
"contributor": "",
5+
"description": "Examples were added to CloudWatch Network Monitor commands."
6+
}

‎services/networkmonitor/src/main/resources/codegen-resources/service-2.json

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
{"shape":"ConflictException"},
3030
{"shape":"ServiceQuotaExceededException"}
3131
],
32-
"documentation":"<p>Creates a monitor between a source subnet and destination IP address. Within a monitor you'll create one or more probes that monitor network traffic between your source Amazon Web Services VPC subnets and your destination IP addresses. Each probe then aggregates and sends metrics to Amazon CloudWatch.</p>",
32+
"documentation":"<p>Creates a monitor between a source subnet and destination IP address. Within a monitor you'll create one or more probes that monitor network traffic between your source Amazon Web Services VPC subnets and your destination IP addresses. Each probe then aggregates and sends metrics to Amazon CloudWatch.</p> <p>You can also create a monitor with probes using this command. For each probe, you define the following:</p> <ul> <li> <p> <code>source</code>—The subnet IDs where the probes will be created.</p> </li> <li> <p> <code>destination</code>— The target destination IP address for the probe.</p> </li> <li> <p> <code>destinationPort</code>—Required only if the protocol is <code>TCP</code>.</p> </li> <li> <p> <code>protocol</code>—The communication protocol between the source and destination. This will be either <code>TCP</code> or <code>ICMP</code>.</p> </li> <li> <p> <code>packetSize</code>—The size of the packets. This must be a number between <code>56</code> and <code>8500</code>.</p> </li> <li> <p>(Optional) <code>tags</code> —Key-value pairs created and assigned to the probe.</p> </li> </ul>",
3333
"idempotent":true
3434
},
3535
"CreateProbe":{
@@ -49,7 +49,7 @@
4949
{"shape":"InternalServerException"},
5050
{"shape":"ServiceQuotaExceededException"}
5151
],
52-
"documentation":"<p>Create a probe within a monitor. Once you create a probe, and it begins monitoring your network traffic, you'll incur billing charges for that probe. </p>",
52+
"documentation":"<p>Create a probe within a monitor. Once you create a probe, and it begins monitoring your network traffic, you'll incur billing charges for that probe. This action requires the <code>monitorName</code> parameter. Run <code>ListMonitors</code> to get a list of monitor names. Note the name of the <code>monitorName</code> you want to create the probe for.</p>",
5353
"idempotent":true
5454
},
5555
"DeleteMonitor":{
@@ -68,7 +68,7 @@
6868
{"shape":"ValidationException"},
6969
{"shape":"InternalServerException"}
7070
],
71-
"documentation":"<p>Deletes a specified monitor.</p>",
71+
"documentation":"<p>Deletes a specified monitor.</p> <p>This action requires the <code>monitorName</code> parameter. Run <code>ListMonitors</code> to get a list of monitor names. </p>",
7272
"idempotent":true
7373
},
7474
"DeleteProbe":{
@@ -88,7 +88,7 @@
8888
{"shape":"InternalServerException"},
8989
{"shape":"ServiceQuotaExceededException"}
9090
],
91-
"documentation":"<p>Deletes the specified monitor. Once a probe is deleted you'll no longer incur any billing fees for that probe.</p>",
91+
"documentation":"<p>Deletes the specified probe. Once a probe is deleted you'll no longer incur any billing fees for that probe.</p> <p>This action requires both the <code>monitorName</code> and <code>probeId</code> parameters. Run <code>ListMonitors</code> to get a list of monitor names. Run <code>GetMonitor</code> to get a list of probes and probe IDs. You can only delete a single probe at a time using this action. </p>",
9292
"idempotent":true
9393
},
9494
"GetMonitor":{
@@ -107,7 +107,7 @@
107107
{"shape":"ValidationException"},
108108
{"shape":"InternalServerException"}
109109
],
110-
"documentation":"<p>Returns details about a specific monitor.</p>"
110+
"documentation":"<p>Returns details about a specific monitor. </p> <p>This action requires the <code>monitorName</code> parameter. Run <code>ListMonitors</code> to get a list of monitor names. </p>"
111111
},
112112
"GetProbe":{
113113
"name":"GetProbe",
@@ -125,7 +125,7 @@
125125
{"shape":"ValidationException"},
126126
{"shape":"InternalServerException"}
127127
],
128-
"documentation":"<p>Returns the details about a probe. You'll need both the <code>monitorName</code> and <code>probeId</code>. </p>"
128+
"documentation":"<p>Returns the details about a probe. This action requires both the <code>monitorName</code> and <code>probeId</code> parameters. Run <code>ListMonitors</code> to get a list of monitor names. Run <code>GetMonitor</code> to get a list of probes and probe IDs. </p>"
129129
},
130130
"ListMonitors":{
131131
"name":"ListMonitors",
@@ -220,7 +220,7 @@
220220
{"shape":"InternalServerException"},
221221
{"shape":"ServiceQuotaExceededException"}
222222
],
223-
"documentation":"<p>Updates the <code>aggregationPeriod</code> for a monitor. Monitors support an <code>aggregationPeriod</code> of either <code>30</code> or <code>60</code> seconds.</p>",
223+
"documentation":"<p>Updates the <code>aggregationPeriod</code> for a monitor. Monitors support an <code>aggregationPeriod</code> of either <code>30</code> or <code>60</code> seconds. This action requires the <code>monitorName</code> and <code>probeId</code> parameter. Run <code>ListMonitors</code> to get a list of monitor names. </p>",
224224
"idempotent":true
225225
},
226226
"UpdateProbe":{
@@ -240,7 +240,7 @@
240240
{"shape":"InternalServerException"},
241241
{"shape":"ServiceQuotaExceededException"}
242242
],
243-
"documentation":"<p>Updates a monitor probe. This action requires both the <code>monitorName</code> and <code>probeId</code> parameters. Run <code>ListMonitors</code> to get a list of monitor names. Run <code>GetMonitor</code> to get a list of probes and probe IDs. </p>",
243+
"documentation":"<p>Updates a monitor probe. This action requires both the <code>monitorName</code> and <code>probeId</code> parameters. Run <code>ListMonitors</code> to get a list of monitor names. Run <code>GetMonitor</code> to get a list of probes and probe IDs. </p> <p>You can update the following para create a monitor with probes using this command. For each probe, you define the following:</p> <ul> <li> <p> <code>state</code>—The state of the probe.</p> </li> <li> <p> <code>destination</code>— The target destination IP address for the probe.</p> </li> <li> <p> <code>destinationPort</code>—Required only if the protocol is <code>TCP</code>.</p> </li> <li> <p> <code>protocol</code>—The communication protocol between the source and destination. This will be either <code>TCP</code> or <code>ICMP</code>.</p> </li> <li> <p> <code>packetSize</code>—The size of the packets. This must be a number between <code>56</code> and <code>8500</code>.</p> </li> <li> <p>(Optional) <code>tags</code> —Key-value pairs created and assigned to the probe.</p> </li> </ul>",
244244
"idempotent":true
245245
}
246246
},
@@ -301,7 +301,7 @@
301301
},
302302
"aggregationPeriod":{
303303
"shape":"AggregationPeriod",
304-
"documentation":"<p>The time, in seconds, that metrics are aggregated and sent to Amazon CloudWatch. Valid values are either <code>30</code> or <code>60</code>. </p>"
304+
"documentation":"<p>The time, in seconds, that metrics are aggregated and sent to Amazon CloudWatch. Valid values are either <code>30</code> or <code>60</code>. <code>60</code> is the default if no period is chosen.</p>"
305305
},
306306
"clientToken":{
307307
"shape":"String",
@@ -336,7 +336,7 @@
336336
},
337337
"aggregationPeriod":{
338338
"shape":"AggregationPeriod",
339-
"documentation":"<p>The number of seconds that metrics are aggregated by and sent to Amazon CloudWatch. This must be either <code>30</code> or <code>60</code>. </p>"
339+
"documentation":"<p>The number of seconds that metrics are aggregated by and sent to Amazon CloudWatch. This will be either <code>30</code> or <code>60</code>. </p>"
340340
},
341341
"tags":{
342342
"shape":"TagMap",
@@ -392,7 +392,7 @@
392392
"members":{
393393
"monitorName":{
394394
"shape":"ResourceName",
395-
"documentation":"<p>The name of the monitor to associated with the probe. To get a list of available monitors, use <code>ListMonitors</code>.</p>",
395+
"documentation":"<p>The name of the monitor to associated with the probe. </p>",
396396
"location":"uri",
397397
"locationName":"monitorName"
398398
},
@@ -479,7 +479,7 @@
479479
"members":{
480480
"monitorName":{
481481
"shape":"ResourceName",
482-
"documentation":"<p>The name of the monitor to delete. Use the <code>ListMonitors</code> action to get a list of your current monitors. </p>",
482+
"documentation":"<p>The name of the monitor to delete. </p>",
483483
"location":"uri",
484484
"locationName":"monitorName"
485485
}
@@ -499,13 +499,13 @@
499499
"members":{
500500
"monitorName":{
501501
"shape":"ResourceName",
502-
"documentation":"<p>The name of the monitor to delete. For a list of the available monitors, use the <code>ListMonitors</code> action.</p>",
502+
"documentation":"<p>The name of the monitor to delete. </p>",
503503
"location":"uri",
504504
"locationName":"monitorName"
505505
},
506506
"probeId":{
507507
"shape":"ProbeId",
508-
"documentation":"<p>The ID of the probe to delete. Run <code>GetMonitor</code> to get a lst of all probes and probe IDs associated with the monitor.</p>",
508+
"documentation":"<p>The ID of the probe to delete. </p>",
509509
"location":"uri",
510510
"locationName":"probeId"
511511
}
@@ -550,11 +550,11 @@
550550
},
551551
"monitorName":{
552552
"shape":"ResourceName",
553-
"documentation":"<p>The name of the monitor. To get a list of the current monitors and their names, use the <code>ListMonitors</code> action.</p>"
553+
"documentation":"<p>The name of the monitor. </p>"
554554
},
555555
"state":{
556556
"shape":"MonitorState",
557-
"documentation":"<p>Returns a list of the state of each monitor. </p>"
557+
"documentation":"<p>Lists the status of the <code>state</code> of each monitor. </p>"
558558
},
559559
"aggregationPeriod":{
560560
"shape":"AggregationPeriod",
@@ -866,7 +866,7 @@
866866
"documentation":"<p>The list of key-value pairs created and assigned to the probe.</p>"
867867
}
868868
},
869-
"documentation":"<p>Describes information about a monitor probe.</p>"
869+
"documentation":"<p>Describes information about a network monitor probe.</p>"
870870
},
871871
"ProbeId":{
872872
"type":"string",
@@ -1055,7 +1055,7 @@
10551055
"members":{
10561056
"monitorName":{
10571057
"shape":"ResourceName",
1058-
"documentation":"<p>The name of the monitor to update. Run <code>ListMonitors</code> to get a list of monitor names.</p>",
1058+
"documentation":"<p>The name of the monitor to update. </p>",
10591059
"location":"uri",
10601060
"locationName":"monitorName"
10611061
},
@@ -1110,7 +1110,7 @@
11101110
},
11111111
"probeId":{
11121112
"shape":"ProbeId",
1113-
"documentation":"<p>Run <code>GetMonitor</code> to get a list of probes and probe IDs.</p>",
1113+
"documentation":"<p>The ID of the probe to update.</p>",
11141114
"location":"uri",
11151115
"locationName":"probeId"
11161116
},
@@ -1215,5 +1215,5 @@
12151215
"pattern":"vpc-[a-zA-Z0-9]{8,32}"
12161216
}
12171217
},
1218-
"documentation":"<p>Amazon CloudWatch Network Monitor is an Amazon Web Services active network monitoring service that identifies if a network issues exists within the Amazon Web Services network or your own company network. Within Network Monitor you'll choose the source VPCs and subnets from the Amazon Web Services network in which you operate and then you'll choose the destination IP addresses from your on-premises network. From these sources and destinations, Network Monitor creates a monitor containing all the possible source and destination combinations, each of which is called a probe, within a single monitor. These probes then monitor network traffic to help you identify where network issues might be affecting your traffic.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/what-is-network-monitor.html\">Using Amazon CloudWatch Network Monitor</a> in the <i>Amazon CloudWatch User Guide</i>.</p>"
1218+
"documentation":"<p>Amazon CloudWatch Network Monitor is an Amazon Web Services active network monitoring service that identifies if a network issues exists within the Amazon Web Services network or your own company network. Within Network Monitor you'll choose the source VPCs and subnets from the Amazon Web Services network in which you operate and then you'll choose the destination IP addresses from your on-premises network. From these sources and destinations, Network Monitor creates a monitor containing all the possible source and destination combinations, each of which is called a probe, within a single monitor. These probes then monitor network traffic to help you identify where network issues might be affecting your traffic.</p> <p>Before you begin, ensure the Amazon Web Services CLI is configured in the Amazon Web Services Account where you will create the Network Monitor resource. Network Monitor doesn’t support creation on cross-account resources, but you can create a Network Monitor in any subnet belonging to a VPC owned by your Account.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/what-is-network-monitor.html\">Using Amazon CloudWatch Network Monitor</a> in the <i>Amazon CloudWatch User Guide</i>.</p>"
12191219
}

0 commit comments

Comments
 (0)