Class: Aws::Lightsail::Types::GetBucketMetricDataRequest

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::GetBucketMetricDataRequest

Includes:

Structure

Defined in:

lib/aws-sdk-lightsail/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket_name ⇒ String

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

• #end_time ⇒ Time

  The timestamp indicating the latest data to be returned.

• #metric_name ⇒ String

  The metric for which you want to return information.

• #period ⇒ Integer

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

• #start_time ⇒ Time

  The timestamp indicating the earliest data to be returned.

• #statistics ⇒ Array<String>

  The statistic for the metric.

• #unit ⇒ String

  The unit for the metric data request.

Instance Attribute Details

#bucket_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 6698

class GetBucketMetricDataRequest < Struct.new(
  :bucket_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :statistics,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The timestamp indicating the latest data to be returned.

Returns:

• (Time)

# File 'lib/aws-sdk-lightsail/types.rb', line 6698

class GetBucketMetricDataRequest < Struct.new(
  :bucket_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :statistics,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#metric_name ⇒ String

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>

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

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 6698

class GetBucketMetricDataRequest < Struct.new(
  :bucket_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :statistics,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#period ⇒ Integer

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>

Returns:

• (Integer)

# File 'lib/aws-sdk-lightsail/types.rb', line 6698

class GetBucketMetricDataRequest < Struct.new(
  :bucket_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :statistics,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The timestamp indicating the earliest data to be returned.

Returns:

• (Time)

# File 'lib/aws-sdk-lightsail/types.rb', line 6698

class GetBucketMetricDataRequest < Struct.new(
  :bucket_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :statistics,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#statistics ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-lightsail/types.rb', line 6698

class GetBucketMetricDataRequest < Struct.new(
  :bucket_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :statistics,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#unit ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 6698

class GetBucketMetricDataRequest < Struct.new(
  :bucket_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :statistics,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end