class Aws::Lightsail::Types::GetInstanceMetricDataRequest

@note When making an API call, you may pass GetInstanceMetricDataRequest

data as a hash:

    {
      instance_name: "ResourceName", # required
      metric_name: "CPUUtilization", # required, accepts CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, StatusCheckFailed_System, BurstCapacityTime, BurstCapacityPercentage
      period: 1, # required
      start_time: Time.now, # required
      end_time: Time.now, # required
      unit: "Seconds", # required, 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
      statistics: ["Minimum"], # required, accepts Minimum, Maximum, Sum, Average, SampleCount
    }

@!attribute [rw] instance_name

The name of the instance for which you want to get metrics data.
@return [String]

@!attribute [rw] metric_name

The metric for which you want to return information.

Valid instance metric names are listed below, along with the most
useful `statistics` to include in your request, and the published
`unit` value.

* <b> <code>BurstCapacityPercentage</code> </b> - The percentage of
  CPU performance available for your instance to burst above its
  baseline. Your instance continuously accrues and consumes burst
  capacity. Burst capacity stops accruing when your instance's
  `BurstCapacityPercentage` reaches 100%. For more information, see
  [Viewing instance burst capacity in Amazon Lightsail][1].

  `Statistics`\: The most useful statistics are `Maximum` and
  `Average`.

  `Unit`\: The published unit is `Percent`.

* <b> <code>BurstCapacityTime</code> </b> - The available amount of
  time for your instance to burst at 100% CPU utilization. Your
  instance continuously accrues and consumes burst capacity. Burst
  capacity time stops accruing when your instance's
  `BurstCapacityPercentage` metric reaches 100%.

  Burst capacity time is consumed at the full rate only when your
  instance operates at 100% CPU utilization. For example, if your
  instance operates at 50% CPU utilization in the burstable zone for
  a 5-minute period, then it consumes CPU burst capacity minutes at
  a 50% rate in that period. Your instance consumed 2 minutes and 30
  seconds of CPU burst capacity minutes in the 5-minute period. For
  more information, see [Viewing instance burst capacity in Amazon
  Lightsail][1].

  `Statistics`\: The most useful statistics are `Maximum` and
  `Average`.

  `Unit`\: The published unit is `Seconds`.

* <b> <code>CPUUtilization</code> </b> - The percentage of allocated
  compute units that are currently in use on the instance. This
  metric identifies the processing power to run the applications on
  the instance. Tools in your operating system can show a lower
  percentage than Lightsail when the instance is not allocated a
  full processor core.

  `Statistics`\: The most useful statistics are `Maximum` and
  `Average`.

  `Unit`\: The published unit is `Percent`.

* <b> <code>NetworkIn</code> </b> - The number of bytes received on
  all network interfaces by the instance. This metric identifies the
  volume of incoming network traffic to the instance. The number
  reported is the number of bytes received during the period.
  Because this metric is reported in 5-minute intervals, divide the
  reported number by 300 to find Bytes/second.

  `Statistics`\: The most useful statistic is `Sum`.

  `Unit`\: The published unit is `Bytes`.

* <b> <code>NetworkOut</code> </b> - The number of bytes sent out on
  all network interfaces by the instance. This metric identifies the
  volume of outgoing network traffic from the instance. The number
  reported is the number of bytes sent during the period. Because
  this metric is reported in 5-minute intervals, divide the reported
  number by 300 to find Bytes/second.

  `Statistics`\: The most useful statistic is `Sum`.

  `Unit`\: The published unit is `Bytes`.

* <b> <code>StatusCheckFailed</code> </b> - Reports whether the
  instance passed or failed both the instance status check and the
  system status check. This metric can be either 0 (passed) or 1
  (failed). This metric data is available in 1-minute (60 seconds)
  granularity.

  `Statistics`\: The most useful statistic is `Sum`.

  `Unit`\: The published unit is `Count`.

* <b> <code>StatusCheckFailed_Instance</code> </b> - Reports whether
  the instance passed or failed the instance status check. This
  metric can be either 0 (passed) or 1 (failed). This metric data is
  available in 1-minute (60 seconds) granularity.

  `Statistics`\: The most useful statistic is `Sum`.

  `Unit`\: The published unit is `Count`.

* <b> <code>StatusCheckFailed_System</code> </b> - Reports whether
  the instance passed or failed the system status check. This metric
  can be either 0 (passed) or 1 (failed). This metric data is
  available in 1-minute (60 seconds) granularity.

  `Statistics`\: The most useful statistic is `Sum`.

  `Unit`\: The published unit is `Count`.

[1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-burst-capacity
@return [String]

@!attribute [rw] period

The granularity, in seconds, of the returned data points.

The `StatusCheckFailed`, `StatusCheckFailed_Instance`, and
`StatusCheckFailed_System` instance metric data is available in
1-minute (60 seconds) granularity. All other instance metric data is
available in 5-minute (300 seconds) granularity.
@return [Integer]

@!attribute [rw] start_time

The start time of the time period.
@return [Time]

@!attribute [rw] end_time

The end time of the time period.
@return [Time]

@!attribute [rw] unit

The unit for the metric data request. Valid units depend on the
metric data being requested. For the valid units to specify with
each available metric, see the `metricName` parameter.
@return [String]

@!attribute [rw] statistics

The statistic for the metric.

The following statistics are available:

* `Minimum` - The lowest value observed during the specified period.
  Use this value to determine low volumes of activity for your
  application.

* `Maximum` - The highest value observed during the specified
  period. Use this value to determine high volumes of activity for
  your application.

* `Sum` - All values submitted for the matching metric added
  together. You can use this statistic to determine the total volume
  of a metric.

* `Average` - The value of Sum / SampleCount during the specified
  period. By comparing this statistic with the Minimum and Maximum
  values, you can determine the full scope of a metric and how close
  the average use is to the Minimum and Maximum values. This
  comparison helps you to know when to increase or decrease your
  resources.

* `SampleCount` - The count, or number, of data points used for the
  statistical calculation.
@return [Array<String>]

@see docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceMetricDataRequest AWS API Documentation

Constants

SENSITIVE