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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

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
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_nameString

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

Returns:

  • (String)


7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7162

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

#end_timeTime

The timestamp indicating the latest data to be returned.

Returns:

  • (Time)


7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7162

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

#metric_nameString

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.

Returns:

  • (String)


7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7162

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

#periodInteger

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.

Returns:

  • (Integer)


7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7162

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

#start_timeTime

The timestamp indicating the earliest data to be returned.

Returns:

  • (Time)


7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7162

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

#statisticsArray<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>)


7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7162

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

#unitString

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)


7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7162

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