Class: AWS.CloudWatch

Inherits:
AWS.Service show all
Identifier:
cloudwatch
API Version:
2010-08-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS 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 AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.

Sending a Request Using CloudWatch

var cloudwatch = new AWS.CloudWatch();
cloudwatch.getMetricWidgetImage(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the CloudWatch object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var cloudwatch = new AWS.CloudWatch({apiVersion: '2010-08-01'});

You can also set the API version globally in AWS.config.apiVersions using the cloudwatch service identifier:

AWS.config.apiVersions = {
  cloudwatch: '2010-08-01',
  // other service API versions
};

var cloudwatch = new AWS.CloudWatch();

Version:

  • 2010-08-01

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

alarmExists

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.CloudWatch(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a CloudWatch object

var cloudwatch = new AWS.CloudWatch({apiVersion: '2010-08-01'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.CloudWatch.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.CloudWatch.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.CloudWatch.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

deleteAlarms(params = {}, callback) ⇒ AWS.Request

Deletes the specified alarms. In the event of an error, no alarms are deleted.

Service Reference:

Examples:

Calling the deleteAlarms operation

var params = {
  AlarmNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
cloudwatch.deleteAlarms(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AlarmNames — (Array<String>)

      The alarms to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteDashboards(params = {}, callback) ⇒ AWS.Request

Deletes all dashboards that you specify. You may specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.

Service Reference:

Examples:

Calling the deleteDashboards operation

var params = {
  DashboardNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
cloudwatch.deleteDashboards(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DashboardNames — (Array<String>)

      The dashboards to be deleted. This parameter is required.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAlarmHistory(params = {}, callback) ⇒ AWS.Request

Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for all alarms are returned.

CloudWatch retains the history of an alarm even if you delete the alarm.

Service Reference:

Examples:

Calling the describeAlarmHistory operation

var params = {
  AlarmName: 'STRING_VALUE',
  EndDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  HistoryItemType: ConfigurationUpdate | StateUpdate | Action,
  MaxRecords: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StartDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
cloudwatch.describeAlarmHistory(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AlarmName — (String)

      The name of the alarm.

    • HistoryItemType — (String)

      The type of alarm histories to retrieve.

      Possible values include:
      • "ConfigurationUpdate"
      • "StateUpdate"
      • "Action"
    • StartDate — (Date)

      The starting date to retrieve alarm history.

    • EndDate — (Date)

      The ending date to retrieve alarm history.

    • MaxRecords — (Integer)

      The maximum number of alarm history records to retrieve.

    • NextToken — (String)

      The token returned by a previous call to indicate that there is more data available.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AlarmHistoryItems — (Array<map>)

        The alarm histories, in JSON format.

        • AlarmName — (String)

          The descriptive name for the alarm.

        • Timestamp — (Date)

          The time stamp for the alarm history item.

        • HistoryItemType — (String)

          The type of alarm history item.

          Possible values include:
          • "ConfigurationUpdate"
          • "StateUpdate"
          • "Action"
        • HistorySummary — (String)

          A summary of the alarm history, in text format.

        • HistoryData — (String)

          Data about the alarm, in JSON format.

      • NextToken — (String)

        The token that marks the start of the next batch of returned results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAlarms(params = {}, callback) ⇒ AWS.Request

Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.

Service Reference:

Examples:

Calling the describeAlarms operation

var params = {
  ActionPrefix: 'STRING_VALUE',
  AlarmNamePrefix: 'STRING_VALUE',
  AlarmNames: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxRecords: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StateValue: OK | ALARM | INSUFFICIENT_DATA
};
cloudwatch.describeAlarms(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AlarmNames — (Array<String>)

      The names of the alarms.

    • AlarmNamePrefix — (String)

      The alarm name prefix. If this parameter is specified, you cannot specify AlarmNames.

    • StateValue — (String)

      The state value to be used in matching alarms.

      Possible values include:
      • "OK"
      • "ALARM"
      • "INSUFFICIENT_DATA"
    • ActionPrefix — (String)

      The action name prefix.

    • MaxRecords — (Integer)

      The maximum number of alarm descriptions to retrieve.

    • NextToken — (String)

      The token returned by a previous call to indicate that there is more data available.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MetricAlarms — (Array<map>)

        The information for the specified alarms.

        • AlarmName — (String)

          The name of the alarm.

        • AlarmArn — (String)

          The Amazon Resource Name (ARN) of the alarm.

        • AlarmDescription — (String)

          The description of the alarm.

        • AlarmConfigurationUpdatedTimestamp — (Date)

          The time stamp of the last update to the alarm configuration.

        • ActionsEnabled — (Boolean)

          Indicates whether actions should be executed during any changes to the alarm state.

        • OKActions — (Array<String>)

          The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        • AlarmActions — (Array<String>)

          The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        • InsufficientDataActions — (Array<String>)

          The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        • StateValue — (String)

          The state value for the alarm.

          Possible values include:
          • "OK"
          • "ALARM"
          • "INSUFFICIENT_DATA"
        • StateReason — (String)

          An explanation for the alarm state, in text format.

        • StateReasonData — (String)

          An explanation for the alarm state, in JSON format.

        • StateUpdatedTimestamp — (Date)

          The time stamp of the last update to the alarm state.

        • MetricName — (String)

          The name of the metric associated with the alarm.

        • Namespace — (String)

          The namespace of the metric associated with the alarm.

        • Statistic — (String)

          The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

          Possible values include:
          • "SampleCount"
          • "Average"
          • "Sum"
          • "Minimum"
          • "Maximum"
        • ExtendedStatistic — (String)

          The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

        • Dimensions — (Array<map>)

          The dimensions for the metric associated with the alarm.

          • Name — required — (String)

            The name of the dimension.

          • Value — required — (String)

            The value representing the dimension measurement.

        • Period — (Integer)

          The period, in seconds, over which the statistic is applied.

        • Unit — (String)

          The unit of the metric associated with the alarm.

          Possible values include:
          • "Seconds"
          • "Microseconds"
          • "Milliseconds"
          • "Bytes"
          • "Kilobytes"
          • "Megabytes"
          • "Gigabytes"
          • "Terabytes"
          • "Bits"
          • "Kilobits"
          • "Megabits"
          • "Gigabits"
          • "Terabits"
          • "Percent"
          • "Count"
          • "Bytes/Second"
          • "Kilobytes/Second"
          • "Megabytes/Second"
          • "Gigabytes/Second"
          • "Terabytes/Second"
          • "Bits/Second"
          • "Kilobits/Second"
          • "Megabits/Second"
          • "Gigabits/Second"
          • "Terabits/Second"
          • "Count/Second"
          • "None"
        • EvaluationPeriods — (Integer)

          The number of periods over which data is compared to the specified threshold.

        • DatapointsToAlarm — (Integer)

          The number of datapoints that must be breaching to trigger the alarm.

        • Threshold — (Float)

          The value to compare with the specified statistic.

        • ComparisonOperator — (String)

          The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

          Possible values include:
          • "GreaterThanOrEqualToThreshold"
          • "GreaterThanThreshold"
          • "LessThanThreshold"
          • "LessThanOrEqualToThreshold"
        • TreatMissingData — (String)

          Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.

        • EvaluateLowSampleCountPercentile — (String)

          Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

        • Metrics — (Array<map>)

          • Id — required — (String)

            A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

          • MetricStat — (map)

            The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.

            Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

            • Metric — required — (map)

              The metric to return, including the metric name, namespace, and dimensions.

              • Namespace — (String)

                The namespace of the metric.

              • MetricName — (String)

                The name of the metric. This is a required field.

              • Dimensions — (Array<map>)

                The dimensions for the metric.

                • Name — required — (String)

                  The name of the dimension.

                • Value — required — (String)

                  The value representing the dimension measurement.

            • Period — required — (Integer)

              The period, in seconds, to use when retrieving the metric.

            • Stat — required — (String)

              The statistic to return. It can include any CloudWatch statistic or extended statistic.

            • Unit — (String)

              The unit to use for the returned data points.

              Possible values include:
              • "Seconds"
              • "Microseconds"
              • "Milliseconds"
              • "Bytes"
              • "Kilobytes"
              • "Megabytes"
              • "Gigabytes"
              • "Terabytes"
              • "Bits"
              • "Kilobits"
              • "Megabits"
              • "Gigabits"
              • "Terabits"
              • "Percent"
              • "Count"
              • "Bytes/Second"
              • "Kilobytes/Second"
              • "Megabytes/Second"
              • "Gigabytes/Second"
              • "Terabytes/Second"
              • "Bits/Second"
              • "Kilobits/Second"
              • "Megabits/Second"
              • "Gigabits/Second"
              • "Terabits/Second"
              • "Count/Second"
              • "None"
          • Expression — (String)

            The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

            Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

          • Label — (String)

            A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.

          • ReturnData — (Boolean)

            When used in GetMetricData, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False. If you omit this, the default of True is used.

            When used in PutMetricAlarm, specify True for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

      • NextToken — (String)

        The token that marks the start of the next batch of returned results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeAlarmsForMetric(params = {}, callback) ⇒ AWS.Request

Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

Service Reference:

Examples:

Calling the describeAlarmsForMetric operation

var params = {
  MetricName: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE', /* required */
  Dimensions: [
    {
      Name: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  ExtendedStatistic: 'STRING_VALUE',
  Period: 'NUMBER_VALUE',
  Statistic: SampleCount | Average | Sum | Minimum | Maximum,
  Unit: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None
};
cloudwatch.describeAlarmsForMetric(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MetricName — (String)

      The name of the metric.

    • Namespace — (String)

      The namespace of the metric.

    • Statistic — (String)

      The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.

      Possible values include:
      • "SampleCount"
      • "Average"
      • "Sum"
      • "Minimum"
      • "Maximum"
    • ExtendedStatistic — (String)

      The percentile statistic for the metric. Specify a value between p0.0 and p100.

    • Dimensions — (Array<map>)

      The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.

      • Name — required — (String)

        The name of the dimension.

      • Value — required — (String)

        The value representing the dimension measurement.

    • Period — (Integer)

      The period, in seconds, over which the statistic is applied.

    • Unit — (String)

      The unit for the metric.

      Possible values include:
      • "Seconds"
      • "Microseconds"
      • "Milliseconds"
      • "Bytes"
      • "Kilobytes"
      • "Megabytes"
      • "Gigabytes"
      • "Terabytes"
      • "Bits"
      • "Kilobits"
      • "Megabits"
      • "Gigabits"
      • "Terabits"
      • "Percent"
      • "Count"
      • "Bytes/Second"
      • "Kilobytes/Second"
      • "Megabytes/Second"
      • "Gigabytes/Second"
      • "Terabytes/Second"
      • "Bits/Second"
      • "Kilobits/Second"
      • "Megabits/Second"
      • "Gigabits/Second"
      • "Terabits/Second"
      • "Count/Second"
      • "None"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MetricAlarms — (Array<map>)

        The information for each alarm with the specified metric.

        • AlarmName — (String)

          The name of the alarm.

        • AlarmArn — (String)

          The Amazon Resource Name (ARN) of the alarm.

        • AlarmDescription — (String)

          The description of the alarm.

        • AlarmConfigurationUpdatedTimestamp — (Date)

          The time stamp of the last update to the alarm configuration.

        • ActionsEnabled — (Boolean)

          Indicates whether actions should be executed during any changes to the alarm state.

        • OKActions — (Array<String>)

          The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        • AlarmActions — (Array<String>)

          The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        • InsufficientDataActions — (Array<String>)

          The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        • StateValue — (String)

          The state value for the alarm.

          Possible values include:
          • "OK"
          • "ALARM"
          • "INSUFFICIENT_DATA"
        • StateReason — (String)

          An explanation for the alarm state, in text format.

        • StateReasonData — (String)

          An explanation for the alarm state, in JSON format.

        • StateUpdatedTimestamp — (Date)

          The time stamp of the last update to the alarm state.

        • MetricName — (String)

          The name of the metric associated with the alarm.

        • Namespace — (String)

          The namespace of the metric associated with the alarm.

        • Statistic — (String)

          The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

          Possible values include:
          • "SampleCount"
          • "Average"
          • "Sum"
          • "Minimum"
          • "Maximum"
        • ExtendedStatistic — (String)

          The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

        • Dimensions — (Array<map>)

          The dimensions for the metric associated with the alarm.

          • Name — required — (String)

            The name of the dimension.

          • Value — required — (String)

            The value representing the dimension measurement.

        • Period — (Integer)

          The period, in seconds, over which the statistic is applied.

        • Unit — (String)

          The unit of the metric associated with the alarm.

          Possible values include:
          • "Seconds"
          • "Microseconds"
          • "Milliseconds"
          • "Bytes"
          • "Kilobytes"
          • "Megabytes"
          • "Gigabytes"
          • "Terabytes"
          • "Bits"
          • "Kilobits"
          • "Megabits"
          • "Gigabits"
          • "Terabits"
          • "Percent"
          • "Count"
          • "Bytes/Second"
          • "Kilobytes/Second"
          • "Megabytes/Second"
          • "Gigabytes/Second"
          • "Terabytes/Second"
          • "Bits/Second"
          • "Kilobits/Second"
          • "Megabits/Second"
          • "Gigabits/Second"
          • "Terabits/Second"
          • "Count/Second"
          • "None"
        • EvaluationPeriods — (Integer)

          The number of periods over which data is compared to the specified threshold.

        • DatapointsToAlarm — (Integer)

          The number of datapoints that must be breaching to trigger the alarm.

        • Threshold — (Float)

          The value to compare with the specified statistic.

        • ComparisonOperator — (String)

          The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

          Possible values include:
          • "GreaterThanOrEqualToThreshold"
          • "GreaterThanThreshold"
          • "LessThanThreshold"
          • "LessThanOrEqualToThreshold"
        • TreatMissingData — (String)

          Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.

        • EvaluateLowSampleCountPercentile — (String)

          Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

        • Metrics — (Array<map>)

          • Id — required — (String)

            A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

          • MetricStat — (map)

            The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.

            Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

            • Metric — required — (map)

              The metric to return, including the metric name, namespace, and dimensions.

              • Namespace — (String)

                The namespace of the metric.

              • MetricName — (String)

                The name of the metric. This is a required field.

              • Dimensions — (Array<map>)

                The dimensions for the metric.

                • Name — required — (String)

                  The name of the dimension.

                • Value — required — (String)

                  The value representing the dimension measurement.

            • Period — required — (Integer)

              The period, in seconds, to use when retrieving the metric.

            • Stat — required — (String)

              The statistic to return. It can include any CloudWatch statistic or extended statistic.

            • Unit — (String)

              The unit to use for the returned data points.

              Possible values include:
              • "Seconds"
              • "Microseconds"
              • "Milliseconds"
              • "Bytes"
              • "Kilobytes"
              • "Megabytes"
              • "Gigabytes"
              • "Terabytes"
              • "Bits"
              • "Kilobits"
              • "Megabits"
              • "Gigabits"
              • "Terabits"
              • "Percent"
              • "Count"
              • "Bytes/Second"
              • "Kilobytes/Second"
              • "Megabytes/Second"
              • "Gigabytes/Second"
              • "Terabytes/Second"
              • "Bits/Second"
              • "Kilobits/Second"
              • "Megabits/Second"
              • "Gigabits/Second"
              • "Terabits/Second"
              • "Count/Second"
              • "None"
          • Expression — (String)

            The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

            Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

          • Label — (String)

            A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.

          • ReturnData — (Boolean)

            When used in GetMetricData, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False. If you omit this, the default of True is used.

            When used in PutMetricAlarm, specify True for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

disableAlarmActions(params = {}, callback) ⇒ AWS.Request

Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.

Service Reference:

Examples:

Calling the disableAlarmActions operation

var params = {
  AlarmNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
cloudwatch.disableAlarmActions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AlarmNames — (Array<String>)

      The names of the alarms.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

enableAlarmActions(params = {}, callback) ⇒ AWS.Request

Enables the actions for the specified alarms.

Service Reference:

Examples:

Calling the enableAlarmActions operation

var params = {
  AlarmNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
cloudwatch.enableAlarmActions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AlarmNames — (Array<String>)

      The names of the alarms.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getDashboard(params = {}, callback) ⇒ AWS.Request

Displays the details of the dashboard that you specify.

To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

Service Reference:

Examples:

Calling the getDashboard operation

var params = {
  DashboardName: 'STRING_VALUE' /* required */
};
cloudwatch.getDashboard(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DashboardName — (String)

      The name of the dashboard to be described.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DashboardArn — (String)

        The Amazon Resource Name (ARN) of the dashboard.

      • DashboardBody — (String)

        The detailed information about the dashboard, including what widgets are included and their location on the dashboard. For more information about the DashboardBody syntax, see CloudWatch-Dashboard-Body-Structure.

      • DashboardName — (String)

        The name of the dashboard.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getMetricData(params = {}, callback) ⇒ AWS.Request

You can use the GetMetricData API to retrieve as many as 100 different metrics in a single request, with a total of as many as 100,800 datapoints. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.

Amazon CloudWatch retains metric data as follows:

  • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

  • Data points with a period of 60 seconds (1-minute) are available for 15 days.

  • Data points with a period of 300 seconds (5-minute) are available for 63 days.

  • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

Service Reference:

Examples:

Calling the getMetricData operation

var params = {
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  MetricDataQueries: [ /* required */
    {
      Id: 'STRING_VALUE', /* required */
      Expression: 'STRING_VALUE',
      Label: 'STRING_VALUE',
      MetricStat: {
        Metric: { /* required */
          Dimensions: [
            {
              Name: 'STRING_VALUE', /* required */
              Value: 'STRING_VALUE' /* required */
            },
            /* more items */
          ],
          MetricName: 'STRING_VALUE',
          Namespace: 'STRING_VALUE'
        },
        Period: 'NUMBER_VALUE', /* required */
        Stat: 'STRING_VALUE', /* required */
        Unit: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None
      },
      ReturnData: true || false
    },
    /* more items */
  ],
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  MaxDatapoints: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ScanBy: TimestampDescending | TimestampAscending
};
cloudwatch.getMetricData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MetricDataQueries — (Array<map>)

      The metric queries to be returned. A single GetMetricData call can include as many as 100 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

      • Id — required — (String)

        A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

      • MetricStat — (map)

        The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.

        Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

        • Metric — required — (map)

          The metric to return, including the metric name, namespace, and dimensions.

          • Namespace — (String)

            The namespace of the metric.

          • MetricName — (String)

            The name of the metric. This is a required field.

          • Dimensions — (Array<map>)

            The dimensions for the metric.

            • Name — required — (String)

              The name of the dimension.

            • Value — required — (String)

              The value representing the dimension measurement.

        • Period — required — (Integer)

          The period, in seconds, to use when retrieving the metric.

        • Stat — required — (String)

          The statistic to return. It can include any CloudWatch statistic or extended statistic.

        • Unit — (String)

          The unit to use for the returned data points.

          Possible values include:
          • "Seconds"
          • "Microseconds"
          • "Milliseconds"
          • "Bytes"
          • "Kilobytes"
          • "Megabytes"
          • "Gigabytes"
          • "Terabytes"
          • "Bits"
          • "Kilobits"
          • "Megabits"
          • "Gigabits"
          • "Terabits"
          • "Percent"
          • "Count"
          • "Bytes/Second"
          • "Kilobytes/Second"
          • "Megabytes/Second"
          • "Gigabytes/Second"
          • "Terabytes/Second"
          • "Bits/Second"
          • "Kilobits/Second"
          • "Megabits/Second"
          • "Gigabits/Second"
          • "Terabits/Second"
          • "Count/Second"
          • "None"
      • Expression — (String)

        The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

        Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

      • Label — (String)

        A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.

      • ReturnData — (Boolean)

        When used in GetMetricData, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False. If you omit this, the default of True is used.

        When used in PutMetricAlarm, specify True for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

    • StartTime — (Date)

      The time stamp indicating the earliest data to be returned.

      For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime.

    • EndTime — (Date)

      The time stamp indicating the latest data to be returned.

      For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the EndTime.

    • NextToken — (String)

      Include this value, if it was returned by the previous call, to get the next set of data points.

    • ScanBy — (String)

      The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.

      Possible values include:
      • "TimestampDescending"
      • "TimestampAscending"
    • MaxDatapoints — (Integer)

      The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MetricDataResults — (Array<map>)

        The metrics that are returned, including the metric name, namespace, and dimensions.

        • Id — (String)

          The short name you specified to represent this metric.

        • Label — (String)

          The human-readable label associated with the data.

        • Timestamps — (Array<Date>)

          The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].

        • Values — (Array<Float>)

          The data points for the metric corresponding to Timestamps. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].

        • StatusCode — (String)

          The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.

          Possible values include:
          • "Complete"
          • "InternalError"
          • "PartialData"
        • Messages — (Array<map>)

          A list of messages with additional information about the data returned.

          • Code — (String)

            The error code or status code associated with the message.

          • Value — (String)

            The message text.

      • NextToken — (String)

        A token that marks the next batch of returned results.

      • Messages — (Array<map>)

        Contains a message about this GetMetricData operation, if the operation results in such a message. An example of a message that may be returned is Maximum number of allowed metrics exceeded. If there is a message, as much of the operation as possible is still executed.

        A message appears here only if it is related to the global GetMetricData operation. Any message about a specific metric returned by the operation appears in the MetricDataResult object returned for that metric.

        • Code — (String)

          The error code or status code associated with the message.

        • Value — (String)

          The message text.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getMetricStatistics(params = {}, callback) ⇒ AWS.Request

Gets statistics for the specified metric.

The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.

CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.

CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

  • The SampleCount value of the statistic set is 1.

  • The Min and the Max values of the statistic set are equal.

Percentile statistics are not available for metrics when any of the metric values are negative numbers.

Amazon CloudWatch retains metric data as follows:

  • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

  • Data points with a period of 60 seconds (1-minute) are available for 15 days.

  • Data points with a period of 300 seconds (5-minute) are available for 63 days.

  • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

For information about metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.

Service Reference:

Examples:

Calling the getMetricStatistics operation

var params = {
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  MetricName: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE', /* required */
  Period: 'NUMBER_VALUE', /* required */
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  Dimensions: [
    {
      Name: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  ExtendedStatistics: [
    'STRING_VALUE',
    /* more items */
  ],
  Statistics: [
    SampleCount | Average | Sum | Minimum | Maximum,
    /* more items */
  ],
  Unit: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None
};
cloudwatch.getMetricStatistics(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Namespace — (String)

      The namespace of the metric, with or without spaces.

    • MetricName — (String)

      The name of the metric, with or without spaces.

    • Dimensions — (Array<map>)

      The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

      • Name — required — (String)

        The name of the dimension.

      • Value — required — (String)

        The value representing the dimension measurement.

    • StartTime — (Date)

      The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.

      The value specified is inclusive; results include data points with the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

      CloudWatch rounds the specified time stamp as follows:

      • Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

      • Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

      • Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

      If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.

    • EndTime — (Date)

      The time stamp that determines the last data point to return.

      The value specified is exclusive; results include data points up to the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

    • Period — (Integer)

      The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

      If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

      • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

      • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

      • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

    • Statistics — (Array<String>)

      The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.

    • ExtendedStatistics — (Array<String>)

      The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.

    • Unit — (String)

      The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If you specify only a unit that the metric does not report, the results of the call are null.

      Possible values include:
      • "Seconds"
      • "Microseconds"
      • "Milliseconds"
      • "Bytes"
      • "Kilobytes"
      • "Megabytes"
      • "Gigabytes"
      • "Terabytes"
      • "Bits"
      • "Kilobits"
      • "Megabits"
      • "Gigabits"
      • "Terabits"
      • "Percent"
      • "Count"
      • "Bytes/Second"
      • "Kilobytes/Second"
      • "Megabytes/Second"
      • "Gigabytes/Second"
      • "Terabytes/Second"
      • "Bits/Second"
      • "Kilobits/Second"
      • "Megabits/Second"
      • "Gigabits/Second"
      • "Terabits/Second"
      • "Count/Second"
      • "None"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Label — (String)

        A label for the specified metric.

      • Datapoints — (Array<map>)

        The data points for the specified metric.

        • Timestamp — (Date)

          The time stamp used for the data point.

        • SampleCount — (Float)

          The number of metric values that contributed to the aggregate value of this data point.

        • Average — (Float)

          The average of the metric values that correspond to the data point.

        • Sum — (Float)

          The sum of the metric values for the data point.

        • Minimum — (Float)

          The minimum metric value for the data point.

        • Maximum — (Float)

          The maximum metric value for the data point.

        • Unit — (String)

          The standard unit for the data point.

          Possible values include:
          • "Seconds"
          • "Microseconds"
          • "Milliseconds"
          • "Bytes"
          • "Kilobytes"
          • "Megabytes"
          • "Gigabytes"
          • "Terabytes"
          • "Bits"
          • "Kilobits"
          • "Megabits"
          • "Gigabits"
          • "Terabits"
          • "Percent"
          • "Count"
          • "Bytes/Second"
          • "Kilobytes/Second"
          • "Megabytes/Second"
          • "Gigabytes/Second"
          • "Terabytes/Second"
          • "Bits/Second"
          • "Kilobits/Second"
          • "Megabits/Second"
          • "Gigabits/Second"
          • "Terabits/Second"
          • "Count/Second"
          • "None"
        • ExtendedStatistics — (map<Float>)

          The percentile statistic for the data point.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getMetricWidgetImage(params = {}, callback) ⇒ AWS.Request

You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.

The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.

There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

  • As many as 100 metrics in the graph.

  • Up to 100 KB uncompressed payload.

Service Reference:

Examples:

Calling the getMetricWidgetImage operation

var params = {
  MetricWidget: 'STRING_VALUE', /* required */
  OutputFormat: 'STRING_VALUE'
};
cloudwatch.getMetricWidgetImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MetricWidget — (String)

      A JSON string that defines the bitmap graph to be retrieved. The string includes the metrics to include in the graph, statistics, annotations, title, axis limits, and so on. You can include only one MetricWidget parameter in each GetMetricWidgetImage call.

      For more information about the syntax of MetricWidget see CloudWatch-Metric-Widget-Structure.

      If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation point appears next to the graph legend.

    • OutputFormat — (String)

      The format of the resulting image. Only PNG images are supported.

      The default is png. If you specify png, the API returns an HTTP response with the content-type set to text/xml. The image data is in a MetricWidgetImage field. For example:

      <GetMetricWidgetImageResponse xmlns=<URLstring>>

      <GetMetricWidgetImageResult>

      <MetricWidgetImage>

      iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...

      </MetricWidgetImage>

      </GetMetricWidgetImageResult>

      <ResponseMetadata>

      <RequestId>6f0d4192-4d42-11e8-82c1-f539a07e0e3b</RequestId>

      </ResponseMetadata>

      </GetMetricWidgetImageResponse>

      The image/png setting is intended only for custom HTTP requests. For most use cases, and all actions using an AWS SDK, you should use png. If you specify image/png, the HTTP response has a content-type set to image/png, and the body of the response is a PNG image.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MetricWidgetImage — (Buffer(Node.js), Typed Array(Browser))

        The image of the graph, in the output format specified.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDashboards(params = {}, callback) ⇒ AWS.Request

Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

Service Reference:

Examples:

Calling the listDashboards operation

var params = {
  DashboardNamePrefix: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
cloudwatch.listDashboards(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DashboardNamePrefix — (String)

      If you specify this parameter, only the dashboards with names starting with the specified string are listed. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, ".", "-", and "_".

    • NextToken — (String)

      The token returned by a previous call to indicate that there is more data available.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DashboardEntries — (Array<map>)

        The list of matching dashboards.

        • DashboardName — (String)

          The name of the dashboard.

        • DashboardArn — (String)

          The Amazon Resource Name (ARN) of the dashboard.

        • LastModified — (Date)

          The time stamp of when the dashboard was last modified, either by an API call or through the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

        • Size — (Integer)

          The size of the dashboard, in bytes.

      • NextToken — (String)

        The token that marks the start of the next batch of returned results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listMetrics(params = {}, callback) ⇒ AWS.Request

List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.

Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricData or GetMetricStatistics.

Service Reference:

Examples:

Calling the listMetrics operation

var params = {
  Dimensions: [
    {
      Name: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  MetricName: 'STRING_VALUE',
  Namespace: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
cloudwatch.listMetrics(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Namespace — (String)

      The namespace to filter against.

    • MetricName — (String)

      The name of the metric to filter against.

    • Dimensions — (Array<map>)

      The dimensions to filter against.

      • Name — required — (String)

        The dimension name to be matched.

      • Value — (String)

        The value of the dimension to be matched.

    • NextToken — (String)

      The token returned by a previous call to indicate that there is more data available.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Metrics — (Array<map>)

        The metrics.

        • Namespace — (String)

          The namespace of the metric.

        • MetricName — (String)

          The name of the metric. This is a required field.

        • Dimensions — (Array<map>)

          The dimensions for the metric.

          • Name — required — (String)

            The name of the dimension.

          • Value — required — (String)

            The value representing the dimension measurement.

      • NextToken — (String)

        The token that marks the start of the next batch of returned results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Displays the tags associated with a CloudWatch resource. Alarms support tagging.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
cloudwatch.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceARN — (String)

      The ARN of the CloudWatch resource that you want to view tags for. For more information on ARN format, see Example ARNs in the Amazon Web Services General Reference.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        The list of tag keys and values associated with the resource you specified.

        • Key — required — (String)

          A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.

        • Value — required — (String)

          The value for the specified tag key.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putDashboard(params = {}, callback) ⇒ AWS.Request

Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

There is no limit to the number of dashboards in your account. All dashboards in your account are global, not region-specific.

A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

Service Reference:

Examples:

Calling the putDashboard operation

var params = {
  DashboardBody: 'STRING_VALUE', /* required */
  DashboardName: 'STRING_VALUE' /* required */
};
cloudwatch.putDashboard(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DashboardName — (String)

      The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, "-", and "_". This parameter is required.

    • DashboardBody — (String)

      The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.

      For more information about the syntax, see CloudWatch-Dashboard-Body-Structure.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DashboardValidationMessages — (Array<map>)

        If the input for PutDashboard was correct and the dashboard was successfully created or modified, this result is empty.

        If this result includes only warning messages, then the input was valid enough for the dashboard to be created or modified, but some elements of the dashboard may not render.

        If this result includes error messages, the input was not valid and the operation failed.

        • DataPath — (String)

          The data path related to the message.

        • Message — (String)

          A message describing the error or warning.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putMetricAlarm(params = {}, callback) ⇒ AWS.Request

Creates or updates an alarm and associates it with the specified metric or metric math expression.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:

  • iam:CreateServiceLinkedRole for all alarms with EC2 actions

  • ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on EC2 instance status metrics

  • ec2:StopInstances for alarms with stop actions

  • ec2:TerminateInstances for alarms with terminate actions

  • No specific permissions are needed for alarms with recover actions

If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.

If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.

If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.

The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked role is called AWSServiceRoleForCloudWatchEvents. For more information, see AWS service-linked role.

Service Reference:

Examples:

Calling the putMetricAlarm operation

var params = {
  AlarmName: 'STRING_VALUE', /* required */
  ComparisonOperator: GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanThreshold | LessThanOrEqualToThreshold, /* required */
  EvaluationPeriods: 'NUMBER_VALUE', /* required */
  Threshold: 'NUMBER_VALUE', /* required */
  ActionsEnabled: true || false,
  AlarmActions: [
    'STRING_VALUE',
    /* more items */
  ],
  AlarmDescription: 'STRING_VALUE',
  DatapointsToAlarm: 'NUMBER_VALUE',
  Dimensions: [
    {
      Name: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  EvaluateLowSampleCountPercentile: 'STRING_VALUE',
  ExtendedStatistic: 'STRING_VALUE',
  InsufficientDataActions: [
    'STRING_VALUE',
    /* more items */
  ],
  MetricName: 'STRING_VALUE',
  Metrics: [
    {
      Id: 'STRING_VALUE', /* required */
      Expression: 'STRING_VALUE',
      Label: 'STRING_VALUE',
      MetricStat: {
        Metric: { /* required */
          Dimensions: [
            {
              Name: 'STRING_VALUE', /* required */
              Value: 'STRING_VALUE' /* required */
            },
            /* more items */
          ],
          MetricName: 'STRING_VALUE',
          Namespace: 'STRING_VALUE'
        },
        Period: 'NUMBER_VALUE', /* required */
        Stat: 'STRING_VALUE', /* required */
        Unit: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None
      },
      ReturnData: true || false
    },
    /* more items */
  ],
  Namespace: 'STRING_VALUE',
  OKActions: [
    'STRING_VALUE',
    /* more items */
  ],
  Period: 'NUMBER_VALUE',
  Statistic: SampleCount | Average | Sum | Minimum | Maximum,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TreatMissingData: 'STRING_VALUE',
  Unit: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None
};
cloudwatch.putMetricAlarm(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AlarmName — (String)

      The name for the alarm. This name must be unique within your AWS account.

    • AlarmDescription — (String)

      The description for the alarm.

    • ActionsEnabled — (Boolean)

      Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

    • OKActions — (Array<String>)

      The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

      Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

      Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

    • AlarmActions — (Array<String>)

      The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

      Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

      Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

    • InsufficientDataActions — (Array<String>)

      The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

      Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

      Valid Values (for use with IAM roles): >arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

    • MetricName — (String)

      The name for the metric associated with the alarm.

      If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the Dimensions, Period, Namespace, Statistic, or ExtendedStatistic parameters. Instead, you specify all this information in the Metrics array.

    • Namespace — (String)

      The namespace for the metric associated specified in MetricName.

    • Statistic — (String)

      The statistic for the metric specified in MetricName, other than percentile. For percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic, but not both.

      Possible values include:
      • "SampleCount"
      • "Average"
      • "Sum"
      • "Minimum"
      • "Maximum"
    • ExtendedStatistic — (String)

      The percentile statistic for the metric specified in MetricName. Specify a value between p0.0 and p100. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic, but not both.

    • Dimensions — (Array<map>)

      The dimensions for the metric specified in MetricName.

      • Name — required — (String)

        The name of the dimension.

      • Value — required — (String)

        The value representing the dimension measurement.

    • Period — (Integer)

      The length, in seconds, used each time the metric specified in MetricName is evaluated. Valid values are 10, 30, and any multiple of 60.

      Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a StorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm may often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.

      An alarm's total current evaluation period can be no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.

    • Unit — (String)

      The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.

      If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the CloudWatch alarm can get stuck in the INSUFFICIENT DATA state.

      Possible values include:
      • "Seconds"
      • "Microseconds"
      • "Milliseconds"
      • "Bytes"
      • "Kilobytes"
      • "Megabytes"
      • "Gigabytes"
      • "Terabytes"
      • "Bits"
      • "Kilobits"
      • "Megabits"
      • "Gigabits"
      • "Terabits"
      • "Percent"
      • "Count"
      • "Bytes/Second"
      • "Kilobytes/Second"
      • "Megabytes/Second"
      • "Gigabytes/Second"
      • "Terabytes/Second"
      • "Bits/Second"
      • "Kilobits/Second"
      • "Megabits/Second"
      • "Gigabits/Second"
      • "Terabits/Second"
      • "Count/Second"
      • "None"
    • EvaluationPeriods — (Integer)

      The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N.

      An alarm's total current evaluation period can be no longer than one day, so this number multiplied by Period cannot be more than 86,400 seconds.

    • DatapointsToAlarm — (Integer)

      The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide.

    • Threshold — (Float)

      The value against which the specified statistic is compared.

    • ComparisonOperator — (String)

      The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

      Possible values include:
      • "GreaterThanOrEqualToThreshold"
      • "GreaterThanThreshold"
      • "LessThanThreshold"
      • "LessThanOrEqualToThreshold"
    • TreatMissingData — (String)

      Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data.

      Valid Values: breaching | notBreaching | ignore | missing

    • EvaluateLowSampleCountPercentile — (String)

      Used only for alarms based on percentiles. If you specify ignore, the alarm state does not change during periods with too few data points to be statistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state no matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.

      Valid Values: evaluate | ignore

    • Metrics — (Array<map>)

      An array of MetricDataQuery structures that enable you to create an alarm based on the result of a metric math expression. Each item in the Metrics array either retrieves a metric or performs a math expression.

      One item in the Metrics array is the expression that the alarm watches. You designate this expression by setting ReturnValue to true for this object in the array. For more information, see MetricDataQuery.

      If you use the Metrics parameter, you cannot include the MetricName, Dimensions, Period, Namespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the Metrics array.

      • Id — required — (String)

        A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

      • MetricStat — (map)

        The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.

        Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

        • Metric — required — (map)

          The metric to return, including the metric name, namespace, and dimensions.

          • Namespace — (String)

            The namespace of the metric.

          • MetricName — (String)

            The name of the metric. This is a required field.

          • Dimensions — (Array<map>)

            The dimensions for the metric.

            • Name — required — (String)

              The name of the dimension.

            • Value — required — (String)

              The value representing the dimension measurement.

        • Period — required — (Integer)

          The period, in seconds, to use when retrieving the metric.

        • Stat — required — (String)

          The statistic to return. It can include any CloudWatch statistic or extended statistic.

        • Unit — (String)

          The unit to use for the returned data points.

          Possible values include:
          • "Seconds"
          • "Microseconds"
          • "Milliseconds"
          • "Bytes"
          • "Kilobytes"
          • "Megabytes"
          • "Gigabytes"
          • "Terabytes"
          • "Bits"
          • "Kilobits"
          • "Megabits"
          • "Gigabits"
          • "Terabits"
          • "Percent"
          • "Count"
          • "Bytes/Second"
          • "Kilobytes/Second"
          • "Megabytes/Second"
          • "Gigabytes/Second"
          • "Terabytes/Second"
          • "Bits/Second"
          • "Kilobits/Second"
          • "Megabits/Second"
          • "Gigabits/Second"
          • "Terabits/Second"
          • "Count/Second"
          • "None"
      • Expression — (String)

        The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

        Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

      • Label — (String)

        A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.

      • ReturnData — (Boolean)

        When used in GetMetricData, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False. If you omit this, the default of True is used.

        When used in PutMetricAlarm, specify True for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

    • Tags — (Array<map>)

      A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.

      • Key — required — (String)

        A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.

      • Value — required — (String)

        The value for the specified tag key.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putMetricData(params = {}, callback) ⇒ AWS.Request

Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.

You can publish either individual data points in the Value field, or arrays of values and the number of times each value occurred during the period by using the Values and Counts fields in the MetricDatum structure. Using the Values and Counts method enables you to publish up to 150 values per metric with one PutMetricData request, and supports retrieving percentile statistics on this data.

Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 20 different metrics.

Although the Value parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted.

CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

  • The SampleCount value of the statistic set is 1 and Min, Max, and Sum are all equal.

  • The Min and Max are equal, and Sum is equal to Min multiplied by SampleCount.

Service Reference:

Examples:

Calling the putMetricData operation

var params = {
  MetricData: [ /* required */
    {
      MetricName: 'STRING_VALUE', /* required */
      Counts: [
        'NUMBER_VALUE',
        /* more items */
      ],
      Dimensions: [
        {
          Name: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      StatisticValues: {
        Maximum: 'NUMBER_VALUE', /* required */
        Minimum: 'NUMBER_VALUE', /* required */
        SampleCount: 'NUMBER_VALUE', /* required */
        Sum: 'NUMBER_VALUE' /* required */
      },
      StorageResolution: 'NUMBER_VALUE',
      Timestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
      Unit: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None,
      Value: 'NUMBER_VALUE',
      Values: [
        'NUMBER_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Namespace: 'STRING_VALUE' /* required */
};
cloudwatch.putMetricData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Namespace — (String)

      The namespace for the metric data.

      You cannot specify a namespace that begins with "AWS/". Namespaces that begin with "AWS/" are reserved for use by Amazon Web Services products.

    • MetricData — (Array<map>)

      The data for the metric. The array can include no more than 20 metrics per call.

      • MetricName — required — (String)

        The name of the metric.

      • Dimensions — (Array<map>)

        The dimensions associated with the metric.

        • Name — required — (String)

          The name of the dimension.

        • Value — required — (String)

          The value representing the dimension measurement.

      • Timestamp — (Date)

        The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

      • Value — (Float)

        The value for the metric.

        Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

      • StatisticValues — (map)

        The statistical values for the metric.

        • SampleCount — required — (Float)

          The number of samples used for the statistic set.

        • Sum — required — (Float)

          The sum of values for the sample set.

        • Minimum — required — (Float)

          The minimum value of the sample set.

        • Maximum — required — (Float)

          The maximum value of the sample set.

      • Values — (Array<Float>)

        Array of numbers representing the values for the metric during the period. Each unique value is listed just once in this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period. You can include up to 150 unique values in each PutMetricData action that specifies a Values array.

        Although the Values array accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

      • Counts — (Array<Float>)

        Array of numbers that is used along with the Values array. Each number in the Count array is the number of times the corresponding value in the Values array occurred during the period.

        If you omit the Counts array, the default of 1 is used as the value for each count. If you include a Counts array, it must include the same amount of values as the Values array.

      • Unit — (String)

        The unit of the metric.

        Possible values include:
        • "Seconds"
        • "Microseconds"
        • "Milliseconds"
        • "Bytes"
        • "Kilobytes"
        • "Megabytes"
        • "Gigabytes"
        • "Terabytes"
        • "Bits"
        • "Kilobits"
        • "Megabits"
        • "Gigabits"
        • "Terabits"
        • "Percent"
        • "Count"
        • "Bytes/Second"
        • "Kilobytes/Second"
        • "Megabytes/Second"
        • "Gigabytes/Second"
        • "Terabytes/Second"
        • "Bits/Second"
        • "Kilobits/Second"
        • "Megabits/Second"
        • "Gigabits/Second"
        • "Terabits/Second"
        • "Count/Second"
        • "None"
      • StorageResolution — (Integer)

        Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide.

        This field is optional, if you do not specify it the default of 60 is used.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

setAlarmState(params = {}, callback) ⇒ AWS.Request

Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

Service Reference:

Examples:

Calling the setAlarmState operation

var params = {
  AlarmName: 'STRING_VALUE', /* required */
  StateReason: 'STRING_VALUE', /* required */
  StateValue: OK | ALARM | INSUFFICIENT_DATA, /* required */
  StateReasonData: 'STRING_VALUE'
};
cloudwatch.setAlarmState(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AlarmName — (String)

      The name for the alarm. This name must be unique within the AWS account. The maximum length is 255 characters.

    • StateValue — (String)

      The value of the state.

      Possible values include:
      • "OK"
      • "ALARM"
      • "INSUFFICIENT_DATA"
    • StateReason — (String)

      The reason that this alarm is set to this specific state, in text format.

    • StateReasonData — (String)

      The reason that this alarm is set to this specific state, in JSON format.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. In CloudWatch, alarms can be tagged.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
cloudwatch.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceARN — (String)

      The ARN of the CloudWatch resource that you're adding tags to. For more information on ARN format, see Example ARNs in the Amazon Web Services General Reference.

    • Tags — (Array<map>)

      The list of key-value pairs to associate with the resource.

      • Key — required — (String)

        A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.

      • Value — required — (String)

        The value for the specified tag key.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes one or more tags from the specified resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
cloudwatch.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceARN — (String)

      The ARN of the CloudWatch resource that you're removing tags from. For more information on ARN format, see Example ARNs in the Amazon Web Services General Reference.

    • TagKeys — (Array<String>)

      The list of tag keys to remove from the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given CloudWatch resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the alarmExists state

var params = {
  // ... input parameters ...
};
cloudwatch.waitFor('alarmExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String) —

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {}) —

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

Waiter Resource Details

cloudwatch.waitFor('alarmExists', params = {}, [callback]) ⇒ AWS.Request

Waits for the alarmExists state by periodically calling the underlying CloudWatch.describeAlarms() operation every 5 seconds (at most 40 times).

Examples:

Waiting for the alarmExists state

var params = {
  // ... input parameters ...
};
cloudwatch.waitFor('alarmExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • AlarmNames — (Array<String>)

      The names of the alarms.

    • AlarmNamePrefix — (String)

      The alarm name prefix. If this parameter is specified, you cannot specify AlarmNames.

    • StateValue — (String)

      The state value to be used in matching alarms.

      Possible values include:
      • "OK"
      • "ALARM"
      • "INSUFFICIENT_DATA"
    • ActionPrefix — (String)

      The action name prefix.

    • MaxRecords — (Integer)

      The maximum number of alarm descriptions to retrieve.

    • NextToken — (String)

      The token returned by a previous call to indicate that there is more data available.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MetricAlarms — (Array<map>)

        The information for the specified alarms.

        • AlarmName — (String)

          The name of the alarm.

        • AlarmArn — (String)

          The Amazon Resource Name (ARN) of the alarm.

        • AlarmDescription — (String)

          The description of the alarm.

        • AlarmConfigurationUpdatedTimestamp — (Date)

          The time stamp of the last update to the alarm configuration.

        • ActionsEnabled — (Boolean)

          Indicates whether actions should be executed during any changes to the alarm state.

        • OKActions — (Array<String>)

          The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        • AlarmActions — (Array<String>)

          The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        • InsufficientDataActions — (Array<String>)

          The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

        • StateValue — (String)

          The state value for the alarm.

          Possible values include:
          • "OK"
          • "ALARM"
          • "INSUFFICIENT_DATA"
        • StateReason — (String)

          An explanation for the alarm state, in text format.

        • StateReasonData — (String)

          An explanation for the alarm state, in JSON format.

        • StateUpdatedTimestamp — (Date)

          The time stamp of the last update to the alarm state.

        • MetricName — (String)

          The name of the metric associated with the alarm.

        • Namespace — (String)

          The namespace of the metric associated with the alarm.

        • Statistic — (String)

          The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

          Possible values include:
          • "SampleCount"
          • "Average"
          • "Sum"
          • "Minimum"
          • "Maximum"
        • ExtendedStatistic — (String)

          The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

        • Dimensions — (Array<map>)

          The dimensions for the metric associated with the alarm.

          • Name — required — (String)

            The name of the dimension.

          • Value — required — (String)

            The value representing the dimension measurement.

        • Period — (Integer)

          The period, in seconds, over which the statistic is applied.

        • Unit — (String)

          The unit of the metric associated with the alarm.

          Possible values include:
          • "Seconds"
          • "Microseconds"
          • "Milliseconds"
          • "Bytes"
          • "Kilobytes"
          • "Megabytes"
          • "Gigabytes"
          • "Terabytes"
          • "Bits"
          • "Kilobits"
          • "Megabits"
          • "Gigabits"
          • "Terabits"
          • "Percent"
          • "Count"
          • "Bytes/Second"
          • "Kilobytes/Second"
          • "Megabytes/Second"
          • "Gigabytes/Second"
          • "Terabytes/Second"
          • "Bits/Second"
          • "Kilobits/Second"
          • "Megabits/Second"
          • "Gigabits/Second"
          • "Terabits/Second"
          • "Count/Second"
          • "None"
        • EvaluationPeriods — (Integer)

          The number of periods over which data is compared to the specified threshold.

        • DatapointsToAlarm — (Integer)

          The number of datapoints that must be breaching to trigger the alarm.

        • Threshold — (Float)

          The value to compare with the specified statistic.

        • ComparisonOperator — (String)

          The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

          Possible values include:
          • "GreaterThanOrEqualToThreshold"
          • "GreaterThanThreshold"
          • "LessThanThreshold"
          • "LessThanOrEqualToThreshold"
        • TreatMissingData — (String)

          Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.

        • EvaluateLowSampleCountPercentile — (String)

          Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

        • Metrics — (Array<map>)

          • Id — required — (String)

            A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

          • MetricStat — (map)

            The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.

            Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

            • Metric — required — (map)

              The metric to return, including the metric name, namespace, and dimensions.

              • Namespace — (String)

                The namespace of the metric.

              • MetricName — (String)

                The name of the metric. This is a required field.

              • Dimensions — (Array<map>)

                The dimensions for the metric.

                • Name — required — (String)

                  The name of the dimension.

                • Value — required — (String)

                  The value representing the dimension measurement.

            • Period — required — (Integer)

              The period, in seconds, to use when retrieving the metric.

            • Stat — required — (String)

              The statistic to return. It can include any CloudWatch statistic or extended statistic.

            • Unit — (String)

              The unit to use for the returned data points.

              Possible values include:
              • "Seconds"
              • "Microseconds"
              • "Milliseconds"
              • "Bytes"
              • "Kilobytes"
              • "Megabytes"
              • "Gigabytes"
              • "Terabytes"
              • "Bits"
              • "Kilobits"
              • "Megabits"
              • "Gigabits"
              • "Terabits"
              • "Percent"
              • "Count"
              • "Bytes/Second"
              • "Kilobytes/Second"
              • "Megabytes/Second"
              • "Gigabytes/Second"
              • "Terabytes/Second"
              • "Bits/Second"
              • "Kilobits/Second"
              • "Megabits/Second"
              • "Gigabits/Second"
              • "Terabits/Second"
              • "Count/Second"
              • "None"
          • Expression — (String)

            The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

            Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

          • Label — (String)

            A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.

          • ReturnData — (Boolean)

            When used in GetMetricData, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False. If you omit this, the default of True is used.

            When used in PutMetricAlarm, specify True for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

      • NextToken — (String)

        The token that marks the start of the next batch of returned results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also: