Class: Aws::IoT::Types::UpdateFleetMetricRequest

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

Overview

Note:

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

{
  metric_name: "FleetMetricName", # required
  query_string: "QueryString",
  aggregation_type: {
    name: "Statistics", # required, accepts Statistics, Percentiles, Cardinality
    values: ["AggregationTypeValue"],
  },
  period: 1,
  aggregation_field: "AggregationField",
  description: "FleetMetricDescription",
  query_version: "QueryVersion",
  index_name: "IndexName", # 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
  expected_version: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aggregation_fieldString

The field to aggregate.

Returns:

  • (String)


19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19189

class UpdateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

#aggregation_typeTypes::AggregationType

The type of the aggregation query.



19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19189

class UpdateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the fleet metric.

Returns:

  • (String)


19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19189

class UpdateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

#expected_versionInteger

The expected version of the fleet metric record in the registry.

Returns:

  • (Integer)


19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19189

class UpdateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

#index_nameString

The name of the index to search.

Returns:

  • (String)


19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19189

class UpdateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

#metric_nameString

The name of the fleet metric to update.

Returns:

  • (String)


19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19189

class UpdateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

#periodInteger

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

Returns:

  • (Integer)


19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19189

class UpdateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

#query_stringString

The search query string.

Returns:

  • (String)


19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19189

class UpdateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

#query_versionString

The version of the query.

Returns:

  • (String)


19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19189

class UpdateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

#unitString

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

Returns:

  • (String)


19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19189

class UpdateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end