Networkmonitor

create_monitor(monitor_name)
create_monitor(monitor_name, params::Dict{String,<:Any})

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. 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.

Arguments

• monitor_name: The name identifying the monitor. It can contain only letters, underscores (_), or dashes (-), and can be up to 200 characters.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "aggregationPeriod": The time, in seconds, that metrics are aggregated and sent to Amazon CloudWatch. Valid values are either 30 or 60. 60 is the default if no period is chosen.
• "clientToken": Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
• "probes": Displays a list of all of the probes created for a monitor.
• "tags": The list of key-value pairs created and assigned to the monitor.

create_probe(monitor_name, probe)
create_probe(monitor_name, probe, params::Dict{String,<:Any})

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 monitorName parameter. Run ListMonitors to get a list of monitor names. Note the name of the monitorName you want to create the probe for.

Arguments

• monitor_name: The name of the monitor to associated with the probe.
• probe: Describes the details of an individual probe for a monitor.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
• "tags": The list of key-value pairs created and assigned to the probe.

delete_monitor(monitor_name)
delete_monitor(monitor_name, params::Dict{String,<:Any})

Deletes a specified monitor. This action requires the monitorName parameter. Run ListMonitors to get a list of monitor names.

Arguments

• monitor_name: The name of the monitor to delete.

delete_probe(monitor_name, probe_id)
delete_probe(monitor_name, probe_id, params::Dict{String,<:Any})

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.

Arguments

• monitor_name: The name of the monitor to delete.
• probe_id: The ID of the probe to delete.

get_monitor(monitor_name)
get_monitor(monitor_name, params::Dict{String,<:Any})

Returns details about a specific monitor. This action requires the monitorName parameter. Run ListMonitors to get a list of monitor names.

Arguments

• monitor_name: The name of the monitor that details are returned for.

get_probe(monitor_name, probe_id)
get_probe(monitor_name, probe_id, params::Dict{String,<:Any})

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.

Arguments

• monitor_name: The name of the monitor associated with the probe. Run ListMonitors to get a list of monitor names.
• probe_id: The ID of the probe to get information about. Run GetMonitor action to get a list of probes and probe IDs for the monitor.

list_monitors()
list_monitors(params::Dict{String,<:Any})

Returns a list of all of your monitors.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "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.
• "nextToken": The token for the next page of results.
• "state": The list of all monitors and their states.

list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Lists the tags assigned to this resource.

Arguments

• resource_arn: The

tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Adds key-value pairs to a monitor or probe.

Arguments

• resource_arn: The ARN of the monitor or probe to tag.
• tags: The list of key-value pairs assigned to the monitor or probe.

untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes a key-value pair from a monitor or probe.

Arguments

• resource_arn: The ARN of the monitor or probe that the tag should be removed from.
• tag_keys: The key-value pa

update_monitor(aggregation_period, monitor_name)
update_monitor(aggregation_period, monitor_name, params::Dict{String,<:Any})

Updates the aggregationPeriod for a monitor. Monitors support an aggregationPeriod of either 30 or 60 seconds. This action requires the monitorName and probeId parameter. Run ListMonitors to get a list of monitor names.

Arguments

• aggregation_period: The aggregation time, in seconds, to change to. This must be either 30 or 60.
• monitor_name: The name of the monitor to update.

update_probe(monitor_name, probe_id)
update_probe(monitor_name, probe_id, params::Dict{String,<:Any})

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 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.

Arguments

• monitor_name: The name of the monitor that the probe was updated for.
• probe_id: The ID of the probe to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "destination": The updated IP address for the probe destination. This must be either an IPv4 or IPv6 address.
• "destinationPort": 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.
• "packetSize": he updated packets size for network traffic between the source and destination. This must be a number between 56 and 8500.
• "protocol": The updated network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.
• "state": The state of the probe update.