Class: Aws::IoT::Types::CreateCustomMetricRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::CreateCustomMetricRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

Note:

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

{
  metric_name: "MetricName", # required
  display_name: "CustomMetricDisplayName",
  metric_type: "string-list", # required, accepts string-list, ip-address-list, number-list, number
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  client_request_token: "ClientRequestToken", # required
}

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  Each custom metric must have a unique client request token.

• #display_name ⇒ String

  The friendly name in the console for the custom metric.

• #metric_name ⇒ String

  The name of the custom metric.

• #metric_type ⇒ String

  The type of the custom metric.

• #tags ⇒ Array<Types::Tag>

  Metadata that can be used to manage the custom metric.

Instance Attribute Details

#client_request_token ⇒ String

Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

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

class CreateCustomMetricRequest < Struct.new(
  :metric_name,
  :display_name,
  :metric_type,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.

Returns:

• (String)

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

class CreateCustomMetricRequest < Struct.new(
  :metric_name,
  :display_name,
  :metric_type,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#metric_name ⇒ String

The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with `aws:`. You can't change the name after you define it.

Returns:

• (String)

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

class CreateCustomMetricRequest < Struct.new(
  :metric_name,
  :display_name,
  :metric_type,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#metric_type ⇒ String

The type of the custom metric.

The type `number` only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.

Returns:

• (String)

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

class CreateCustomMetricRequest < Struct.new(
  :metric_name,
  :display_name,
  :metric_type,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Metadata that can be used to manage the custom metric.

Returns:

• (Array<Types::Tag>)

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

class CreateCustomMetricRequest < Struct.new(
  :metric_name,
  :display_name,
  :metric_type,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end