docs(client-networkmonitor): Examples were added to CloudWatch Network Monitor commands.

awstools · awstools · commit bbd68ba4b484 · 2024-04-10T18:14:59.000Z
diff --git a/clients/client-networkmonitor/README.md b/clients/client-networkmonitor/README.md
@@ -14,6 +14,9 @@ the destination IP addresses from your on-premises network. From these sources a
 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>
 
 ## Installing
diff --git a/clients/client-networkmonitor/src/NetworkMonitor.ts b/clients/client-networkmonitor/src/NetworkMonitor.ts
@@ -205,6 +205,9 @@ export interface NetworkMonitor {
  *             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>
  * @public
  */
diff --git a/clients/client-networkmonitor/src/NetworkMonitorClient.ts b/clients/client-networkmonitor/src/NetworkMonitorClient.ts
@@ -293,6 +293,9 @@ export interface NetworkMonitorClientResolvedConfig extends NetworkMonitorClient
  *             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>
  * @public
  */
diff --git a/clients/client-networkmonitor/src/commands/CreateMonitorCommand.ts b/clients/client-networkmonitor/src/commands/CreateMonitorCommand.ts
@@ -28,6 +28,38 @@ export interface CreateMonitorCommandOutput extends CreateMonitorOutput, __Metad
 
 /**
  * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-networkmonitor/src/commands/CreateProbeCommand.ts b/clients/client-networkmonitor/src/commands/CreateProbeCommand.ts
@@ -27,7 +27,11 @@ export interface CreateProbeCommandInput extends CreateProbeInput {}
 export interface CreateProbeCommandOutput extends CreateProbeOutput, __MetadataBearer {}
 
 /**
- * <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>
+ * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-networkmonitor/src/commands/DeleteMonitorCommand.ts b/clients/client-networkmonitor/src/commands/DeleteMonitorCommand.ts
@@ -28,6 +28,8 @@ export interface DeleteMonitorCommandOutput extends DeleteMonitorOutput, __Metad
 
 /**
  * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-networkmonitor/src/commands/DeleteProbeCommand.ts b/clients/client-networkmonitor/src/commands/DeleteProbeCommand.ts
@@ -27,7 +27,12 @@ export interface DeleteProbeCommandInput extends DeleteProbeInput {}
 export interface DeleteProbeCommandOutput extends DeleteProbeOutput, __MetadataBearer {}
 
 /**
- * <p>Deletes the specified monitor. Once a probe is deleted you'll no longer incur any billing fees for that probe.</p>
+ * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-networkmonitor/src/commands/GetMonitorCommand.ts b/clients/client-networkmonitor/src/commands/GetMonitorCommand.ts
@@ -27,7 +27,9 @@ export interface GetMonitorCommandInput extends GetMonitorInput {}
 export interface GetMonitorCommandOutput extends GetMonitorOutput, __MetadataBearer {}
 
 /**
- * <p>Returns details about a specific monitor.</p>
+ * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-networkmonitor/src/commands/GetProbeCommand.ts b/clients/client-networkmonitor/src/commands/GetProbeCommand.ts
@@ -27,7 +27,10 @@ export interface GetProbeCommandInput extends GetProbeInput {}
 export interface GetProbeCommandOutput extends GetProbeOutput, __MetadataBearer {}
 
 /**
- * <p>Returns the details about a probe. You'll need both the <code>monitorName</code> and <code>probeId</code>. </p>
+ * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-networkmonitor/src/commands/UpdateMonitorCommand.ts b/clients/client-networkmonitor/src/commands/UpdateMonitorCommand.ts
@@ -27,7 +27,10 @@ export interface UpdateMonitorCommandInput extends UpdateMonitorInput {}
 export interface UpdateMonitorCommandOutput extends UpdateMonitorOutput, __MetadataBearer {}
 
 /**
- * <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>
+ * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-networkmonitor/src/commands/UpdateProbeCommand.ts b/clients/client-networkmonitor/src/commands/UpdateProbeCommand.ts
@@ -28,6 +28,38 @@ export interface UpdateProbeCommandOutput extends UpdateProbeOutput, __MetadataB
 
 /**
  * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-networkmonitor/src/index.ts b/clients/client-networkmonitor/src/index.ts
@@ -9,6 +9,9 @@
  *             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>
  *
  * @packageDocumentation
diff --git a/clients/client-networkmonitor/src/models/models_0.ts b/clients/client-networkmonitor/src/models/models_0.ts
@@ -130,7 +130,9 @@ export interface CreateMonitorInput {
   probes?: CreateMonitorProbeInput[];
 
   /**
-   * <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>
+   * <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>
    * @public
    */
   aggregationPeriod?: number;
@@ -188,7 +190,8 @@ export interface CreateMonitorOutput {
   state: MonitorState | undefined;
 
   /**
-   * <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>
+   * <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>
    * @public
    */
   aggregationPeriod?: number;
@@ -331,7 +334,7 @@ export interface ProbeInput {
  */
 export interface CreateProbeInput {
   /**
-   * <p>The name of the monitor to associated with the probe. To get a list of available monitors, use <code>ListMonitors</code>.</p>
+   * <p>The name of the monitor to associated with the probe. </p>
    * @public
    */
   monitorName: string | undefined;
@@ -481,7 +484,7 @@ export class ResourceNotFoundException extends __BaseException {
  */
 export interface DeleteMonitorInput {
   /**
-   * <p>The name of the monitor to delete. Use the <code>ListMonitors</code> action to get a list of your current monitors. </p>
+   * <p>The name of the monitor to delete.  </p>
    * @public
    */
   monitorName: string | undefined;
@@ -497,13 +500,13 @@ export interface DeleteMonitorOutput {}
  */
 export interface DeleteProbeInput {
   /**
-   * <p>The name of the monitor to delete. For a list of the available monitors, use the <code>ListMonitors</code> action.</p>
+   * <p>The name of the monitor to delete. </p>
    * @public
    */
   monitorName: string | undefined;
 
   /**
-   * <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>
+   * <p>The ID of the probe to delete. </p>
    * @public
    */
   probeId: string | undefined;
@@ -526,7 +529,7 @@ export interface GetMonitorInput {
 }
 
 /**
- * <p>Describes information about a monitor probe.</p>
+ * <p>Describes information about a network monitor probe.</p>
  * @public
  */
 export interface Probe {
@@ -620,13 +623,13 @@ export interface GetMonitorOutput {
   monitorArn: string | undefined;
 
   /**
-   * <p>The name of the monitor. To get a list of the current monitors and their names, use the <code>ListMonitors</code> action.</p>
+   * <p>The name of the monitor. </p>
    * @public
    */
   monitorName: string | undefined;
 
   /**
-   * <p>Returns a list of the state of each monitor. </p>
+   * <p>Lists the status of the <code>state</code> of each monitor. </p>
    * @public
    */
   state: MonitorState | undefined;
@@ -868,7 +871,7 @@ export interface ListTagsForResourceOutput {
  */
 export interface UpdateMonitorInput {
   /**
-   * <p>The name of the monitor to update. Run <code>ListMonitors</code> to get a list of monitor names.</p>
+   * <p>The name of the monitor to update. </p>
    * @public
    */
   monitorName: string | undefined;
@@ -926,7 +929,7 @@ export interface UpdateProbeInput {
   monitorName: string | undefined;
 
   /**
-   * <p>Run <code>GetMonitor</code> to get a list of probes and probe IDs.</p>
+   * <p>The ID of the probe to update.</p>
    * @public
    */
   probeId: string | undefined;
diff --git a/codegen/sdk-codegen/aws-models/networkmonitor.json b/codegen/sdk-codegen/aws-models/networkmonitor.json
