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

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::GetInstanceMetricDataRequest

Includes:

Structure

Defined in:

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
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #end_time ⇒ Time

  The end time of the time period.

• #instance_name ⇒ String

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

• #metric_name ⇒ String

  The metric name to get data about.

• #period ⇒ Integer

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

• #start_time ⇒ Time

  The start time of the time period.

• #statistics ⇒ Array<String>

  The instance statistics.

• #unit ⇒ String

  The unit.

Instance Attribute Details

#end_time ⇒ Time

The end time of the time period.

Returns:

• (Time)

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

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

#instance_name ⇒ String

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

Returns:

• (String)

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

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

#metric_name ⇒ String

The metric name to get data about.

Returns:

• (String)

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

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

#period ⇒ Integer

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

Returns:

• (Integer)

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

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

#start_time ⇒ Time

The start time of the time period.

Returns:

• (Time)

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

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

#statistics ⇒ Array<String>

The instance statistics.

Returns:

• (Array<String>)

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

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

#unit ⇒ String

The unit. The list of valid values is below.

Returns:

• (String)

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

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