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.
For more information, see Using Amazon CloudWatch Network Monitor in the Amazon CloudWatch User Guide.
", "operations": { "CreateMonitor": "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.
", "CreateProbe": "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.
", "DeleteMonitor": "Deletes a specified monitor.
", "DeleteProbe": "Deletes the specified monitor. Once a probe is deleted you'll no longer incur any billing fees for that probe.
", "GetMonitor": "Returns details about a specific monitor.
", "GetProbe": "Returns the details about a probe. You'll need both the monitorName and probeId.
Returns a list of all of your monitors.
", "ListTagsForResource": "Lists the tags assigned to this resource.
", "TagResource": "Adds key-value pairs to a monitor or probe.
", "UntagResource": "Removes a key-value pair from a monitor or probe.
", "UpdateMonitor": "Updates the aggregationPeriod for a monitor. Monitors support an aggregationPeriod of either 30 or 60 seconds.
Updates a monitor 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 do not have sufficient access to perform this action.
", "refs": { } }, "AddressFamily": { "base": null, "refs": { "CreateProbeOutput$addressFamily": "Indicates whether the IP address is IPV4 or IPV6.
Indicates whether the IP address is IPV4 or IPV6.
The IPv4 or IPv6 address for the probe.
", "UpdateProbeOutput$addressFamily": "The updated IP address family. This will be either IPV4 or IPV6.
The time, in seconds, that metrics are aggregated and sent to Amazon CloudWatch. Valid values are either 30 or 60.
The number of seconds that metrics are aggregated by and sent to Amazon CloudWatch. This will be either 30 or 60.
The aggregation period for the specified monitor.
", "MonitorSummary$aggregationPeriod": "The time, in seconds, that metrics are collected and sent to Amazon CloudWatch. Valid values are either 30 or 60.
The aggregation time, in seconds, to change to. This must be either 30 or 60.
The changed aggregation period.
" } }, "Arn": { "base": null, "refs": { "CreateMonitorProbeInput$sourceArn": "The ARN of the subnet.
", "CreateProbeOutput$probeArn": "The ARN of the probe.
", "CreateProbeOutput$sourceArn": "The ARN of the probe.
", "GetProbeOutput$probeArn": "The ARN of the probe.
", "GetProbeOutput$sourceArn": "The ARN of the probe.
", "ListTagsForResourceInput$resourceArn": "The
", "Probe$probeArn": "The ARN of the probe.
", "Probe$sourceArn": "The ARN of the probe source subnet.
", "ProbeInput$sourceArn": "The ARN of the subnet.
", "TagResourceInput$resourceArn": "The ARN of the monitor or probe to tag.
", "UntagResourceInput$resourceArn": "The ARN of the monitor or probe that the tag should be removed from.
", "UpdateProbeOutput$probeArn": "The updated ARN of the probe.
", "UpdateProbeOutput$sourceArn": "The updated ARN of the source subnet.
" } }, "ConflictException": { "base": "This operation attempted to create a resource that already exists.
", "refs": { } }, "CreateMonitorInput": { "base": null, "refs": { } }, "CreateMonitorOutput": { "base": null, "refs": { } }, "CreateMonitorProbeInput": { "base": "Creates a monitor probe.
", "refs": { "CreateMonitorProbeInputList$member": null } }, "CreateMonitorProbeInputList": { "base": null, "refs": { "CreateMonitorInput$probes": "Displays a list of all of the probes created for a monitor.
" } }, "CreateProbeInput": { "base": null, "refs": { } }, "CreateProbeOutput": { "base": null, "refs": { } }, "DeleteMonitorInput": { "base": null, "refs": { } }, "DeleteMonitorOutput": { "base": null, "refs": { } }, "DeleteProbeInput": { "base": null, "refs": { } }, "DeleteProbeOutput": { "base": null, "refs": { } }, "Destination": { "base": null, "refs": { "CreateMonitorProbeInput$destination": "The destination IP address. This will be either IPV4 or IPV6.
The destination IP address for the monitor. This will be either an IPv4 or IPv6 address.
", "GetProbeOutput$destination": "The destination IP address for the monitor. This will be either an IPv4 or IPv6 address.
", "Probe$destination": "The destination for the probe. This should be either an IPV4 or IPV6.
The destination IP address. This will be either IPV4 or IPV6.
The updated IP address for the probe destination. This must be either an IPv4 or IPv6 address.
", "UpdateProbeOutput$destination": "The updated destination IP address for the probe.
" } }, "GetMonitorInput": { "base": null, "refs": { } }, "GetMonitorOutput": { "base": null, "refs": { } }, "GetProbeInput": { "base": null, "refs": { } }, "GetProbeOutput": { "base": null, "refs": { } }, "InternalServerException": { "base": "The request processing has failed because of an unknown error, exception or failure.
", "refs": { } }, "Iso8601Timestamp": { "base": null, "refs": { "CreateProbeOutput$createdAt": "The time and date that the probe was created.
", "CreateProbeOutput$modifiedAt": "The time and date when the probe was last modified.
", "GetMonitorOutput$createdAt": "The time and date when the monitor was created.
", "GetMonitorOutput$modifiedAt": "The time and date when the monitor was last modified.
", "GetProbeOutput$createdAt": "The time and date that the probe was created.
", "GetProbeOutput$modifiedAt": "The time and date that the probe was last modified.
", "Probe$createdAt": "The time and date the probe was created.
", "Probe$modifiedAt": "The time and date that the probe was last modified.
", "UpdateProbeOutput$createdAt": "The time and date that the probe was created.
", "UpdateProbeOutput$modifiedAt": "The time and date that the probe was last updated.
" } }, "ListMonitorsInput": { "base": null, "refs": { } }, "ListMonitorsOutput": { "base": null, "refs": { } }, "ListTagsForResourceInput": { "base": null, "refs": { } }, "ListTagsForResourceOutput": { "base": null, "refs": { } }, "MaxResults": { "base": null, "refs": { "ListMonitorsInput$maxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If MaxResults is given a value larger than 100, only 100 results are returned.
The ARN of the monitor.
", "GetMonitorOutput$monitorArn": "The ARN of the selected monitor.
", "MonitorSummary$monitorArn": "The ARN of the monitor.
", "UpdateMonitorOutput$monitorArn": "The ARN of the monitor that was updated.
" } }, "MonitorList": { "base": null, "refs": { "ListMonitorsOutput$monitors": "Lists individual details about each of your monitors.
" } }, "MonitorState": { "base": null, "refs": { "CreateMonitorOutput$state": "The state of the monitor.
", "GetMonitorOutput$state": "Returns a list of the state of each monitor.
", "MonitorSummary$state": "The state of the monitor.
", "UpdateMonitorOutput$state": "The state of the updated monitor.
" } }, "MonitorSummary": { "base": "Displays summary information about a monitor.
", "refs": { "MonitorList$member": null } }, "PacketSize": { "base": null, "refs": { "CreateMonitorProbeInput$packetSize": "The size of the packets sent between the source and destination. This will be a number between 56 and 8500.
The size of the packets sent between the source and destination. This will be a number between 56 and 8500.
The size of the packets sent between the source and destination. This will be a number between 56 and 8500.
The size of the packets traveling between the source and destination. This must be a number between 56 and
The size of the packets sent between the source and destination. This will be a number between 56 and 8500.
he updated packets size for network traffic between the source and destination. This must be a number between 56 and 8500.
The updated packet size for the probe.
" } }, "PaginationToken": { "base": null, "refs": { "ListMonitorsInput$nextToken": "The token for the next page of results.
" } }, "Port": { "base": null, "refs": { "CreateMonitorProbeInput$destinationPort": "The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
The destination port for the probe. This is required only if the protocol is TCP and must be a number between 1 and 65536.
The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
The updated port for the probe destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
The updated destination port. This will be a number between 1 and 65536.
Describes information about a monitor probe.
", "refs": { "ProbeList$member": null } }, "ProbeId": { "base": null, "refs": { "CreateProbeOutput$probeId": "The ID of the probe for which details are returned.
", "DeleteProbeInput$probeId": "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 get information about. Run GetMonitor action to get a list of probes and probe IDs for the monitor.
The ID of the probe for which details are returned.
", "Probe$probeId": "The ID of the probe.
", "UpdateProbeInput$probeId": "Run GetMonitor to get a list of probes and probe IDs.
The updated ID of the probe.
" } }, "ProbeInput": { "base": "Defines a probe when creating a probe or monitor.
", "refs": { "CreateProbeInput$probe": "Describes the details of an individual probe for a monitor.
" } }, "ProbeList": { "base": null, "refs": { "GetMonitorOutput$probes": "The details about each probe associated with that monitor.
" } }, "ProbeState": { "base": null, "refs": { "CreateProbeOutput$state": "The state of the probe.
", "GetProbeOutput$state": "The state of the probe.
", "Probe$state": "The state of the probe.
", "UpdateProbeInput$state": "The state of the probe update.
", "UpdateProbeOutput$state": "The state of the updated probe.
" } }, "Protocol": { "base": null, "refs": { "CreateMonitorProbeInput$protocol": "The protocol used for the network traffic between the source and destination. This will be either TCP or ICMP.
The protocol used for the network traffic between the source and destination. This will be either TCP or ICMP.
The protocol used for the network traffic between the source and destination. This will be either TCP or ICMP.
The network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.
The protocol used for the network traffic between the source and destination. This will be either TCP or ICMP.
The updated network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.
The updated protocol for the probe.
" } }, "ResourceName": { "base": null, "refs": { "CreateMonitorInput$monitorName": "The name identifying the monitor. It can contain only letters, underscores (_), or dashes (-), and can be up to 255 characters.
", "CreateMonitorOutput$monitorName": "The name of the monitor.
", "CreateProbeInput$monitorName": "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 delete. Use the ListMonitors action to get a list of your current monitors.
The name of the monitor to delete. For a list of the available monitors, use the ListMonitors action.
The name of the monitor that details are returned for.
", "GetMonitorOutput$monitorName": "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 associated with the probe. Run ListMonitors to get a list of monitor names.
The name of the monitor.
", "UpdateMonitorInput$monitorName": "The name of the monitor to update. Run ListMonitors to get a list of monitor names.
The name of the monitor that was updated.
", "UpdateProbeInput$monitorName": "The name of the monitor that the probe was updated for.
" } }, "ResourceNotFoundException": { "base": "The specified resource does not exist.
", "refs": { } }, "ServiceQuotaExceededException": { "base": "This request exceeds a service quota.
", "refs": { } }, "String": { "base": null, "refs": { "AccessDeniedException$message": null, "ConflictException$message": null, "CreateMonitorInput$clientToken": "Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
", "CreateProbeInput$clientToken": "Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
", "InternalServerException$message": null, "ListMonitorsInput$state": "The list of all monitors and their states.
", "ListMonitorsOutput$nextToken": "The token for the next page of results.
", "ResourceNotFoundException$message": null, "ServiceQuotaExceededException$message": null, "ThrottlingException$message": null, "ValidationException$message": null } }, "TagKey": { "base": null, "refs": { "TagKeyList$member": null, "TagMap$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceInput$tagKeys": "The key-value pa
" } }, "TagMap": { "base": null, "refs": { "CreateMonitorInput$tags": "The list of key-value pairs created and assigned to the monitor.
", "CreateMonitorOutput$tags": "The list of key-value pairs assigned to the monitor.
", "CreateMonitorProbeInput$probeTags": "The list of key-value pairs created and assigned to the monitor.
", "CreateProbeInput$tags": "The list of key-value pairs created and assigned to the probe.
", "CreateProbeOutput$tags": "The list of key-value pairs assigned to the probe.
", "GetMonitorOutput$tags": "The list of key-value pairs assigned to the monitor.
", "GetProbeOutput$tags": "The list of key-value pairs assigned to the probe.
", "ListTagsForResourceOutput$tags": "Lists the tags assigned to the resource.
", "MonitorSummary$tags": "The list of key-value pairs assigned to the monitor.
", "Probe$tags": "The list of key-value pairs created and assigned to the probe.
", "ProbeInput$tags": "The list of key-value pairs created and assigned to the monitor.
", "TagResourceInput$tags": "The list of key-value pairs assigned to the monitor or probe.
", "UpdateMonitorOutput$tags": "The list of key-value pairs associated with the monitor.
", "UpdateProbeOutput$tags": "Update tags for a probe.
" } }, "TagResourceInput": { "base": null, "refs": { } }, "TagResourceOutput": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "TagMap$value": null } }, "ThrottlingException": { "base": "The request was denied due to request throttling
", "refs": { } }, "UntagResourceInput": { "base": null, "refs": { } }, "UntagResourceOutput": { "base": null, "refs": { } }, "UpdateMonitorInput": { "base": null, "refs": { } }, "UpdateMonitorOutput": { "base": null, "refs": { } }, "UpdateProbeInput": { "base": null, "refs": { } }, "UpdateProbeOutput": { "base": null, "refs": { } }, "ValidationException": { "base": "One of the parameters for the request is not valid.
", "refs": { } }, "VpcId": { "base": null, "refs": { "CreateProbeOutput$vpcId": "The ID of the source VPC or subnet.
", "GetProbeOutput$vpcId": "The ID of the source VPC or subnet.
", "Probe$vpcId": "The ID of the source VPC subnet.
", "UpdateProbeOutput$vpcId": "The updated ID of the source VPC subnet ID.
" } } } }