Class: Aws::IoTWireless::Types::SummaryMetricQueryResult

Inherits:

Struct

• Object
• Struct
• Aws::IoTWireless::Types::SummaryMetricQueryResult

Defined in:

gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb

Overview

The result of the summary metrics aggregation operation.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #aggregation_period ⇒ String

  The aggregation period of the metric.

• #dimensions ⇒ Array<Types::Dimension>

  The dimensions of the metric.

• #end_timestamp ⇒ Time

  The end timestamp for the summary metric query.

• #error ⇒ String

  The error message for the summary metric query result.

• #metric_name ⇒ String

  The name of the summary metric query result.

• #query_id ⇒ String

  The ID of the summary metric results query operation.

• #query_status ⇒ String

  The status of the summary metric query result.

• #start_timestamp ⇒ Time

  The start timestamp for the summary metric query.

• #timestamps ⇒ Array<Time>

  The timestamp of each aggregation result.

• #unit ⇒ String

  The units of measurement to be used for interpreting the aggregation result.

• #values ⇒ Array<Types::MetricQueryValue>

  The list of aggregated summary metric query results.

Instance Attribute Details

#aggregation_period ⇒ String

The aggregation period of the metric.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 5972

class SummaryMetricQueryResult < Struct.new(
  :query_id,
  :query_status,
  :error,
  :metric_name,
  :dimensions,
  :aggregation_period,
  :start_timestamp,
  :end_timestamp,
  :timestamps,
  :values,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#dimensions ⇒ Array<Types::Dimension>

The dimensions of the metric.

Returns:

• (Array<Types::Dimension>)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 5972

class SummaryMetricQueryResult < Struct.new(
  :query_id,
  :query_status,
  :error,
  :metric_name,
  :dimensions,
  :aggregation_period,
  :start_timestamp,
  :end_timestamp,
  :timestamps,
  :values,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#end_timestamp ⇒ Time

The end timestamp for the summary metric query.

Returns:

• (Time)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 5972

class SummaryMetricQueryResult < Struct.new(
  :query_id,
  :query_status,
  :error,
  :metric_name,
  :dimensions,
  :aggregation_period,
  :start_timestamp,
  :end_timestamp,
  :timestamps,
  :values,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#error ⇒ String

The error message for the summary metric query result.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 5972

class SummaryMetricQueryResult < Struct.new(
  :query_id,
  :query_status,
  :error,
  :metric_name,
  :dimensions,
  :aggregation_period,
  :start_timestamp,
  :end_timestamp,
  :timestamps,
  :values,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#metric_name ⇒ String

The name of the summary metric query result.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 5972

class SummaryMetricQueryResult < Struct.new(
  :query_id,
  :query_status,
  :error,
  :metric_name,
  :dimensions,
  :aggregation_period,
  :start_timestamp,
  :end_timestamp,
  :timestamps,
  :values,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#query_id ⇒ String

The ID of the summary metric results query operation.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 5972

class SummaryMetricQueryResult < Struct.new(
  :query_id,
  :query_status,
  :error,
  :metric_name,
  :dimensions,
  :aggregation_period,
  :start_timestamp,
  :end_timestamp,
  :timestamps,
  :values,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#query_status ⇒ String

The status of the summary metric query result.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 5972

class SummaryMetricQueryResult < Struct.new(
  :query_id,
  :query_status,
  :error,
  :metric_name,
  :dimensions,
  :aggregation_period,
  :start_timestamp,
  :end_timestamp,
  :timestamps,
  :values,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#start_timestamp ⇒ Time

The start timestamp for the summary metric query.

Returns:

• (Time)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 5972

class SummaryMetricQueryResult < Struct.new(
  :query_id,
  :query_status,
  :error,
  :metric_name,
  :dimensions,
  :aggregation_period,
  :start_timestamp,
  :end_timestamp,
  :timestamps,
  :values,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#timestamps ⇒ Array<Time>

The timestamp of each aggregation result.

Returns:

• (Array<Time>)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 5972

class SummaryMetricQueryResult < Struct.new(
  :query_id,
  :query_status,
  :error,
  :metric_name,
  :dimensions,
  :aggregation_period,
  :start_timestamp,
  :end_timestamp,
  :timestamps,
  :values,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#unit ⇒ String

The units of measurement to be used for interpreting the aggregation result.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 5972

class SummaryMetricQueryResult < Struct.new(
  :query_id,
  :query_status,
  :error,
  :metric_name,
  :dimensions,
  :aggregation_period,
  :start_timestamp,
  :end_timestamp,
  :timestamps,
  :values,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#values ⇒ Array<Types::MetricQueryValue>

The list of aggregated summary metric query results.

Returns:

• (Array<Types::MetricQueryValue>)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 5972

class SummaryMetricQueryResult < Struct.new(
  :query_id,
  :query_status,
  :error,
  :metric_name,
  :dimensions,
  :aggregation_period,
  :start_timestamp,
  :end_timestamp,
  :timestamps,
  :values,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end