aws-sdk-networkmonitor 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba76cc2e4d71078189adc5974a3ef96e57a5be6b368f0b756e29774cba863d56
-  data.tar.gz: 4198def4e6533c33d0f77231612dc60888881c7fab0fce3208305df0e930a6b5
+  metadata.gz: 91f1f19ffb2f7607fb13fd16c425f03249b7d18903b2030c4f23335230dc4e6f
+  data.tar.gz: 650137e08d4275ab1819435264a72483cf1bba99ab4d000eab879c19c274a133
 SHA512:
-  metadata.gz: 1f6a7183eb6f2d3a8fb3f624cdcbf9e56ec7e6cb80e783afb02277b9d4f0f14bf81b05ead35066768db3c32f716cf148d11702a374f321fad450372eaa20f6b0
-  data.tar.gz: 75ce86b97ad2e37fa2e8bc835da6edb92198e8df0bb5a703511d3aa7336eb4a9ce5ab79b589813c74e3d259ed58507318a6e2f06a8f46d65d3d2774c98051926
+  metadata.gz: 7d6c236fcd7988dcf96dba3a68f8335541c3b2934593c904d79378cdfbc42a215406a13ebd642d2869ec6c046d6be2909477ffbb7b2330b109f0ca319ddf161a
+  data.tar.gz: df913cc8af1f4539db051f637a8c759fcf9e6dda7b328001f2bf95aae213ec5021c0779950d2fefb14497c4b529032d44af113b6d79d2e18bae53759a5ff8120

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.2.0 (2024-04-10)
+------------------
+
+* Feature - Examples were added to CloudWatch Network Monitor commands.
+
 1.1.0 (2024-01-26)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/lib/aws-sdk-networkmonitor/client.rb

@@ -394,16 +394,35 @@ module Aws::NetworkMonitor
     # and your destination IP addresses. Each probe then aggregates and
     # sends metrics to Amazon CloudWatch.
     #
+    # You can also create a monitor with probes using this command. For each
+    # probe, you define the following:
+    #
+    # * `source`—The subnet IDs where the probes will be created.
+    #
+    # * `destination`— The target destination IP address for the probe.
+    #
+    # * `destinationPort`—Required only if the protocol is `TCP`.
+    #
+    # * `protocol`—The communication protocol between the source and
+    #   destination. This will be either `TCP` or `ICMP`.
+    #
+    # * `packetSize`—The size of the packets. This must be a number between
+    #   `56` and `8500`.
+    #
+    # * (Optional) `tags` —Key-value pairs created and assigned to the
+    #   probe.
+    #
     # @option params [required, String] :monitor_name
     #   The name identifying the monitor. It can contain only letters,
-    #   underscores (\_), or dashes (-), and can be up to 255 characters.
+    #   underscores (\_), or dashes (-), and can be up to 200 characters.
     #
     # @option params [Array<Types::CreateMonitorProbeInput>] :probes
     #   Displays a list of all of the probes created for a monitor.
     #
     # @option params [Integer] :aggregation_period
     #   The time, in seconds, that metrics are aggregated and sent to Amazon
-    #   CloudWatch. Valid values are either `30` or `60`.
+    #   CloudWatch. Valid values are either `30` or `60`. `60` is the default
+    #   if no period is chosen.
     #
     # @option params [String] :client_token
     #   Unique, case-sensitive identifier to ensure the idempotency of the
@@ -466,11 +485,12 @@ module Aws::NetworkMonitor
 
     # 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.
+    # for that probe. This action requires the `monitorName` parameter. Run
+    # `ListMonitors` to get a list of monitor names. Note the name of the
+    # `monitorName` you want to create the probe for.
     #
     # @option params [required, String] :monitor_name
-    #   The name of the monitor to associated with the probe. To get a list of
-    #   available monitors, use `ListMonitors`.
+    #   The name of the monitor to associated with the probe.
     #
     # @option params [required, Types::ProbeInput] :probe
     #   Describes the details of an individual probe for a monitor.
@@ -549,9 +569,11 @@ module Aws::NetworkMonitor
 
     # Deletes a specified monitor.
     #
+    # This action requires the `monitorName` parameter. Run `ListMonitors`
+    # to get a list of monitor names.
+    #
     # @option params [required, String] :monitor_name
-    #   The name of the monitor to delete. Use the `ListMonitors` action to
-    #   get a list of your current monitors.
+    #   The name of the monitor to delete.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -570,16 +592,19 @@ module Aws::NetworkMonitor
       req.send_request(options)
     end
 
-    # Deletes the specified monitor. Once a probe is deleted you'll no
-    # longer incur any billing fees for that probe.
+    # Deletes the specified probe. Once a probe is deleted you'll no longer
+    # incur any billing fees for that probe.
+    #
+    # This action requires both the `monitorName` and `probeId` parameters.
+    # Run `ListMonitors` to get a list of monitor names. Run `GetMonitor` to
+    # get a list of probes and probe IDs. You can only delete a single probe
+    # at a time using this action.
     #
     # @option params [required, String] :monitor_name
-    #   The name of the monitor to delete. For a list of the available
-    #   monitors, use the `ListMonitors` action.
+    #   The name of the monitor to delete.
     #
     # @option params [required, String] :probe_id
-    #   The ID of the probe to delete. Run `GetMonitor` to get a lst of all
-    #   probes and probe IDs associated with the monitor.
+    #   The ID of the probe to delete.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -601,6 +626,9 @@ module Aws::NetworkMonitor
 
     # Returns details about a specific monitor.
     #
+    # This action requires the `monitorName` parameter. Run `ListMonitors`
+    # to get a list of monitor names.
+    #
     # @option params [required, String] :monitor_name
     #   The name of the monitor that details are returned for.
     #
@@ -656,8 +684,10 @@ module Aws::NetworkMonitor
       req.send_request(options)
     end
 
-    # Returns the details about a probe. You'll need both the `monitorName`
-    # and `probeId`.
+    # Returns the details about a probe. This action requires both the
+    # `monitorName` and `probeId` parameters. Run `ListMonitors` to get a
+    # list of monitor names. Run `GetMonitor` to get a list of probes and
+    # probe IDs.
     #
     # @option params [required, String] :monitor_name
     #   The name of the monitor associated with the probe. Run `ListMonitors`
@@ -851,11 +881,12 @@ module Aws::NetworkMonitor
     end
 
     # Updates the `aggregationPeriod` for a monitor. Monitors support an
-    # `aggregationPeriod` of either `30` or `60` seconds.
+    # `aggregationPeriod` of either `30` or `60` seconds. This action
+    # requires the `monitorName` and `probeId` parameter. Run `ListMonitors`
+    # to get a list of monitor names.
     #
     # @option params [required, String] :monitor_name
-    #   The name of the monitor to update. Run `ListMonitors` to get a list of
-    #   monitor names.
+    #   The name of the monitor to update.
     #
     # @option params [required, Integer] :aggregation_period
     #   The aggregation time, in seconds, to change to. This must be either
@@ -898,11 +929,29 @@ module Aws::NetworkMonitor
     # and `probeId` parameters. Run `ListMonitors` to get a list of monitor
     # names. Run `GetMonitor` to get a list of probes and probe IDs.
     #
+    # You can update the following para create a monitor with probes using
+    # this command. For each probe, you define the following:
+    #
+    # * `state`—The state of the probe.
+    #
+    # * `destination`— The target destination IP address for the probe.
+    #
+    # * `destinationPort`—Required only if the protocol is `TCP`.
+    #
+    # * `protocol`—The communication protocol between the source and
+    #   destination. This will be either `TCP` or `ICMP`.
+    #
+    # * `packetSize`—The size of the packets. This must be a number between
+    #   `56` and `8500`.
+    #
+    # * (Optional) `tags` —Key-value pairs created and assigned to the
+    #   probe.
+    #
     # @option params [required, String] :monitor_name
     #   The name of the monitor that the probe was updated for.
     #
     # @option params [required, String] :probe_id
-    #   Run `GetMonitor` to get a list of probes and probe IDs.
+    #   The ID of the probe to update.
     #
     # @option params [String] :state
     #   The state of the probe update.
@@ -991,7 +1040,7 @@ module Aws::NetworkMonitor
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-networkmonitor'
-      context[:gem_version] = '1.1.0'
+      context[:gem_version] = '1.2.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-networkmonitor/types.rb

@@ -38,7 +38,7 @@ module Aws::NetworkMonitor
 
     # @!attribute [rw] monitor_name
     #   The name identifying the monitor. It can contain only letters,
-    #   underscores (\_), or dashes (-), and can be up to 255 characters.
+    #   underscores (\_), or dashes (-), and can be up to 200 characters.
     #   @return [String]
     #
     # @!attribute [rw] probes
@@ -47,7 +47,8 @@ module Aws::NetworkMonitor
     #
     # @!attribute [rw] aggregation_period
     #   The time, in seconds, that metrics are aggregated and sent to Amazon
-    #   CloudWatch. Valid values are either `30` or `60`.
+    #   CloudWatch. Valid values are either `30` or `60`. `60` is the
+    #   default if no period is chosen.
     #   @return [Integer]
     #
     # @!attribute [rw] client_token
@@ -115,7 +116,7 @@ module Aws::NetworkMonitor
     #   @return [String]
     #
     # @!attribute [rw] destination
-    #   The destination IP address. This will be either `IPV4` or `IPV6`.
+    #   The destination IP address. This must be either `IPV4` or `IPV6`.
     #   @return [String]
     #
     # @!attribute [rw] destination_port
@@ -126,12 +127,12 @@ module Aws::NetworkMonitor
     #
     # @!attribute [rw] protocol
     #   The protocol used for the network traffic between the `source` and
-    #   `destination`. This will be either `TCP` or `ICMP`.
+    #   `destination`. This must be either `TCP` or `ICMP`.
     #   @return [String]
     #
     # @!attribute [rw] packet_size
     #   The size of the packets sent between the source and destination.
-    #   This will be a number between `56` and `8500`.
+    #   This must be a number between `56` and `8500`.
     #   @return [Integer]
     #
     # @!attribute [rw] probe_tags
@@ -152,8 +153,7 @@ module Aws::NetworkMonitor
     end
 
     # @!attribute [rw] monitor_name
-    #   The name of the monitor to associated with the probe. To get a list
-    #   of available monitors, use `ListMonitors`.
+    #   The name of the monitor to associated with the probe.
     #   @return [String]
     #
     # @!attribute [rw] probe
@@ -197,7 +197,7 @@ module Aws::NetworkMonitor
     #   @return [String]
     #
     # @!attribute [rw] destination
-    #   The destination IP address for the monitor. This will be either an
+    #   The destination IP address for the monitor. This must be either an
     #   IPv4 or IPv6 address.
     #   @return [String]
     #
@@ -209,12 +209,12 @@ module Aws::NetworkMonitor
     #
     # @!attribute [rw] protocol
     #   The protocol used for the network traffic between the `source` and
-    #   `destination`. This will be either `TCP` or `ICMP`.
+    #   `destination`. This must be either `TCP` or `ICMP`.
     #   @return [String]
     #
     # @!attribute [rw] packet_size
     #   The size of the packets sent between the source and destination.
-    #   This will be a number between `56` and `8500`.
+    #   This must be a number between `56` and `8500`.
     #   @return [Integer]
     #
     # @!attribute [rw] address_family
@@ -262,8 +262,7 @@ module Aws::NetworkMonitor
     end
 
     # @!attribute [rw] monitor_name
-    #   The name of the monitor to delete. Use the `ListMonitors` action to
-    #   get a list of your current monitors.
+    #   The name of the monitor to delete.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/DeleteMonitorInput AWS API Documentation
@@ -279,13 +278,11 @@ module Aws::NetworkMonitor
     class DeleteMonitorOutput < Aws::EmptyStructure; end
 
     # @!attribute [rw] monitor_name
-    #   The name of the monitor to delete. For a list of the available
-    #   monitors, use the `ListMonitors` action.
+    #   The name of the monitor to delete.
     #   @return [String]
     #
     # @!attribute [rw] probe_id
-    #   The ID of the probe to delete. Run `GetMonitor` to get a lst of all
-    #   probes and probe IDs associated with the monitor.
+    #   The ID of the probe to delete.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/networkmonitor-2023-08-01/DeleteProbeInput AWS API Documentation
@@ -318,12 +315,11 @@ module Aws::NetworkMonitor
     #   @return [String]
     #
     # @!attribute [rw] monitor_name
