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

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, 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.

  • 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

endpointAWS.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 all 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>)

      A list of 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.

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

Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms.

Note: Amazon CloudWatch retains the history of an alarm for two weeks, whether or not 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>)

        A list of 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 human-readable summary of the alarm history.

        • HistoryData — (String)

          Machine-readable data about the alarm in JSON format.

      • NextToken — (String)

        A string 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 alarms with the specified names. If no name is specified, all alarms for the user 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>)

      A list of alarm names to retrieve information for.

    • AlarmNamePrefix — (String)

      The alarm name prefix. AlarmNames cannot be specified 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>)

        A list of 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 for 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's state.

        • OKActions — (Array<String>)

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

        • AlarmActions — (Array<String>)

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

        • InsufficientDataActions — (Array<String>)

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

          The current WSDL lists this attribute as UnknownActions.
        • StateValue — (String)

          The state value for the alarm.

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

          A human-readable explanation for the alarm's state.

        • StateReasonData — (String)

          An explanation for the alarm's state in machine-readable JSON format

        • StateUpdatedTimestamp — (Date)

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

        • MetricName — (String)

          The name of the alarm's metric.

        • Namespace — (String)

          The namespace of alarm's associated metric.

        • Statistic — (String)

          The statistic to apply to the alarm's associated metric.

          Possible values include:
          • "SampleCount"
          • "Average"
          • "Sum"
          • "Minimum"
          • "Maximum"
        • Dimensions — (Array<map>)

          The list of dimensions associated with the alarm's associated metric.

          • 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 alarm's associated 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"
        • 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"
      • NextToken — (String)

        A string 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.

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

Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further.

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 */
  ],
  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.

      Possible values include:
      • "SampleCount"
      • "Average"
      • "Sum"
      • "Minimum"
      • "Maximum"
    • Dimensions — (Array<map>)

      The list of dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the DescribeAlarmsForMetric 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>)

        A list of 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 for 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's state.

        • OKActions — (Array<String>)

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

        • AlarmActions — (Array<String>)

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

        • InsufficientDataActions — (Array<String>)

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

          The current WSDL lists this attribute as UnknownActions.
        • StateValue — (String)

          The state value for the alarm.

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

          A human-readable explanation for the alarm's state.

        • StateReasonData — (String)

          An explanation for the alarm's state in machine-readable JSON format

        • StateUpdatedTimestamp — (Date)

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

        • MetricName — (String)

          The name of the alarm's metric.

        • Namespace — (String)

          The namespace of alarm's associated metric.

        • Statistic — (String)

          The statistic to apply to the alarm's associated metric.

          Possible values include:
          • "SampleCount"
          • "Average"
          • "Sum"
          • "Minimum"
          • "Maximum"
        • Dimensions — (Array<map>)

          The list of dimensions associated with the alarm's associated metric.

          • 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 alarm's associated 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"
        • 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"

Returns:

  • (AWS.Request)

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

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

Disables actions for the specified alarms. When an alarm's actions are disabled the alarm's state may change, but none of the alarm's actions will execute.

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 to disable actions for.

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 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 to enable actions for.

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.

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

Gets statistics for the specified metric.

The maximum number of data points that can be queried is 50,850, whereas the maximum number of data points returned from a single GetMetricStatistics request is 1,440. If you make a request that generates more than 1,440 data points, Amazon CloudWatch returns an error. In such a case, you can alter the request by narrowing the specified time range or increasing the specified period. Alternatively, you can make multiple requests across adjacent time ranges. GetMetricStatistics does not return the data 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-minute granularity, Amazon CloudWatch aggregates data points with time stamps that fall within the same one-minute period. In such a case, the data points queried can greatly outnumber the data points returned.

The following examples show various statistics allowed by the data point query maximum of 50,850 when you call GetMetricStatistics on Amazon EC2 instances with detailed (one-minute) monitoring enabled:

  • Statistics for up to 400 instances for a span of one hour
  • Statistics for up to 35 instances over a span of 24 hours
  • Statistics for up to 2 instances over a span of 2 weeks

