Class: Aws::CloudWatch::Types::GetMetricDataInput

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

Overview

Note:

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

{
  metric_data_queries: [ # required
    {
      id: "MetricId", # required
      metric_stat: {
        metric: { # required
          namespace: "Namespace",
          metric_name: "MetricName",
          dimensions: [
            {
              name: "DimensionName", # required
              value: "DimensionValue", # required
            },
          ],
        },
        period: 1, # required
        stat: "Stat", # required
        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
      },
      expression: "MetricExpression",
      label: "MetricLabel",
      return_data: false,
    },
  ],
  start_time: Time.now, # required
  end_time: Time.now, # required
  next_token: "NextToken",
  scan_by: "TimestampDescending", # accepts TimestampDescending, TimestampAscending
  max_datapoints: 1,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ Time

The time stamp indicating the latest data to be returned.

For better performance, specify ‘StartTime` and `EndTime` values that align with the value of the metric’s ‘Period` and sync up with the beginning and end of an hour. For example, if the `Period` of a metric is 5 minutes, specifying 12:05 or 12:30 as `EndTime` can get a faster response from CloudWatch then setting 12:07 or 12:29 as the `EndTime`.

Returns:

  • (Time) 


602
603
604
605
606
607
608
609
610
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 602

class GetMetricDataInput < Struct.new(
  :metric_data_queries,
  :start_time,
  :end_time,
  :next_token,
  :scan_by,
  :max_datapoints)
  include Aws::Structure
end

#max_datapoints ⇒ Integer

The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.

Returns:

  • (Integer) 


602
603
604
605
606
607
608
609
610
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 602

class GetMetricDataInput < Struct.new(
  :metric_data_queries,
  :start_time,
  :end_time,
  :next_token,
  :scan_by,
  :max_datapoints)
  include Aws::Structure
end

#metric_data_queries ⇒ Array<Types::MetricDataQuery>

The metric queries to be returned. A single ‘GetMetricData` call can include as many as 100 `MetricDataQuery` structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

Returns:



602
603
604
605
606
607
608
609
610
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 602

class GetMetricDataInput < Struct.new(
  :metric_data_queries,
  :start_time,
  :end_time,
  :next_token,
  :scan_by,
  :max_datapoints)
  include Aws::Structure
end

#next_token ⇒ String

Include this value, if it was returned by the previous call, to get the next set of data points.

Returns:

  • (String) 


602
603
604
605
606
607
608
609
610
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 602

class GetMetricDataInput < Struct.new(
  :metric_data_queries,
  :start_time,
  :end_time,
  :next_token,
  :scan_by,
  :max_datapoints)
  include Aws::Structure
end

#scan_by ⇒ String

The order in which data points should be returned. ‘TimestampDescending` returns the newest data first and paginates when the `MaxDatapoints` limit is reached. `TimestampAscending` returns the oldest data first and paginates when the `MaxDatapoints` limit is reached.

Returns:

  • (String) 


602
603
604
605
606
607
608
609
610
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 602

class GetMetricDataInput < Struct.new(
  :metric_data_queries,
  :start_time,
  :end_time,
  :next_token,
  :scan_by,
  :max_datapoints)
  include Aws::Structure
end

#start_time ⇒ Time

The time stamp indicating the earliest data to be returned.

For better performance, specify ‘StartTime` and `EndTime` values that align with the value of the metric’s ‘Period` and sync up with the beginning and end of an hour. For example, if the `Period` of a metric is 5 minutes, specifying 12:05 or 12:30 as `StartTime` can get a faster response from CloudWatch then setting 12:07 or 12:29 as the `StartTime`.

Returns:

  • (Time) 


602
603
604
605
606
607
608
609
610
 
# File 'lib/aws-sdk-cloudwatch/types.rb', line 602

class GetMetricDataInput < Struct.new(
  :metric_data_queries,
  :start_time,
  :end_time,
  :next_token,
  :scan_by,
  :max_datapoints)
  include Aws::Structure
end