-    #   The name of the monitor. To get a list of the current monitors and
-    #   their names, use the `ListMonitors` action.
+    #   The name of the monitor.
     #   @return [String]
     #
     # @!attribute [rw] state
-    #   Returns a list of the state of each monitor.
+    #   Lists the status of the `state` of each monitor.
     #   @return [String]
     #
     # @!attribute [rw] aggregation_period
@@ -393,7 +389,7 @@ module Aws::NetworkMonitor
     #   @return [String]
     #
     # @!attribute [rw] destination
-    #   The destination IP address for the monitor. This will be either an
+    #   The destination IP address for the monitor. This must be either an
     #   IPv4 or IPv6 address.
     #   @return [String]
     #
@@ -405,12 +401,12 @@ module Aws::NetworkMonitor
     #
     # @!attribute [rw] protocol
     #   The protocol used for the network traffic between the `source` and
-    #   `destination`. This will be either `TCP` or `ICMP`.
+    #   `destination`. This must be either `TCP` or `ICMP`.
     #   @return [String]
     #
     # @!attribute [rw] packet_size
     #   The size of the packets sent between the source and destination.
-    #   This will be a number between `56` and `8500`.
+    #   This must be a number between `56` and `8500`.
     #   @return [Integer]
     #
     # @!attribute [rw] address_family
@@ -574,7 +570,7 @@ module Aws::NetworkMonitor
       include Aws::Structure
     end
 
-    # Describes information about a monitor probe.
+    # Describes information about a network monitor probe.
     #
     # @!attribute [rw] probe_id
     #   The ID of the probe.
@@ -659,7 +655,7 @@ module Aws::NetworkMonitor
     #   @return [String]
     #
     # @!attribute [rw] destination
-    #   The destination IP address. This will be either `IPV4` or `IPV6`.
+    #   The destination IP address. This must be either `IPV4` or `IPV6`.
     #   @return [String]
     #
     # @!attribute [rw] destination_port
@@ -670,12 +666,12 @@ module Aws::NetworkMonitor
     #
     # @!attribute [rw] protocol
     #   The protocol used for the network traffic between the `source` and
-    #   `destination`. This will be either `TCP` or `ICMP`.
+    #   `destination`. This must be either `TCP` or `ICMP`.
     #   @return [String]
     #
     # @!attribute [rw] packet_size
     #   The size of the packets sent between the source and destination.
-    #   This will be a number between `56` and `8500`.
+    #   This must be a number between `56` and `8500`.
     #   @return [Integer]
     #
     # @!attribute [rw] tags
@@ -777,8 +773,7 @@ module Aws::NetworkMonitor
     class UntagResourceOutput < Aws::EmptyStructure; end
 
     # @!attribute [rw] monitor_name
-    #   The name of the monitor to update. Run `ListMonitors` to get a list
-    #   of monitor names.
+    #   The name of the monitor to update.
     #   @return [String]
     #
     # @!attribute [rw] aggregation_period
@@ -832,7 +827,7 @@ module Aws::NetworkMonitor
     #   @return [String]
     #
     # @!attribute [rw] probe_id
-    #   Run `GetMonitor` to get a list of probes and probe IDs.
+    #   The ID of the probe to update.
     #   @return [String]
     #
     # @!attribute [rw] state
@@ -892,7 +887,7 @@ module Aws::NetworkMonitor
     #   @return [String]
     #
     # @!attribute [rw] destination_port
-    #   The updated destination port. This will be a number between `1` and
+    #   The updated destination port. This must be a number between `1` and
     #   `65536`.
     #   @return [Integer]
     #
@@ -905,7 +900,7 @@ module Aws::NetworkMonitor
     #   @return [Integer]
     #
     # @!attribute [rw] address_family
-    #   The updated IP address family. This will be either `IPV4` or `IPV6`.
+    #   The updated IP address family. This must be either `IPV4` or `IPV6`.
     #   @return [String]
     #
     # @!attribute [rw] vpc_id

data/lib/aws-sdk-networkmonitor.rb

@@ -53,6 +53,6 @@ require_relative 'aws-sdk-networkmonitor/customizations'
 # @!group service
 module Aws::NetworkMonitor
 
-  GEM_VERSION = '1.1.0'
+  GEM_VERSION = '1.2.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-networkmonitor
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-26 00:00:00.000000000 Z
+date: 2024-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core