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

Class: Aws::CloudWatch::Types::GetMetricStatisticsInput

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

Overview

Note:

When making an API call, you may pass GetMetricStatisticsInput data as a hash:

{
  namespace: "Namespace", # required
  metric_name: "MetricName", # required
  dimensions: [
    {
      name: "DimensionName", # required
      value: "DimensionValue", # required
    },
  ],
  start_time: Time.now, # required
  end_time: Time.now, # required
  period: 1, # required
  statistics: ["SampleCount"], # accepts SampleCount, Average, Sum, Minimum, Maximum
  extended_statistics: ["ExtendedStatistic"],
  unit: "Seconds", # 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
}

Instance Attribute Summary collapse

Instance Attribute Details

#dimensionsArray<Types::Dimension>

The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Returns:



650
651
652
653
654
655
656
657
658
659
660
661
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 650

class GetMetricStatisticsInput < Struct.new(
  :namespace,
  :metric_name,
  :dimensions,
  :start_time,
  :end_time,
  :period,
  :statistics,
  :extended_statistics,
  :unit)
  include Aws::Structure
end

#end_timeTime

The time stamp that determines the last data point to return.

The value specified is exclusive; results include data points up to the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

Returns:

  • (Time)


650
651
652
653
654
655
656
657
658
659
660
661
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 650

class GetMetricStatisticsInput < Struct.new(
  :namespace,
  :metric_name,
  :dimensions,
  :start_time,
  :end_time,
  :period,
  :statistics,
  :extended_statistics,
  :unit)
  include Aws::Structure
end

#extended_statisticsArray<String>

The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.

Returns:

  • (Array<String>)


650
651
652
653
654
655
656
657
658
659
660
661
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 650

class GetMetricStatisticsInput < Struct.new(
  :namespace,
  :metric_name,
  :dimensions,
  :start_time,
  :end_time,
  :period,
  :statistics,
  :extended_statistics,
  :unit)
  include Aws::Structure
end

#metric_nameString

The name of the metric, with or without spaces.

Returns:

  • (String)


650
651
652
653
654
655
656
657
658
659
660
661
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 650

class GetMetricStatisticsInput < Struct.new(
  :namespace,
  :metric_name,
  :dimensions,
  :start_time,
  :end_time,
  :period,
  :statistics,
  :extended_statistics,
  :unit)
  include Aws::Structure
end

#namespaceString

The namespace of the metric, with or without spaces.

Returns:

  • (String)


650
651
652
653
654
655
656
657
658
659
660
661
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 650

class GetMetricStatisticsInput < Struct.new(
  :namespace,
  :metric_name,
  :dimensions,
  :start_time,
  :end_time,
  :period,
  :statistics,
  :extended_statistics,
  :unit)
  include Aws::Structure
end

#periodInteger

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

  • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

  • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

  • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

Returns:

  • (Integer)


650
651
652
653
654
655
656
657
658
659
660
661
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 650

class GetMetricStatisticsInput < Struct.new(
  :namespace,
  :metric_name,
  :dimensions,
  :start_time,
  :end_time,
  :period,
  :statistics,
  :extended_statistics,
  :unit)
  include Aws::Structure
end

#start_timeTime

The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.

The value specified is inclusive; results include data points with the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

CloudWatch rounds the specified time stamp as follows:

  • Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

  • Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

  • Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.

Returns:

  • (Time)


650
651
652
653
654
655
656
657
658
659
660
661
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 650

class GetMetricStatisticsInput < Struct.new(
  :namespace,
  :metric_name,
  :dimensions,
  :start_time,
  :end_time,
  :period,
  :statistics,
  :extended_statistics,
  :unit)
  include Aws::Structure
end

#statisticsArray<String>

The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.

Returns:

  • (Array<String>)


650
651
652
653
654
655
656
657
658
659
660
661
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 650

class GetMetricStatisticsInput < Struct.new(
  :namespace,
  :metric_name,
  :dimensions,
  :start_time,
  :end_time,
  :period,
  :statistics,
  :extended_statistics,
  :unit)
  include Aws::Structure
end

#unitString

The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If the metric only ever reports one unit, specifying a unit has no effect.

Returns:

  • (String)


650
651
652
653
654
655
656
657
658
659
660
661
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 650

class GetMetricStatisticsInput < Struct.new(
  :namespace,
  :metric_name,
  :dimensions,
  :start_time,
  :end_time,
  :period,
  :statistics,
  :extended_statistics,
  :unit)
  include Aws::Structure
end