Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14125953.1 KB

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.

post/monitors

Request body

monitorNamestring required

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

aggregationPeriodinteger

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.

clientTokenstring

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

tagsobject

The list of key-value pairs created and assigned to the monitor.

Response

Success

monitorArnstring required

The ARN of the monitor.

monitorNamestring required

The name of the monitor.

state'PENDING' | 'ACTIVE' | 'INACTIVE' | 'ERROR' | 'DELETING' required

The state of the monitor.

aggregationPeriodinteger

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

tagsobject

The list of key-value pairs assigned to the monitor.