@aws-sdk/client-networkmonitor

Description

AWS SDK for JavaScript NetworkMonitor Client for Node.js, Browser and React Native.

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. Before you begin, ensure the Amazon Web Services CLI is configured in the Amazon Web Services Account where you will create the Network Monitor resource. Network Monitor doesn’t support creation on cross-account resources, but you can create a Network Monitor in any subnet belonging to a VPC owned by your Account. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/what-is-network-monitor.html">Using Amazon CloudWatch Network Monitor</a> in the Amazon CloudWatch User Guide.

Installing

To install this package, use the CLI of your favorite package manager:

npm install @aws-sdk/client-networkmonitor
yarn add @aws-sdk/client-networkmonitor
pnpm add @aws-sdk/client-networkmonitor

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the NetworkMonitorClient and the commands you need, for example ListMonitorsCommand:

// ES5 example
const { NetworkMonitorClient, ListMonitorsCommand } = require("@aws-sdk/client-networkmonitor");

// ES6+ example
import { NetworkMonitorClient, ListMonitorsCommand } from "@aws-sdk/client-networkmonitor";

Usage

To send a request:

Instantiate a client with configuration (e.g. credentials, region).
- See docs/CLIENTS for configuration details.
- See @aws-sdk/config for additional options.
Instantiate a command with input parameters.
Call the send operation on the client, providing the command object as input.

const client = new NetworkMonitorClient({ region: "REGION" });

const params = { /** input parameters */ };
const command = new ListMonitorsCommand(params);

Async/await

We recommend using the await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Promises

You can also use Promise chaining.

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Aggregated client

The aggregated client class is exported from the same package, but without the "Client" suffix.

NetworkMonitor extends NetworkMonitorClient and additionally supports all operations, waiters, and paginators as methods. This style may be familiar to you from the AWS SDK for JavaScript v2.

If you are bundling the AWS SDK, we recommend using only the bare-bones client (NetworkMonitorClient). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { NetworkMonitor } from "@aws-sdk/client-networkmonitor";

const client = new NetworkMonitor({ region: "REGION" });

// async/await.
try {
  const data = await client.listMonitors(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listMonitors(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks (not recommended).
client.listMonitors(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

Visit the Developer Guide or API Reference.
Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
Ask a question on StackOverflow and tag it with aws-sdk-js.
Join the AWS JavaScript community on gitter.
If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-networkmonitor package is updated. To contribute to client you can check our generate clients scripts.