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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetInstanceMetricDataRequest as input to an Aws::Client method, you can use a vanilla 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)

    The end time of the time period.

#instance_nameString

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

Returns:

  • (String)

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

#metric_nameString

The metric name to get data about.

Possible values:

  • CPUUtilization
  • NetworkIn
  • NetworkOut
  • StatusCheckFailed
  • StatusCheckFailed_Instance
  • StatusCheckFailed_System

Returns:

  • (String)

    The metric name to get data about.

#periodInteger

The time period for which you are requesting data.

Returns:

  • (Integer)

    The time period for which you are requesting data.

#start_timeTime

The start time of the time period.

Returns:

  • (Time)

    The start time of the time period.

#statisticsArray<String>

The instance statistics.

Returns:

  • (Array<String>)

    The instance statistics.

#unitString

The unit. The list of valid values is below.

Possible values:

  • 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

Returns:

  • (String)

    The unit.