Class: Aws::IoT::Types::DescribeFleetMetricResponse

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::DescribeFleetMetricResponse

Defined in:

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #aggregation_field ⇒ String

  The field to aggregate.

• #aggregation_type ⇒ Types::AggregationType

  The type of the aggregation query.

• #creation_date ⇒ Time

  The date when the fleet metric is created.

• #description ⇒ String

  The fleet metric description.

• #index_name ⇒ String

  The name of the index to search.

• #last_modified_date ⇒ Time

  The date when the fleet metric is last modified.

• #metric_arn ⇒ String

  The ARN of the fleet metric to describe.

• #metric_name ⇒ String

  The name of the fleet metric to describe.

• #period ⇒ Integer

  The time in seconds between fleet metric emissions.

• #query_string ⇒ String

  The search query string.

• #query_version ⇒ String

  The query version.

• #unit ⇒ String

  Used to support unit transformation such as milliseconds to seconds.

• #version ⇒ Integer

  The version of the fleet metric.

Instance Attribute Details

#aggregation_field ⇒ String

The field to aggregate.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6224

class DescribeFleetMetricResponse < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :creation_date,
  :last_modified_date,
  :unit,
  :version,
  :metric_arn)
  SENSITIVE = []
  include Aws::Structure
end

#aggregation_type ⇒ Types::AggregationType

The type of the aggregation query.

Returns:

• (Types::AggregationType)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6224

class DescribeFleetMetricResponse < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :creation_date,
  :last_modified_date,
  :unit,
  :version,
  :metric_arn)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ Time

The date when the fleet metric is created.

Returns:

• (Time)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6224

class DescribeFleetMetricResponse < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :creation_date,
  :last_modified_date,
  :unit,
  :version,
  :metric_arn)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The fleet metric description.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6224

class DescribeFleetMetricResponse < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :creation_date,
  :last_modified_date,
  :unit,
  :version,
  :metric_arn)
  SENSITIVE = []
  include Aws::Structure
end

#index_name ⇒ String

The name of the index to search.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6224

class DescribeFleetMetricResponse < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :creation_date,
  :last_modified_date,
  :unit,
  :version,
  :metric_arn)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ Time

The date when the fleet metric is last modified.

Returns:

• (Time)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6224

class DescribeFleetMetricResponse < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :creation_date,
  :last_modified_date,
  :unit,
  :version,
  :metric_arn)
  SENSITIVE = []
  include Aws::Structure
end

#metric_arn ⇒ String

The ARN of the fleet metric to describe.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6224

class DescribeFleetMetricResponse < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :creation_date,
  :last_modified_date,
  :unit,
  :version,
  :metric_arn)
  SENSITIVE = []
  include Aws::Structure
end

#metric_name ⇒ String

The name of the fleet metric to describe.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6224

class DescribeFleetMetricResponse < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :creation_date,
  :last_modified_date,
  :unit,
  :version,
  :metric_arn)
  SENSITIVE = []
  include Aws::Structure
end

#period ⇒ Integer

The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

Returns:

• (Integer)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6224

class DescribeFleetMetricResponse < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :creation_date,
  :last_modified_date,
  :unit,
  :version,
  :metric_arn)
  SENSITIVE = []
  include Aws::Structure
end

#query_string ⇒ String

The search query string.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6224

class DescribeFleetMetricResponse < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :creation_date,
  :last_modified_date,
  :unit,
  :version,
  :metric_arn)
  SENSITIVE = []
  include Aws::Structure
end

#query_version ⇒ String

The query version.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6224

class DescribeFleetMetricResponse < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :creation_date,
  :last_modified_date,
  :unit,
  :version,
  :metric_arn)
  SENSITIVE = []
  include Aws::Structure
end

#unit ⇒ String

Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6224

class DescribeFleetMetricResponse < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :creation_date,
  :last_modified_date,
  :unit,
  :version,
  :metric_arn)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ Integer

The version of the fleet metric.

Returns:

• (Integer)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6224

class DescribeFleetMetricResponse < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :creation_date,
  :last_modified_date,
  :unit,
  :version,
  :metric_arn)
  SENSITIVE = []
  include Aws::Structure
end