@aws-sdk/client-cloudwatch
TypeScript icon, indicating that this package has built-in type declarations

3.556.0 • Public • Published

@aws-sdk/client-cloudwatch

Description

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

Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.

CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.

In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.

Installing

To install the this package, simply type add or install @aws-sdk/client-cloudwatch using your favorite package manager:

  • npm install @aws-sdk/client-cloudwatch
  • yarn add @aws-sdk/client-cloudwatch
  • pnpm add @aws-sdk/client-cloudwatch

Getting Started

Import

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

// ES5 example
const { CloudWatchClient, ListMetricsCommand } = require("@aws-sdk/client-cloudwatch");
// ES6+ example
import { CloudWatchClient, ListMetricsCommand } from "@aws-sdk/client-cloudwatch";

Usage

To send a request, you:

  • Initiate client with configuration (e.g. credentials, region).
  • Initiate command with input parameters.
  • Call send operation on client with command object as input.
  • If you are using a custom http handler, you may call destroy() to close open connections.
// a client can be shared by different commands.
const client = new CloudWatchClient({ region: "REGION" });

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

Async/await

We recommend using 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.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

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

Promises can also be called using .catch() and .finally() as follows:

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

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // process err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-cloudwatch";
const client = new AWS.CloudWatch({ region: "REGION" });

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

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

// callbacks.
client.listMetrics(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 the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

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-cloudwatch package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

DeleteAlarms

Command API Reference / Input / Output

DeleteAnomalyDetector

Command API Reference / Input / Output

DeleteDashboards

Command API Reference / Input / Output

DeleteInsightRules

Command API Reference / Input / Output

DeleteMetricStream

Command API Reference / Input / Output

DescribeAlarmHistory

Command API Reference / Input / Output

DescribeAlarms

Command API Reference / Input / Output

DescribeAlarmsForMetric

Command API Reference / Input / Output

DescribeAnomalyDetectors

Command API Reference / Input / Output

DescribeInsightRules

Command API Reference / Input / Output

DisableAlarmActions

Command API Reference / Input / Output

DisableInsightRules

Command API Reference / Input / Output

EnableAlarmActions

Command API Reference / Input / Output

EnableInsightRules

Command API Reference / Input / Output

GetDashboard

Command API Reference / Input / Output

GetInsightRuleReport

Command API Reference / Input / Output

GetMetricData

Command API Reference / Input / Output

GetMetricStatistics

Command API Reference / Input / Output

GetMetricStream

Command API Reference / Input / Output

GetMetricWidgetImage

Command API Reference / Input / Output

ListDashboards

Command API Reference / Input / Output

ListManagedInsightRules

Command API Reference / Input / Output

ListMetrics

Command API Reference / Input / Output

ListMetricStreams

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

PutAnomalyDetector

Command API Reference / Input / Output

PutCompositeAlarm

Command API Reference / Input / Output

PutDashboard

Command API Reference / Input / Output

PutInsightRule

Command API Reference / Input / Output

PutManagedInsightRules

Command API Reference / Input / Output

PutMetricAlarm

Command API Reference / Input / Output

PutMetricData

Command API Reference / Input / Output

PutMetricStream

Command API Reference / Input / Output

SetAlarmState

Command API Reference / Input / Output

StartMetricStreams

Command API Reference / Input / Output

StopMetricStreams

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

Readme

Keywords

none

Package Sidebar

Install

npm i @aws-sdk/client-cloudwatch

Weekly Downloads

486,974

Version

3.556.0

License

Apache-2.0

Unpacked Size

1.06 MB

Total Files

224

Last publish

Collaborators

  • mattsb42-aws
  • kuhe
  • amzn-oss
  • aws-sdk-bot
  • trivikr-aws