You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Lightsail::Types::GetInstanceMetricDataRequest

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 GetInstanceMetricDataRequest data as a hash:

{
  instance_name: "ResourceName", # required
  metric_name: "CPUUtilization", # required, accepts CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, StatusCheckFailed_System
  period: 1, # required
  start_time: Time.now, # required
  end_time: Time.now, # 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
}

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

The end time of the time period.

Returns:

  • (Time)


2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2131

class GetInstanceMetricDataRequest < Struct.new(
  :instance_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end

#instance_nameString

The name of the instance for which you want to get metrics data.

Returns:

  • (String)


2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2131

class GetInstanceMetricDataRequest < Struct.new(
  :instance_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end

#metric_nameString

The metric name to get data about.

Returns:

  • (String)


2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2131

class GetInstanceMetricDataRequest < Struct.new(
  :instance_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end

#periodInteger

The time period for which you are requesting data.

Returns:

  • (Integer)


2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2131

class GetInstanceMetricDataRequest < Struct.new(
  :instance_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end

#start_timeTime

The start time of the time period.

Returns:

  • (Time)


2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2131

class GetInstanceMetricDataRequest < Struct.new(
  :instance_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end

#statisticsArray<String>

The instance statistics.

Returns:

  • (Array<String>)


2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2131

class GetInstanceMetricDataRequest < Struct.new(
  :instance_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end

#unitString

The unit. The list of valid values is below.

Returns:

  • (String)


2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2131

class GetInstanceMetricDataRequest < Struct.new(
  :instance_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end