Class: Aws::IoT::Types::CreateFleetMetricRequest

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 CreateFleetMetricRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aggregation_fieldString

The field to aggregate.

Returns:

  • (String)


3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3433

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

#aggregation_typeTypes::AggregationType

The type of the aggregation query.



3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3433

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

#descriptionString

The fleet metric description.

Returns:

  • (String)


3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3433

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

#index_nameString

The name of the index to search.

Returns:

  • (String)


3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3433

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

#metric_nameString

The name of the fleet metric to create.

Returns:

  • (String)


3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3433

class CreateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :tags)
  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)


3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3433

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

#query_stringString

The search query string.

Returns:

  • (String)


3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3433

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

#query_versionString

The query version.

Returns:

  • (String)


3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3433

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

#tagsArray<Types::Tag>

Metadata, which can be used to manage the fleet metric.

Returns:



3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3433

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

#unitString

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

Returns:

  • (String)


3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3433

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