Class: Aws::CloudWatch::Metric

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-cloudwatch/metric.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(namespace, name, options = {}) ⇒ Metric #initialize(options = {}) ⇒ Metric

Returns a new instance of Metric.

Overloads:

  • #initialize(namespace, name, options = {}) ⇒ Metric

    Parameters:

    • namespace (String)
    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Metric

    Options Hash (options):

    • :namespace (required, String)
    • :name (required, String)
    • :client (Client) 


24
25
26
27
28
29
30
31
 
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 24

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @namespace = extract_namespace(args, options)
  @name = extract_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#alarms(options = {}) ⇒ Alarm::Collection

Examples:

Request syntax with placeholder values


alarms = metric.alarms({
  statistic: "SampleCount", # accepts SampleCount, Average, Sum, Minimum, Maximum
  extended_statistic: "ExtendedStatistic",
  dimensions: [
    {
      name: "DimensionName", # required
      value: "DimensionValue", # required
    },
  ],
  period: 1,
  unit: "Seconds", # accepts 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
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :statistic (String) —

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

  • :extended_statistic (String) —

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

  • :dimensions (Array<Types::Dimension>) —

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

  • :period (Integer) —

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

  • :unit (String) —

    The unit for the metric.

Returns:



936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
 
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 936

def alarms(options = {})
  batches = Enumerator.new do |y|
    batch = []
    options = options.merge(
      namespace: @namespace,
      metric_name: @name
    )
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_alarms_for_metric(options)
    end
    resp.data.metric_alarms.each do |m|
      batch << Alarm.new(
        name: m.alarm_name,
        data: m,
        client: @client
      )
    end
    y.yield(batch)
  end
  Alarm::Collection.new(batches)
end

#client ⇒ Client

Returns:



55
56
57
 
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 55

def client
  @client
end

#data ⇒ Types::Metric

Returns the data for this Aws::CloudWatch::Metric. Calls Client#list_metrics if #data_loaded? is ‘false`.

Returns:



80
81
82
83
 
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 80

def data
  load unless @data
  @data
end

#data_loaded? ⇒ Boolean

Returns ‘true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean) —

    Returns ‘true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



88
89
90
 
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 88

def data_loaded?
  !!@data
end

#dimensions ⇒ Array<Types::Dimension>

The dimensions for the metric.

Returns:



48
49
50
 
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 48

def dimensions
  data[:dimensions]
end

#get_statistics(options = {}) ⇒ Types::GetMetricStatisticsOutput

Examples:

Request syntax with placeholder values


metric.get_statistics({
  dimensions: [
    {
      name: "DimensionName", # required
      value: "DimensionValue", # required
    },
  ],
  start_time: Time.now, # required
  end_time: Time.now, # required
  period: 1, # required
  statistics: ["SampleCount"], # accepts SampleCount, Average, Sum, Minimum, Maximum
  extended_statistics: ["ExtendedStatistic"],
  unit: "Seconds", # accepts 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
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :dimensions (Array<Types::Dimension>) —

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

    [1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#dimension-combinations [2]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html

  • :start_time (required, Time, DateTime, Date, Integer, String) —

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

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

    CloudWatch rounds the specified time stamp as follows:

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

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

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

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

  • :end_time (required, Time, DateTime, Date, Integer, String) —

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

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

  • :period (required, Integer) —

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

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

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

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

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

  • :statistics (Array<String>) —

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

  • :extended_statistics (Array<String>) —

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

  • :unit (String) —

    The unit for a given metric. If you omit ‘Unit`, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Returns:



302
303
304
305
306
307
308
309
310
311
 
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 302

def get_statistics(options = {})
  options = options.merge(
    namespace: @namespace,
    metric_name: @name
  )
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.get_metric_statistics(options)
  end
  resp.data
end

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


960
961
962
963
964
965
 
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 960

def identifiers
  {
    namespace: @namespace,
    name: @name
  }
end

#load ⇒ self Also known as: reload

Loads, or reloads #data for the current Aws::CloudWatch::Metric. Returns ‘self` making it possible to chain methods.

metric.reload.data

Returns:

  • (self) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 65

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.list_metrics(
    metric_name: @name,
    namespace: @namespace
  )
  end
  @data = resp.metrics[0]
  self
end

#name ⇒ String Also known as: metric_name

Returns:

  • (String) 


41
42
43
 
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 41

def name
  @name
end

#namespace ⇒ String

Returns:

  • (String) 


36
37
38
 
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 36

def namespace
  @namespace
end

#put_alarm(options = {}) ⇒ Alarm

Examples:

Request syntax with placeholder values


alarm = metric.put_alarm({
  alarm_name: "AlarmName", # required
  alarm_description: "AlarmDescription",
  actions_enabled: false,
  ok_actions: ["ResourceName"],
  alarm_actions: ["ResourceName"],
  insufficient_data_actions: ["ResourceName"],
  statistic: "SampleCount", # accepts SampleCount, Average, Sum, Minimum, Maximum
  extended_statistic: "ExtendedStatistic",
  dimensions: [
    {
      name: "DimensionName", # required
      value: "DimensionValue", # required
    },
  ],
  period: 1,
  unit: "Seconds", # accepts 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
  evaluation_periods: 1, # required
  datapoints_to_alarm: 1,
  threshold: 1.0,
  comparison_operator: "GreaterThanOrEqualToThreshold", # required, accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold, LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, GreaterThanUpperThreshold
  treat_missing_data: "TreatMissingData",
  evaluate_low_sample_count_percentile: "EvaluateLowSampleCountPercentile",
  metrics: [
    {
      id: "MetricId", # required
      metric_stat: {
        metric: { # required
          namespace: "Namespace",
          metric_name: "MetricName",
          dimensions: [
            {
              name: "DimensionName", # required
              value: "DimensionValue", # required
            },
          ],
        },
        period: 1, # required
        stat: "Stat", # required
        unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
      },
      expression: "MetricExpression",
      label: "MetricLabel",
      return_data: false,
      period: 1,
      account_id: "AccountId",
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  threshold_metric_id: "MetricId",
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :alarm_name (required, String) —

    The name for the alarm. This name must be unique within the Region.

    The name must contain only UTF-8 characters, and can’t contain ASCII control characters

  • :alarm_description (String) —

    The description for the alarm.

  • :actions_enabled (Boolean) —

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

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

    **EC2 actions:**

    • ‘arn:aws:automate:region:ec2:stop`

    • ‘arn:aws:automate:region:ec2:terminate`

    • ‘arn:aws:automate:region:ec2:reboot`

    • ‘arn:aws:automate:region:ec2:recover`

    • ‘arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0`

    • ‘arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0`

    • ‘arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0`

    • ‘arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0`

    **Autoscaling action:**

    • ‘arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name `

    ^

    **Lambda actions:**

    • Invoke the latest version of a Lambda function: ‘arn:aws:lambda:region:account-id:function:function-name `

    • Invoke a specific version of a Lambda function: ‘arn:aws:lambda:region:account-id:function:function-name:version-number `

    • Invoke a function by using an alias Lambda function: ‘arn:aws:lambda:region:account-id:function:function-name:alias-name `

    **SNS notification action:**

    • ‘arn:aws:sns:region:account-id:sns-topic-name `

    ^

    **SSM integration actions:**

    • ‘arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name `

    • ‘arn:aws:ssm-incidents::account-id:responseplan/response-plan-name `

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

    **EC2 actions:**

    • ‘arn:aws:automate:region:ec2:stop`

    • ‘arn:aws:automate:region:ec2:terminate`

    • ‘arn:aws:automate:region:ec2:reboot`

    • ‘arn:aws:automate:region:ec2:recover`

    • ‘arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0`

    • ‘arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0`

    • ‘arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0`

    • ‘arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0`

    **Autoscaling action:**

    • ‘arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name `

    ^

    **Lambda actions:**

    • Invoke the latest version of a Lambda function: ‘arn:aws:lambda:region:account-id:function:function-name `

    • Invoke a specific version of a Lambda function: ‘arn:aws:lambda:region:account-id:function:function-name:version-number `

    • Invoke a function by using an alias Lambda function: ‘arn:aws:lambda:region:account-id:function:function-name:alias-name `

    **SNS notification action:**

    • ‘arn:aws:sns:region:account-id:sns-topic-name `

    ^

    **SSM integration actions:**

    • ‘arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name `

    • ‘arn:aws:ssm-incidents::account-id:responseplan/response-plan-name `

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

    **EC2 actions:**

    • ‘arn:aws:automate:region:ec2:stop`

    • ‘arn:aws:automate:region:ec2:terminate`

    • ‘arn:aws:automate:region:ec2:reboot`

    • ‘arn:aws:automate:region:ec2:recover`

    • ‘arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0`

    • ‘arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0`

    • ‘arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0`

    • ‘arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0`

    **Autoscaling action:**

    • ‘arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name `

    ^

    **Lambda actions:**

    • Invoke the latest version of a Lambda function: ‘arn:aws:lambda:region:account-id:function:function-name `

    • Invoke a specific version of a Lambda function: ‘arn:aws:lambda:region:account-id:function:function-name:version-number `

    • Invoke a function by using an alias Lambda function: ‘arn:aws:lambda:region:account-id:function:function-name:alias-name `

    **SNS notification action:**

    • ‘arn:aws:sns:region:account-id:sns-topic-name `

    ^

    **SSM integration actions:**

    • ‘arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name `

    • ‘arn:aws:ssm-incidents::account-id:responseplan/response-plan-name `

  • :statistic (String) —

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

  • :extended_statistic (String) —

    The extended statistic for the metric specified in ‘MetricName`. When you call `PutMetricAlarm` and specify a `MetricName`, you must specify either `Statistic` or `ExtendedStatistic` but not both.

    If you specify ‘ExtendedStatistic`, the following are valid values:

    • ‘p90`

    • ‘tm90`

    • ‘tc90`

    • ‘ts90`

    • ‘wm90`

    • ‘IQM`

    • ‘PR(n:m)` where n and m are values of the metric

    • ‘TC(X%:X%)` where X is between 10 and 90 inclusive.

    • ‘TM(X%:X%)` where X is between 10 and 90 inclusive.

    • ‘TS(X%:X%)` where X is between 10 and 90 inclusive.

    • ‘WM(X%:X%)` where X is between 10 and 90 inclusive.

    For more information about these extended statistics, see [CloudWatch statistics definitions].

    [1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html

  • :dimensions (Array<Types::Dimension>) —

    The dimensions for the metric specified in ‘MetricName`.

  • :period (Integer) —

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

    ‘Period` is required for alarms based on static thresholds. If you are creating an alarm based on a metric math expression, you specify the period for each metric within the objects in the `Metrics` array.

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

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

    [1]: aws.amazon.com/cloudwatch/pricing/

  • :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 are creating an alarm based on a metric math expression, you can specify the unit for each metric (if needed) within the objects in the ‘Metrics` array.

    If you don’t specify ‘Unit`, CloudWatch retrieves all unit types that have been published for the metric and attempts to evaluate the alarm. Usually, metrics are published with only one unit, so the alarm works as intended.

    However, if the metric is published with multiple types of units and you don’t specify a unit, the alarm’s behavior is not defined and it behaves unpredictably.

    We recommend omitting ‘Unit` so that you don’t inadvertently specify an incorrect unit that is not published for this metric. Doing so causes the alarm to be stuck in the ‘INSUFFICIENT DATA` state.

  • :evaluation_periods (required, Integer) —

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

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

  • :datapoints_to_alarm (Integer) —

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

    [1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation

  • :threshold (Float) —

    The value against which the specified statistic is compared.

    This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.

  • :comparison_operator (required, String) —

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

    The values ‘LessThanLowerOrGreaterThanUpperThreshold`, `LessThanLowerThreshold`, and `GreaterThanUpperThreshold` are used only for alarms based on anomaly detection models.

  • :treat_missing_data (String) —

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

    Valid Values: ‘breaching | notBreaching | ignore | missing`

    <note markdown=“1”> Alarms that evaluate metrics in the ‘AWS/DynamoDB` namespace always `ignore` missing data even if you choose a different option for `TreatMissingData`. When an `AWS/DynamoDB` metric has missing data, alarms that evaluate that metric remain in their current state.

    </note>

    [1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data

  • :evaluate_low_sample_count_percentile (String) —

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

    Valid Values: ‘evaluate | ignore`

    [1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples

  • :metrics (Array<Types::MetricDataQuery>) —

    An array of ‘MetricDataQuery` structures that enable you to create an alarm based on the result of a metric math expression. For each `PutMetricAlarm` operation, you must specify either `MetricName` or a `Metrics` array.

    Each item in the ‘Metrics` array either retrieves a metric or performs a math expression.

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

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

    [1]: docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html

  • :tags (Array<Types::Tag>) —

    A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the ‘cloudwatch:TagResource` permission.

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

    If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use [TagResource] or [UntagResource].

    To use this field to set tags for an alarm when you create it, you must be signed on with both the ‘cloudwatch:PutMetricAlarm` and `cloudwatch:TagResource` permissions.

    [1]: docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html [2]: docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html

  • :threshold_metric_id (String) —

    If this is an alarm based on an anomaly detection model, make this value match the ID of the ‘ANOMALY_DETECTION_BAND` function.

    For an example of how to use this parameter, see the **Anomaly Detection Model Alarm** example on this page.

    If your alarm uses this parameter, it cannot have Auto Scaling actions.

Returns:



758
759
760
761
762
763
764
765
766
767
768
769
770
 
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 758

def put_alarm(options = {})
  options = options.merge(
    namespace: @namespace,
    metric_name: @name
  )
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.put_metric_alarm(options)
  end
  Alarm.new(
    name: options[:alarm_name],
    client: @client
  )
end

#put_data(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


metric.put_data({
  metric_data: [
    {
      metric_name: "MetricName", # required
      dimensions: [
        {
          name: "DimensionName", # required
          value: "DimensionValue", # required
        },
      ],
      timestamp: Time.now,
      value: 1.0,
      statistic_values: {
        sample_count: 1.0, # required
        sum: 1.0, # required
        minimum: 1.0, # required
        maximum: 1.0, # required
      },
      values: [1.0],
      counts: [1.0],
      unit: "Seconds", # accepts 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
      storage_resolution: 1,
    },
  ],
  entity_metric_data: [
    {
      entity: {
        key_attributes: {
          "EntityKeyAttributesMapKeyString" => "EntityKeyAttributesMapValueString",
        },
        attributes: {
          "EntityAttributesMapKeyString" => "EntityAttributesMapValueString",
        },
      },
      metric_data: [
        {
          metric_name: "MetricName", # required
          dimensions: [
            {
              name: "DimensionName", # required
              value: "DimensionValue", # required
            },
          ],
          timestamp: Time.now,
          value: 1.0,
          statistic_values: {
            sample_count: 1.0, # required
            sum: 1.0, # required
            minimum: 1.0, # required
            maximum: 1.0, # required
          },
          values: [1.0],
          counts: [1.0],
          unit: "Seconds", # accepts 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
          storage_resolution: 1,
        },
      ],
    },
  ],
  strict_entity_validation: false,
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :metric_data (Array<Types::MetricDatum>) —

    The data for the metrics. Use this parameter if your metrics do not contain associated entities. The array can include no more than 1000 metrics per call.

    The limit of metrics allowed, 1000, is the sum of both ‘EntityMetricData` and `MetricData` metrics.

  • :entity_metric_data (Array<Types::EntityMetricData>) —

    Data for metrics that contain associated entity information. You can include up to two ‘EntityMetricData` objects, each of which can contain a single `Entity` and associated metrics.

    The limit of metrics allowed, 1000, is the sum of both ‘EntityMetricData` and `MetricData` metrics.

  • :strict_entity_validation (Boolean) —

    Whether to accept valid metric data when an invalid entity is sent.

    • When set to ‘true`: Any validation error (for entity or metric data) will fail the entire request, and no data will be ingested. The failed operation will return a 400 result with the error.

    • When set to ‘false`: Validation errors in the entity will not associate the metric with the entity, but the metric data will still be accepted and ingested. Validation errors in the metric data will fail the entire request, and no data will be ingested.

      In the case of an invalid entity, the operation will return a ‘200` status, but an additional response header will contain information about the validation errors. The new header, `X-Amzn-Failure-Message` is an enumeration of the following values:

      • ‘InvalidEntity` - The provided entity is invalid.

      • ‘InvalidKeyAttributes` - The provided `KeyAttributes` of an entity is invalid.

      • ‘InvalidAttributes` - The provided `Attributes` of an entity is invalid.

      • ‘InvalidTypeValue` - The provided `Type` in the `KeyAttributes` of an entity is invalid.

      • ‘EntitySizeTooLarge` - The number of `EntityMetricData` objects allowed is 2.

      • ‘MissingRequiredFields` - There are missing required fields in the `KeyAttributes` for the provided `Type`.

      For details of the requirements for specifying an entity, see [How to add related information to telemetry] in the *CloudWatch User Guide*.

    This parameter is required when ‘EntityMetricData` is included.

    [1]: docs.aws.amazon.com/adding-your-own-related-telemetry.html

Returns:

  • (EmptyStructure) 


893
894
895
896
897
898
899
900
901
902
 
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 893

def put_data(options = {})
  options = Aws::Util.deep_merge(options,
    namespace: @namespace,
    metric_data: [{ metric_name: @name }]
  )
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.put_metric_data(options)
  end
  resp.data
end

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Deprecated.

Use [Aws::CloudWatch::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged.

Waiter polls an API operation until a resource enters a desired state.

## Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

## Example

instance.wait_until(max_attempts:10, delay:5) do |instance|
  instance.state.name == 'running'
end

## Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

## Callbacks

You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

## Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10 —

    Maximum number of

  • :delay (Integer) — default: 10 —

    Delay between each

  • :before_attempt (Proc) — default: nil —

    Callback

  • :before_wait (Proc) — default: nil —

    Callback

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

Returns:

  • (Resource) —

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError) —

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError) —

    Raised when the resource does not



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/aws-sdk-cloudwatch/metric.rb', line 172

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end