For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to CloudWatch, go to Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference in the Amazon CloudWatch Developer 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 */
  Statistics: [ /* required */
    'SampleCount | Average | Sum | Minimum | Maximum',
    /* more items */
  ],
  Dimensions: [
    {
      Name: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* 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>)

      A list of dimensions describing qualities of the metric.

      • Namerequired — (String)

        The name of the dimension.

      • Valuerequired — (String)

        The value representing the dimension measurement

    • StartTime — (Date)

      The time stamp to use for determining the first datapoint to return. The value specified is inclusive; results include datapoints with the time stamp specified. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).

      Note: The specified start time is rounded down to the nearest value. Datapoints are returned for start times up to two weeks in the past. Specified start times that are more than two weeks in the past will not return datapoints for metrics that are older than two weeks. Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using GetMetricStatistics.
    • EndTime — (Date)

      The time stamp to use for determining the last datapoint to return. The value specified is exclusive; results will include datapoints up to the time stamp specified. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).

    • Period — (Integer)

      The granularity, in seconds, of the returned datapoints. Period must be at least 60 seconds and must be a multiple of 60. The default value is 60.

    • Statistics — (Array<String>)

      The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.

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

      • Label — (String)

        A label describing the specified metric.

      • Datapoints — (Array<map>)

        The datapoints for the specified metric.

        • Timestamp — (Date)

          The time stamp used for the datapoint.

        • SampleCount — (Float)

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

        • Average — (Float)

          The average of metric values that correspond to the datapoint.

        • Sum — (Float)

          The sum of metric values used for the datapoint.

        • Minimum — (Float)

          The minimum metric value used for the datapoint.

        • Maximum — (Float)

          The maximum of the metric value used for the datapoint.

        • Unit — (String)

          The standard unit used for the datapoint.

          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"

Returns:

  • (AWS.Request)

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

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

Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with GetMetricStatistics to obtain statistical data for a given metric.

Note: Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations.
Note: If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action. 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>)

      A list of dimensions to filter against.

      • Namerequired — (String)

        The dimension name to be matched.

      • Value — (String)

        The value of the dimension to be matched.

        Note: Specifying a Name without specifying a Value returns all values associated with that Name.
    • 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>)

        A list of metrics used to generate statistics for an AWS account.

        • Namespace — (String)

          The namespace of the metric.

        • MetricName — (String)

          The name of the metric.

        • Dimensions — (Array<map>)

          A list of dimensions associated with the metric.

          • Namerequired — (String)

            The name of the dimension.

          • Valuerequired — (String)

            The value representing the dimension measurement

      • NextToken — (String)

        A string 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.

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

Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service 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 StateValue is set appropriately. Any actions associated with the StateValue is then executed.

Note: When updating an existing alarm, its StateValue is left unchanged.
Note: If you are using an AWS Identity and Access Management (IAM) account to create or modify an alarm, you must have the following Amazon EC2 permissions:
  • ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on Amazon 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 on the Amazon EC2 instance. However, if you are later granted permission to use the associated Amazon EC2 APIs, the alarm actions you created earlier will be performed. For more information about IAM permissions, see Permissions and Policies in Using IAM. If you are using an IAM role (e.g., 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.

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 */
  Statistic: 'SampleCount | Average | Sum | Minimum | Maximum', /* 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 */
  ],
  InsufficientDataActions: [
    'STRING_VALUE',
    /* more items */
  ],
  OKActions: [
    'STRING_VALUE',
    /* 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.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 descriptive name for the alarm. This name must be unique within the user's AWS account

    • AlarmDescription — (String)

      The description for the alarm.

    • ActionsEnabled — (Boolean)

      Indicates whether or not actions should be executed during any changes to the alarm's state.

    • OKActions — (Array<String>)

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

      Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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

      Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.

    • AlarmActions — (Array<String>)

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

      Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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

      Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.

    • InsufficientDataActions — (Array<String>)

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

      Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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

      Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.

    • MetricName — (String)

      The name for the alarm's associated metric.

    • Namespace — (String)

      The namespace for the alarm's associated metric.

    • Statistic — (String)

      The statistic to apply to the alarm's associated metric.

      Possible values include:
      • "SampleCount"
      • "Average"
      • "Sum"
      • "Minimum"
      • "Maximum"
    • Dimensions — (Array<map>)

      The dimensions for the alarm's associated metric.

      • 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 statistic's unit of measure. 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.

      Note: If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to 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.

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

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 the ListMetrics action.

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 that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using GetMetricStatistics.

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.

      Note: You cannot specify a namespace that begins with "AWS/". Namespaces that begin with "AWS/" are reserved for other Amazon Web Services products that send metrics to Amazon CloudWatch.
    • MetricData — (Array<map>)

      A list of data describing the metric.

      • MetricNamerequired — (String)

        The name of the metric.

      • Dimensions — (Array<map>)

        A list of dimensions associated with the metric. Note, when using the Dimensions value in a query, you need to append .member.N to it (e.g., Dimensions.member.N).

        • Namerequired — (String)

          The name of the dimension.

        • Valuerequired — (String)

          The value representing the dimension measurement

      • Timestamp — (Date)

        The time stamp used for the metric in ISO 8601 Universal Coordinated Time (UTC) format. If not specified, the default value is set to the time the metric data was received.

      • Value — (Float)

        The value for the metric.

        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.
      • StatisticValues — (map)

        A set of statistical values describing 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.

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

Temporarily sets the state of an alarm. When the updated StateValue 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's state to ALARM will send an Amazon SNS message. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state. Because the alarm state change happens very quickly, it is typically only visibile 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 descriptive name for the alarm. This name must be unique within the user's 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 human-readable text format)

    • StateReasonData — (String)

      The reason that this alarm is set to this specific state (in machine-readable 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.