Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1425123120.1 KB

Create a monitor for specific network flows between local and remote resources, so that you can monitor network performance for one or several of your workloads. For each monitor, Network Flow Monitor publishes detailed end-to-end performance metrics and a network health indicator (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose.

post/monitors

Request body

monitorNamestring required

The name of the monitor.

scopeArnstring required

The Amazon Resource Name (ARN) of the scope for the monitor.

clientTokenstring

A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.

tagsobject

The tags for a monitor. You can add a maximum of 200 tags.

Response

Success

monitorArnstring required

The Amazon Resource Name (ARN) of the monitor.

monitorNamestring required

The name of the monitor.

monitorStatus'PENDING' | 'ACTIVE' | 'INACTIVE' | 'ERROR' | 'DELETING' required
<p>The status of a monitor. The status can be one of the following</p> <ul> <li> <p> <code>PENDING</code>: The monitor is in the process of being created.</p> </li> <li> <p> <code>ACTIVE</code>: The monitor is active.</p> </li> <li> <p> <code>INACTIVE</code>: The monitor is inactive.</p> </li> <li> <p> <code>ERROR</code>: Monitor creation failed due to an error.</p> </li> <li> <p> <code>DELETING</code>: The monitor is in the process of being deleted.</p> </li> </ul>
createdAtstring date-time required

The date and time when the monitor was created.

modifiedAtstring date-time required

The last date and time that the monitor was modified.

tagsobject

The tags for a monitor.