Struct aws_sdk_lightsail::input::GetBucketMetricDataInput

#[non_exhaustive]
pub struct GetBucketMetricDataInput {
    pub bucket_name: Option<String>,
    pub metric_name: Option<BucketMetricName>,
    pub start_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub period: i32,
    pub statistics: Option<Vec<MetricStatistic>>,
    pub unit: Option<MetricUnit>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bucket_name: Option<String>

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

metric_name: Option<BucketMetricName>

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.

These bucket metrics are reported once per day.

• BucketSizeBytes - 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.

• NumberOfObjects - 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.

start_time: Option<DateTime>

The timestamp indicating the earliest data to be returned.

end_time: Option<DateTime>

The timestamp indicating the latest data to be returned.

period: i32

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

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.

statistics: Option<Vec<MetricStatistic>>

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.

unit: Option<MetricUnit>

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.

Implementations

impl GetBucketMetricDataInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<GetBucketMetricData, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<GetBucketMetricData>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture GetBucketMetricDataInput

impl GetBucketMetricDataInput

pub fn bucket_name(&self) -> Option<&str>

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

pub fn metric_name(&self) -> Option<&BucketMetricName>

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.

These bucket metrics are reported once per day.

• BucketSizeBytes - 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.

• NumberOfObjects - 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.

pub fn start_time(&self) -> Option<&DateTime>

The timestamp indicating the earliest data to be returned.

pub fn end_time(&self) -> Option<&DateTime>

The timestamp indicating the latest data to be returned.

pub fn period(&self) -> i32

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

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.

pub fn statistics(&self) -> Option<&[MetricStatistic]>

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.

pub fn unit(&self) -> Option<&MetricUnit>

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.

Trait Implementations

impl Clone for GetBucketMetricDataInput

fn clone(&self) -> GetBucketMetricDataInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetBucketMetricDataInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<GetBucketMetricDataInput> for GetBucketMetricDataInput

fn eq(&self, other: &GetBucketMetricDataInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GetBucketMetricDataInput) -> bool

This method tests for !=.

impl StructuralPartialEq for GetBucketMetricDataInput