AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::CloudWatch::Types::MetricDataResult

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

Overview

A GetMetricData call returns an array of MetricDataResult structures. Each of these structures includes the data points for that metric, along with the timestamps of those data points and other identifying information.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#idString

The short name you specified to represent this metric.

Returns:

  • (String)


2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2748

class MetricDataResult < Struct.new(
  :id,
  :label,
  :timestamps,
  :values,
  :status_code,
  :messages)
  SENSITIVE = []
  include Aws::Structure
end

#labelString

The human-readable label associated with the data.

Returns:

  • (String)


2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2748

class MetricDataResult < Struct.new(
  :id,
  :label,
  :timestamps,
  :values,
  :status_code,
  :messages)
  SENSITIVE = []
  include Aws::Structure
end

#messagesArray<Types::MessageData>

A list of messages with additional information about the data returned.

Returns:



2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2748

class MetricDataResult < Struct.new(
  :id,
  :label,
  :timestamps,
  :values,
  :status_code,
  :messages)
  SENSITIVE = []
  include Aws::Structure
end

#status_codeString

The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.

Returns:

  • (String)


2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2748

class MetricDataResult < Struct.new(
  :id,
  :label,
  :timestamps,
  :values,
  :status_code,
  :messages)
  SENSITIVE = []
  include Aws::Structure
end

#timestampsArray<Time>

The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].

Returns:

  • (Array<Time>)


2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2748

class MetricDataResult < Struct.new(
  :id,
  :label,
  :timestamps,
  :values,
  :status_code,
  :messages)
  SENSITIVE = []
  include Aws::Structure
end

#valuesArray<Float>

The data points for the metric corresponding to Timestamps. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].

Returns:

  • (Array<Float>)


2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 2748

class MetricDataResult < Struct.new(
  :id,
  :label,
  :timestamps,
  :values,
  :status_code,
  :messages)
  SENSITIVE = []
  include Aws::Structure
end