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.

Sending a Request Using CloudWatch

var cloudwatch = new AWS.CloudWatch();
cloudwatch.deleteAlarms(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 (collapse)

Property Summary (collapse)

Properties inherited from AWS.Service

apiVersions

Method Summary (collapse)

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.CloudWatch(options = {})

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

Property Details

(AWS.Endpoint) 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

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

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

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.

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

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.

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

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: 0,
  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.

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

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.

Examples:

Calling the describeAlarms operation

var params = {
  ActionPrefix: 'STRING_VALUE',
  AlarmNamePrefix: 'STRING_VALUE',
  AlarmNames: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxRecords: 0,
  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. You cannot specify AlarmNames if this parameter is specified.

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

          • Namerequired — (String)

            The name of the dimension.

          • Valuerequired — (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.

        • 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"
      • 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:

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

Retrieves the alarms for the specified metric. Specify a statistic, period, or unit to filter the results.

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: 0,
  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.

      • Namerequired — (String)

        The name of the dimension.

      • Valuerequired — (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.

          • Namerequired — (String)

            The name of the dimension.

          • Valuerequired — (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.

        • 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"

Returns:

  • (AWS.Request)

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

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

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.

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.

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

Enables the actions for the specified alarms.

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.

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

Gets statistics for the specified metric.

Amazon CloudWatch retains metric data as follows:

  • 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)

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

The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, Amazon 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. A period can be as short as one minute (60 seconds). Note that data points are not returned in chronological order.

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

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

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: 0, /* 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. CloudWatch treats each unique combination of dimensions as a separate metric. You can't retrieve statistics using combinations of dimensions that were not specially published. 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.

      • Namerequired — (String)

        The name of the dimension.

      • Valuerequired — (String)

        The value representing the dimension measurement.

    • StartTime — (Date)

      The time stamp that determines the first data point to return. Note that 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.

    • EndTime — (Date)

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

      The value specified is exclusive; results will 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. A period can be as short as one minute (60 seconds) and must be a multiple of 60. The default value is 60.

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

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

    • ExtendedStatistics — (Array<String>)

      The percentile statistics. Specify values between p0.0 and p100.

    • 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 the metric only ever reports one unit, specifying a unit has no effect.

      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.

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

List the specified metrics. You can use the returned metrics with 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 GetMetricStatistics.

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.

      • Namerequired — (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.

        • Dimensions — (Array<map>)

          The dimensions for the metric.

          • Namerequired — (String)

            The name of the dimension.

          • Valuerequired — (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.

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

Creates or updates an alarm and associates it with the specified metric. Optionally, this operation can associate one or more Amazon SNS resources with the alarm.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is evaluated and its state is set appropriately. Any actions associated with the 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 AWS Identity and Access Management (IAM) user, you must have Amazon EC2 permissions for some operations:

  • 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

  • ec2:DescribeInstanceRecoveryAttribute and ec2:RecoverInstances 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 won't be performed. However, if you are later granted the required permissions, the alarm actions that you created earlier will be performed.

If you are using an IAM role (for example, an Amazon 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 the AWS Security Token Service (AWS STS), you cannot stop or terminate an Amazon EC2 instance using alarm actions.

Note that you must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role. After this IAM role is created, you can create stop, terminate, or reboot alarms using a command-line interface or an API.

Examples:

Calling the putMetricAlarm operation

var params = {
  AlarmName: 'STRING_VALUE', /* required */
  ComparisonOperator: 'GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanThreshold | LessThanOrEqualToThreshold', /* required */
  EvaluationPeriods: 0, /* required */
  MetricName: 'STRING_VALUE', /* required */
  Namespace: 'STRING_VALUE', /* required */
  Period: 0, /* required */
  Threshold: 0.0, /* required */
  ActionsEnabled: true || false,
  AlarmActions: [
    'STRING_VALUE',
    /* more items */
  ],
  AlarmDescription: 'STRING_VALUE',
  Dimensions: [
    {
      Name: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  ExtendedStatistic: 'STRING_VALUE',
  InsufficientDataActions: [
    'STRING_VALUE',
    /* more items */
  ],
  OKActions: [
    'STRING_VALUE',
    /* more items */
  ],
  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.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 the AWS account.

    • AlarmDescription — (String)

      The description for the alarm.

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

      Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{<i>customer-account</i>}: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

      Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{<i>customer-account</i>}: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

      Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Reboot/1.0

    • MetricName — (String)

      The name for the metric associated with the alarm.

    • Namespace — (String)

      The namespace for 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.

      • Namerequired — (String)

        The name of the dimension.

      • Valuerequired — (String)

        The value representing the dimension measurement.

    • Period — (Integer)

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

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

    • 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"

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.

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

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

Each PutMetricData request is limited to 8 KB in size for HTTP GET requests and is limited to 40 KB in size for HTTP POST requests.

Although the Value parameter accepts numbers of type Double, Amazon 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 (e.g., NaN, +Infinity, -Infinity) are not supported.

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

Examples:

Calling the putMetricData operation

var params = {
  MetricData: [ /* required */
    {
      MetricName: 'STRING_VALUE', /* required */
      Dimensions: [
        {
          Name: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      StatisticValues: {
        Maximum: 0.0, /* required */
        Minimum: 0.0, /* required */
        SampleCount: 0.0, /* required */
        Sum: 0.0 /* required */
      },
      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: 0.0
    },
    /* 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.

      • MetricNamerequired — (String)

        The name of the metric.

      • Dimensions — (Array<map>)

        The dimensions associated with the metric.

        • Namerequired — (String)

          The name of the dimension.

        • Valuerequired — (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, Amazon 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.

        • SampleCountrequired — (Float)

          The number of samples used for the statistic set.

        • Sumrequired — (Float)

          The sum of values for the sample set.

        • Minimumrequired — (Float)

          The minimum value of the sample set.

        • Maximumrequired — (Float)

          The maximum value of the sample set.

      • 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"

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.

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

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 Amazon SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state change happens very quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

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.

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

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. You cannot specify AlarmNames if this parameter is specified.

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

          • Namerequired — (String)

            The name of the dimension.

          • Valuerequired — (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.

        • 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"
      • 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: