class Aws::Lightsail::Types::GetBucketMetricDataRequest
@note When making an API call, you may pass GetBucketMetricDataRequest
data as a hash: { bucket_name: "BucketName", # required metric_name: "BucketSizeBytes", # required, accepts BucketSizeBytes, NumberOfObjects start_time: Time.now, # required end_time: Time.now, # required period: 1, # required statistics: ["Minimum"], # required, accepts Minimum, Maximum, Sum, Average, SampleCount 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 }
@!attribute [rw] bucket_name
The name of the bucket for which to get metric data. @return [String]
@!attribute [rw] metric_name
The metric for which you want to return information. Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. <note markdown="1"> These bucket metrics are reported once per day. </note> * <b> <code>BucketSizeBytes</code> </b> - The amount of data in bytes stored in a bucket. This value is calculated by summing the size of all objects in the bucket (including object versions), including the size of all parts for all incomplete multipart uploads to the bucket. Statistics: The most useful statistic is `Maximum`. Unit: The published unit is `Bytes`. * <b> <code>NumberOfObjects</code> </b> - The total number of objects stored in a bucket. This value is calculated by counting all objects in the bucket (including object versions) and the total number of parts for all incomplete multipart uploads to the bucket. Statistics: The most useful statistic is `Average`. Unit: The published unit is `Count`. @return [String]
@!attribute [rw] start_time
The timestamp indicating the earliest data to be returned. @return [Time]
@!attribute [rw] end_time
The timestamp indicating the latest data to be returned. @return [Time]
@!attribute [rw] period
The granularity, in seconds, of the returned data points. <note markdown="1"> Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which is the number of seconds in a day. </note> @return [Integer]
@!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` - The sum of all values submitted for the matching metric. 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>]
@!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]
@see docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBucketMetricDataRequest AWS API Documentation
Constants
- SENSITIVE