class Aws::Lightsail::Types::GetLoadBalancerMetricDataRequest

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

data as a hash:

    {
      load_balancer_name: "ResourceName", # required
      metric_name: "ClientTLSNegotiationErrorCount", # required, accepts ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, RequestCount
      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] load_balancer_name

The name of the load balancer.
@return [String]

@!attribute [rw] metric_name

The metric for which you want to return information.

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

* <b> <code>ClientTLSNegotiationErrorCount</code> </b> - The number
  of TLS connections initiated by the client that did not establish
  a session with the load balancer due to a TLS error generated by
  the load balancer. Possible causes include a mismatch of ciphers
  or protocols.

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

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

* <b> <code>HealthyHostCount</code> </b> - The number of target
  instances that are considered healthy.

  `Statistics`\: The most useful statistic are `Average`, `Minimum`,
  and `Maximum`.

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

* <b> <code>HTTPCode_Instance_2XX_Count</code> </b> - The number of
  HTTP 2XX response codes generated by the target instances. This
  does not include any response codes generated by the load
  balancer.

  `Statistics`\: The most useful statistic is `Sum`. Note that
  `Minimum`, `Maximum`, and `Average` all return `1`.

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

* <b> <code>HTTPCode_Instance_3XX_Count</code> </b> - The number of
  HTTP 3XX response codes generated by the target instances. This
  does not include any response codes generated by the load
  balancer.

  `Statistics`\: The most useful statistic is `Sum`. Note that
  `Minimum`, `Maximum`, and `Average` all return `1`.

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

* <b> <code>HTTPCode_Instance_4XX_Count</code> </b> - The number of
  HTTP 4XX response codes generated by the target instances. This
  does not include any response codes generated by the load
  balancer.

  `Statistics`\: The most useful statistic is `Sum`. Note that
  `Minimum`, `Maximum`, and `Average` all return `1`.

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

* <b> <code>HTTPCode_Instance_5XX_Count</code> </b> - The number of
  HTTP 5XX response codes generated by the target instances. This
  does not include any response codes generated by the load
  balancer.

  `Statistics`\: The most useful statistic is `Sum`. Note that
  `Minimum`, `Maximum`, and `Average` all return `1`.

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

* <b> <code>HTTPCode_LB_4XX_Count</code> </b> - The number of HTTP
  4XX client error codes that originated from the load balancer.
  Client errors are generated when requests are malformed or
  incomplete. These requests were not received by the target
  instance. This count does not include response codes generated by
  the target instances.

  `Statistics`\: The most useful statistic is `Sum`. Note that
  `Minimum`, `Maximum`, and `Average` all return `1`.

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

* <b> <code>HTTPCode_LB_5XX_Count</code> </b> - The number of HTTP
  5XX server error codes that originated from the load balancer.
  This does not include any response codes generated by the target
  instance. This metric is reported if there are no healthy
  instances attached to the load balancer, or if the request rate
  exceeds the capacity of the instances (spillover) or the load
  balancer.

  `Statistics`\: The most useful statistic is `Sum`. Note that
  `Minimum`, `Maximum`, and `Average` all return `1`.

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

* <b> <code>InstanceResponseTime</code> </b> - The time elapsed, in
  seconds, after the request leaves the load balancer until a
  response from the target instance is received.

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

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

* <b> <code>RejectedConnectionCount</code> </b> - The number of
  connections that were rejected because the load balancer had
  reached its maximum number of connections.

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

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

* <b> <code>RequestCount</code> </b> - The number of requests
  processed over IPv4. This count includes only the requests with a
  response generated by a target instance of the load balancer.

  `Statistics`\: The most useful statistic is `Sum`. Note that
  `Minimum`, `Maximum`, and `Average` all return `1`.

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

* <b> <code>UnhealthyHostCount</code> </b> - The number of target
  instances that are considered unhealthy.

  `Statistics`\: The most useful statistic are `Average`, `Minimum`,
  and `Maximum`.

  `Unit`\: The published unit is `Count`.
@return [String]

@!attribute [rw] period

The granularity, in seconds, of the returned data points.
@return [Integer]

@!attribute [rw] start_time

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

@!attribute [rw] end_time

The end time of the 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 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/GetLoadBalancerMetricDataRequest AWS API Documentation

Constants

SENSITIVE