class Aws::Lightsail::Types::GetDistributionMetricDataRequest

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

data as a hash:

    {
      distribution_name: "ResourceName", # required
      metric_name: "Requests", # required, accepts Requests, BytesDownloaded, BytesUploaded, TotalErrorRate, Http4xxErrorRate, Http5xxErrorRate
      start_time: Time.now, # required
      end_time: Time.now, # required
      period: 1, # 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] distribution_name

The name of the distribution for which to get metric data.

Use the `GetDistributions` action to get a list of distribution
names that you can specify.
@return [String]

@!attribute [rw] metric_name

The metric for which you want to return information.

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

* <b> <code>Requests</code> </b> - The total number of viewer
  requests received by your Lightsail distribution, for all HTTP
  methods, and for both HTTP and HTTPS requests.

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

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

* <b> <code>BytesDownloaded</code> </b> - The number of bytes
  downloaded by viewers for GET, HEAD, and OPTIONS requests.

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

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

* <b> <code>BytesUploaded </code> </b> - The number of bytes
  uploaded to your origin by your Lightsail distribution, using POST
  and PUT requests.

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

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

* <b> <code>TotalErrorRate</code> </b> - The percentage of all
  viewer requests for which the response's HTTP status code was 4xx
  or 5xx.

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

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

* <b> <code>4xxErrorRate</code> </b> - The percentage of all viewer
  requests for which the response's HTTP status cod was 4xx. In
  these cases, the client or client viewer may have made an error.
  For example, a status code of 404 (Not Found) means that the
  client requested an object that could not be found.

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

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

* <b> <code>5xxErrorRate</code> </b> - The percentage of all viewer
  requests for which the response's HTTP status code was 5xx. In
  these cases, the origin server did not satisfy the requests. For
  example, a status code of 503 (Service Unavailable) means that the
  origin server is currently unavailable.

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

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

@!attribute [rw] start_time

The start of the time interval for which to get metric data.

Constraints:

* Specified in Coordinated Universal Time (UTC).

* Specified in the Unix time format.

  For example, if you wish to use a start time of October 1, 2018,
  at 8 PM UTC, specify `1538424000` as the start time.

You can convert a human-friendly time to Unix time format using a
converter like [Epoch converter][1].

[1]: https://www.epochconverter.com/
@return [Time]

@!attribute [rw] end_time

The end of the time interval for which to get metric data.

Constraints:

* Specified in Coordinated Universal Time (UTC).

* Specified in the Unix time format.

  For example, if you wish to use an end time of October 1, 2018, at
  9 PM UTC, specify `1538427600` as the end time.

You can convert a human-friendly time to Unix time format using a
converter like [Epoch converter][1].

[1]: https://www.epochconverter.com/
@return [Time]

@!attribute [rw] period

The granularity, in seconds, for the metric data points that will be
returned.
@return [Integer]

@!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/GetDistributionMetricDataRequest AWS API Documentation

Constants

SENSITIVE