Class: Aws::IoT::Types::DescribeCustomMetricResponse

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_dateTime

The creation date of the custom metric in milliseconds since epoch.

Returns:

  • (Time)


5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5291

class DescribeCustomMetricResponse < Struct.new(
  :metric_name,
  :metric_arn,
  :metric_type,
  :display_name,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#display_nameString

Field represents a friendly name in the console for the custom metric; doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.

Returns:

  • (String)


5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5291

class DescribeCustomMetricResponse < Struct.new(
  :metric_name,
  :metric_arn,
  :metric_type,
  :display_name,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_dateTime

The time the custom metric was last modified in milliseconds since epoch.

Returns:

  • (Time)


5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5291

class DescribeCustomMetricResponse < Struct.new(
  :metric_name,
  :metric_arn,
  :metric_type,
  :display_name,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#metric_arnString

The Amazon Resource Number (ARN) of the custom metric.

Returns:

  • (String)


5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5291

class DescribeCustomMetricResponse < Struct.new(
  :metric_name,
  :metric_arn,
  :metric_type,
  :display_name,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#metric_nameString

The name of the custom metric.

Returns:

  • (String)


5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5291

class DescribeCustomMetricResponse < Struct.new(
  :metric_name,
  :metric_arn,
  :metric_type,
  :display_name,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end

#metric_typeString

The type of the custom metric.

The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.

Returns:

  • (String)


5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5291

class DescribeCustomMetricResponse < Struct.new(
  :metric_name,
  :metric_arn,
  :metric_type,
  :display_name,
  :creation_date,
  :last_modified_date)
  SENSITIVE = []
  include Aws::Structure
end